pg_cancel_query — Остановка асинхронного запроса.

Назначение pg_cancel_query

pg_cancel_query: Остановка асинхронного запроса.. Справочная сущность относится к разделу «pgsql». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается pg_cancel_query

Это процедурная функция раздела «pgsql». Её отличают имя pg_cancel_query, контракт «обязательные $connection» и объявленный результат bool; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление pg_cancel_query

Смысловое направление pg_cancel_query — «получение данных». В прикладном коде различайте отсутствие данных, пустое значение и технический отказ источника. Контрольный набор для этой операции: проверьте пустой источник, один результат и недоступное окружение. Такой акцент отделяет pg_cancel_query от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура pg_cancel_query

Структурная запись: bool pg_cancel_query(PgSql\Connection $connection). В ней 1 параметр: обязательные $connection. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры pg_cancel_query

Порядок и роли аргументов по сигнатуре: 1. $connection — PgSql\Connection, обязателен. Для pg_cancel_query фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для pg_cancel_query

1) PgSql\Connection $connection — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия.

Результат pg_cancel_query

pg_cancel_query объявляет результат типа bool. pg_cancel_query возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

Проверочный сценарий для pg_cancel_query

Убедитесь, что раздел «pgsql» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором PgSql\Connection $connection. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «хранилище данных» важно явно контролировать соединение, транзакцию и кодировку; негативный сценарий должен проверить пустой результат, отказ соединения и повтор операции.

Интеграция pg_cancel_query в проект

Проверку доступности pg_cancel_query и преобразование входных значений разместите у границы модуля «pgsql». Для профиля «хранилище данных» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция pg_cancel_query не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика pg_cancel_query

Сначала запишите точную сигнатуру bool pg_cancel_query(PgSql\Connection $connection) и фактические типы переданных значений. Затем подтвердите загрузку расширения «pgsql» в той же среде, где выполняется pg_cancel_query. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «хранилище данных» применяйте отдельный негативный тест: проверить пустой результат, отказ соединения и повтор операции. В production-коде важно явно контролировать соединение, транзакцию и кодировку. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать pg_cancel_query

Выбор pg_cancel_query оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «pgsql»; 2) сигнатура содержит 1 аргумент: обязательных 1, необязательных 0; 3) вызывающему коду нужен результат bool и действие «получение данных». Для профиля «хранилище данных» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с pg_connection_busy: у него другое назначение, владелец или набор входных данных.

Сравнение pg_cancel_query с соседними API

Для pg_cancel_query базовый ориентир: остановка асинхронного запроса.; обязательные $connection; результат bool. Сопоставление с опубликованными соседями: pg_connection_busy: проверяет, занято ли соединение в данный момент.; вход — обязательные $connection; результат — bool. pg_put_line: передаёт на postgresql сервер строку с завершающим нулём; вход — обязательные $query; необязательные $connection; результат — bool. pg_connection_reset: сброс подключения (переподключение); вход — обязательные $connection; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

pg_cancel_query сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для pg_cancel_query.

Связанные материалы