odbc_primarykeys

(PHP 4, PHP 5, PHP 7, PHP 8)

odbc_primarykeys — Получает первичные ключи таблицы

Описание

odbc_primarykeys(
    Odbc\Connection $odbc,
    ?string $catalog,
    string $schema,
    string $table
): Odbc\Result|false

Функция возвращает объект с результатами, из которых извлекают названия столбцов, из которых составили первичный ключ таблицы.

Список параметров

odbc

Объект ODBC-соединения. Подробнее о коннекторе рассказывает описание функции odbc_connect().

catalog

Каталог ('qualifier' на языке ODBC 2).

schema

Схема ('owner' на языке ODBC 2).

table

Возвращаемые значения

Функция возвращает объект ODBC с результатом или false, если возникла ошибка.

Набор результатов содержит следующие столбцы:

  • TABLE_CAT
  • TABLE_SCHEM
  • TABLE_NAME
  • COLUMN_NAME
  • KEY_SEQ
  • PK_NAME
Драйвер иногда сообщает о дополнительных столбцах.

Набор результатов упорядочивается по столбцам TABLE_CAT, TABLE_SCHEM, TABLE_NAME и KEY_SEQ.

Список изменений

Версия Описание
8.4.0 Параметр odbc теперь ожидает экземпляр соединения Odbc\Connection; раньше ожидался аргумент с типом resource.
8.4.0 Функция теперь возвращает объект с результатом ODBC-запроса Odbc\Result; раньше возвращалось значение с типом resource.

Примеры

Пример #1 Пример получения списка первичных ключей столбца

<?php

$conn = odbc_connect($dsn, $user, $pass);
$primarykeys = odbc_primarykeys($conn, 'TutorialDB', 'dbo', 'TEST');

while (($row = odbc_fetch_array($primarykeys))) {
print_r($row);
break; // Следующие строки опустили для краткости
}

?>

Вывод приведённого примера будет похож на: 

Array
(
    [TABLE_CAT] => TutorialDB
    [TABLE_SCHEM] => dbo
    [TABLE_NAME] => TEST
    [COLUMN_NAME] => id
    [KEY_SEQ] => 1
    [PK_NAME] => PK__TEST__3213E83FE141F843
)

Смотрите также

  • odbc_tables() - Получает список имён таблиц, которые хранятся в источнике данных
  • odbc_foreignkeys() - Извлекает список внешних ключей