odbc_foreignkeys — Извлекает список внешних ключей

Назначение odbc_foreignkeys

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

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

Это процедурная функция раздела «uodbc». Её отличают имя odbc_foreignkeys, контракт «обязательные $odbc, $pk_catalog, $pk_schema, $pk_table, $fk_catalog, $fk_schema, $fk_table» и объявленный результат Odbc\Result|false; эти три признака нужно сверять вместе при выборе похожего API.

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

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

Сигнатура odbc_foreignkeys

Структурная запись: Odbc\Result|false odbc_foreignkeys(Odbc\Connection $odbc, string|null $pk_catalog, string $pk_schema, string $pk_table, string $fk_catalog, string $fk_schema, string $fk_table). В ней 7 параметров: обязательные $odbc, $pk_catalog, $pk_schema, $pk_table, $fk_catalog, $fk_schema, $fk_table. Результат объявлен как Odbc\Result|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры odbc_foreignkeys

Порядок и роли аргументов по сигнатуре: 1. $odbc — Odbc\Connection, обязателен; 2. $pk_catalog — string|null, обязателен; 3. $pk_schema — string, обязателен; 4. $pk_table — string, обязателен; 5. $fk_catalog — string, обязателен; 6. $fk_schema — string, обязателен; 7. $fk_table — string, обязателен.

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

1) Odbc\Connection $odbc — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) string|null $pk_catalog — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) string $pk_schema — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 4) string $pk_table — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 5) string $fk_catalog — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 6) string $fk_schema — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 7) string $fk_table — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат odbc_foreignkeys

odbc_foreignkeys объявляет результат типа Odbc\Result|false. Контракт odbc_foreignkeys допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

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

Убедитесь, что раздел «uodbc» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором Odbc\Connection $odbc, string|null $pk_catalog, string $pk_schema, string $pk_table, string $fk_catalog, string $fk_schema, string $fk_table. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

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

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

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

Сначала запишите точную сигнатуру Odbc\Result|false odbc_foreignkeys(Odbc\Connection $odbc, string|null $pk_catalog, string $pk_schema, string $pk_table, string $fk_catalog, string $fk_schema, string $fk_table) и фактические типы переданных значений. Затем подтвердите загрузку расширения «uodbc» в той же среде, где выполняется odbc_foreignkeys. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для odbc_foreignkeys предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

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

Выбор odbc_foreignkeys оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «uodbc»; 2) сигнатура содержит 7 аргументов: обязательных 7, необязательных 0; 3) вызывающему коду нужен результат Odbc\Result|false и действие «операция foreignkeys». Для профиля «безопасность» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с odbc_tables: у него другое назначение, владелец или набор входных данных.

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

Для odbc_foreignkeys базовый ориентир: извлекает список внешних ключей; обязательные $odbc, $pk_catalog, $pk_schema, $pk_table, $fk_catalog, $fk_schema, $fk_table; результат Odbc\Result|false. Сопоставление с опубликованными соседями: odbc_tables: получает список имён таблиц, которые хранятся в источнике данных; вход — обязательные $odbc; необязательные $catalog, $schema, $table, $types; результат — Odbc\Result|false. odbc_primarykeys: получает первичные ключи таблицы; вход — обязательные $odbc, $catalog, $schema, $table; результат — Odbc\Result|false. odbc_procedures: получает список процедур, которые хранятся в источнике данных; вход — обязательные $odbc; необязательные $catalog, $schema, $procedure; результат — Odbc\Result|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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