Получает информацию о параметрах процедур

# odbc_procedurecolumns

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

odbc_procedurecolumns — Получает информацию о параметрах процедур

### Описание

function odbc_procedurecolumns(
Odbc\Connection `$odbc`,
?string `$catalog` = `null`,
?string `$schema` = `null`,
?string `$procedure` = `null`,
?string `$column` = `null`
): Odbc\Result|false

Функция получает информацию о параметрах процедур.

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

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

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

`schema`

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

`procedure`

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

`column`

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

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

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

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

- `PROCEDURE_CAT`
- `PROCEDURE_SCHEM`
- `PROCEDURE_NAME`
- `COLUMN_NAME`
- `COLUMN_TYPE`
- `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`

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

Набор результатов упорядочивается по столбцам `PROCEDURE_CAT`, `PROCEDURE_SCHEM`, `PROCEDURE_NAME` и `COLUMN_TYPE`.

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

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

### Примеры

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

    <?php

    $conn = odbc_connect($dsn, $user, $pass);
    $columns = odbc_procedurecolumns($conn, 'TutorialDB', 'dbo', 'GetEmployeeSalesYTD;1', '%');

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

    ?>

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

    Array
    (
        [PROCEDURE_CAT] => TutorialDB
        [PROCEDURE_SCHEM] => dbo
        [PROCEDURE_NAME] => GetEmployeeSalesYTD;1
        [COLUMN_NAME] => @SalesPerson
        [COLUMN_TYPE] => 1
        [DATA_TYPE] => -9
        [TYPE_NAME] => nvarchar
        [COLUMN_SIZE] => 50
        [BUFFER_LENGTH] => 100
        [DECIMAL_DIGITS] =>
        [NUM_PREC_RADIX] =>
        [NULLABLE] => 1
        [REMARKS] =>
        [COLUMN_DEF] =>
        [SQL_DATA_TYPE] => -9
        [SQL_DATETIME_SUB] =>
        [CHAR_OCTET_LENGTH] => 100
        [ORDINAL_POSITION] => 1
        [IS_NULLABLE] => YES
    )

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

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

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open