odbc_columns

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

odbc_columns — Перечисляет названия столбцов в таблицах

Описание

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

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

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

odbc

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

catalog

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

schema

Схема ('owner' на языке ODBC 2). Параметр принимает следующие шаблоны поиска: %, который соответствует нулю или более символам, и _, который соответствует ровно одному символу.

table

Название таблицы. Параметр принимает следующие шаблоны поиска: %, который соответствует нулю или более символам, и _, который соответствует ровно одному символу.

column

Название столбца. Параметр принимает следующие шаблоны поиска: %, который соответствует нулю или более символам, и _, который соответствует ровно одному символу.

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

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

В результирующем наборе содержатся следующие столбцы:

  • TABLE_CAT
  • TABLE_SCHEM
  • TABLE_NAME
  • COLUMN_NAME
  • DATA_TYPE
  • TYPE_NAME
  • COLUMN_SIZE
  • BUFFER_LENGTH
  • DECIMAL_DIGITS
  • NUM_PREC_RADIX
  • NULLABLE
  • REMARKS
  • COLUMN_DEF
  • SQL_DATA_TYPE
  • SQL_DATETIME_SUB
  • CHAR_OCTET_LENGTH
  • ORDINAL_POSITION
  • IS_NULLABLE
Драйвер иногда сообщает о дополнительных столбцах.

Результирующий набор упорядочивается по столбцам TABLE_CAT, TABLE_SCHEM, TABLE_NAME и ORDINAL_POSITION.

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

Версия Описание
8.4.0 Параметр odbc теперь ожидает экземпляр соединения Odbc\Connection; раньше ожидался аргумент с типом resource.
8.0.0 Параметры schema, table и column теперь принимают значение null.

Примеры

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

<?php

$conn = odbc_connect($dsn, $user, $pass);

$columns = odbc_columns($conn, 'TutorialDB', 'dbo', 'test', '%');

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

?>

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

Array
(
    [TABLE_CAT] => TutorialDB
    [TABLE_SCHEM] => dbo
    [TABLE_NAME] => TEST
    [COLUMN_NAME] => id
    [DATA_TYPE] => 4
    [TYPE_NAME] => int
    [COLUMN_SIZE] => 10
    [BUFFER_LENGTH] => 4
    [DECIMAL_DIGITS] => 0
    [NUM_PREC_RADIX] => 10
    [NULLABLE] => 0
    [REMARKS] =>
    [COLUMN_DEF] =>
    [SQL_DATA_TYPE] => 4
    [SQL_DATETIME_SUB] =>
    [CHAR_OCTET_LENGTH] =>
    [ORDINAL_POSITION] => 1
    [IS_NULLABLE] => NO
)

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

  • odbc_columnprivileges() - Перечисляет столбцы таблицы и привилегии, которые связаны со столбцами
  • odbc_procedurecolumns() - Получает информацию о параметрах процедур