odbc_tables

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

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

Описание

odbc_tables(
    resource$odbc,
    ?string$catalog = null,
    ?string$schema = null,
    ?string$table = null,
    ?string$types = null
): resource|false

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

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

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

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

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.0.0schema, 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() - Получает список процедур, хранящихся в определённом источнике данных
To Top