db2_foreign_keys — Возвращает набор результатов, в котором перечислены внешние ключи таблицы

Назначение db2_foreign_keys

db2_foreign_keys: Возвращает набор результатов, в котором перечислены внешние ключи таблицы. Справочная сущность относится к разделу «ibm_db2». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

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

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

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

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

Сигнатура db2_foreign_keys

Структурная запись: resource db2_foreign_keys(resource $connection, string|null $qualifier, string|null $schema, string $table_name). В ней 4 параметра: обязательные $connection, $qualifier, $schema, $table_name. Результат объявлен как resource; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры db2_foreign_keys

Порядок и роли аргументов по сигнатуре: 1. $connection — resource, обязателен; 2. $qualifier — string|null, обязателен; 3. $schema — string|null, обязателен; 4. $table_name — string, обязателен.

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

1) resource $connection — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) string|null $qualifier — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) string|null $schema — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 4) string $table_name — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат db2_foreign_keys

db2_foreign_keys объявляет результат типа resource. Результат db2_foreign_keys имеет объявленный тип resource. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

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

Убедитесь, что раздел «ibm_db2» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором resource $connection, string|null $qualifier, string|null $schema, string $table_name. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

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

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

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

Сначала запишите точную сигнатуру resource db2_foreign_keys(resource $connection, string|null $qualifier, string|null $schema, string $table_name) и фактические типы переданных значений. Затем подтвердите загрузку расширения «ibm_db2» в той же среде, где выполняется db2_foreign_keys. Если результат неожиданен, сравните его тип с resource и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для db2_foreign_keys базовый ориентир: возвращает набор результатов, в котором перечислены внешние ключи таблицы; обязательные $connection, $qualifier, $schema, $table_name; результат resource. Сопоставление с опубликованными соседями: db2_column_privileges: возвращает результирующий набор, перечисляющий столбцы и связанные с ним привилегии для таблицы; вход — обязательные $connection; необязательные $qualifier, $schema, $table_name, $column_name; результат — resource. db2_columns: возвращает результирующий набор, перечисляющий столбцы и связанные с ними метаданные для таблицы; вход — обязательные $connection; необязательные $qualifier, $schema, $table_name, $column_name; результат — resource. db2_primary_keys: возвращает набор результатов, содержащий первичные ключи таблицы; вход — обязательные $connection, $qualifier, $schema, $table_name; результат — resource. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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