odbc_tables

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

odbc_tables — Получает список имён таблиц, которые хранятся в источнике данных

Описание

odbc_tables(
    Odbc\Connection $odbc,
    ?string $catalog = null,
    ?string $schema = null,
    ?string $table = null,
    ?string $types = null
): Odbc\Result|false

Функция перечисляет таблицы в запрошенном диапазоне.

Для поддержки перечисления квалификаторов, владельцев и типов таблиц доступна следующая специальная семантика для параметром catalog, schema, table и table_type:

Набор результатов будет содержать список допустимых квалификаторов для источника данных (все столбцы, кроме столбца TABLE_QUALIFIER, содержат NULL), если значение аргумента catalog равно символу процента (%), а в аргументах schema и table передали пустые строки.
Набор результатов будет содержать список допустимых владельцев для источника данных (все столбцы, кроме столбца TABLE_OWNER, содержат NULL), если значение аргумента schema равно символу процента (%), а в аргументы catalog и table передали пустые строки.
Набор результатов будет содержать список допустимых типов таблиц для источника данных (все столбцы, кроме столбца TABLE_TYPE, содержат NULL), если значение аргумента table_type равно символу процента (%), а в аргументах catalog, schema и table передали пустые строки.

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

odbc: Объект ODBC-соединения. Подробнее о коннекторе рассказывает описание функции odbc_connect().
catalog: Каталог ('qualifier' на языке ODBC 2).
schema: Схема ('owner' на языке ODBC 2). Параметр принимает следующие шаблоны поиска: %, который соответствует нулю или более символам, и _, который соответствует ровно одному символу.
table: Имя таблицы. Параметр принимает следующие шаблоны поиска: %, который соответствует нулю или более символам, и _, который соответствует ровно одному символу.
types: В параметр передают список значений типов через запятую, если в параметр table_type передаётся не пустая строка; каждое значение разрешается заключать в одинарные кавычки ' или передавать значения без кавычек. Например, 'TABLE','VIEW' или TABLE, VIEW. Функция odbc_tables() не вернёт никаких результатов для типа, если источник данных не поддерживает заданный тип таблицы.

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

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

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

TABLE_CAT
TABLE_SCHEM
TABLE_NAME
TABLE_TYPE
REMARKS

Драйвер иногда сообщает о дополнительных столбцах.

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

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

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

Примеры

Пример #1 Пример вывода списка таблиц в каталоге

<?php

$conn = odbc_connect($dsn, $user, $pass);
$tables = odbc_tables($conn, 'SalesOrders', 'dbo', '%', 'TABLE');

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

?>

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

Array
(
    [TABLE_CAT] => SalesOrders
    [TABLE_SCHEM] => dbo
    [TABLE_NAME] => Orders
    [TABLE_TYPE] => TABLE
    [REMARKS] =>
)

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

odbc_tableprivileges() - Перечисляет таблицы и привилегии, которые связаны с каждой таблицей
odbc_columns() - Перечисляет названия столбцов в таблицах
odbc_specialcolumns() - Извлекает особые столбцы
odbc_statistics() - Получает статистику о таблице
odbc_procedures() - Получает список процедур, которые хранятся в источнике данных