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

# odbc_procedures

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

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

### Описание

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

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

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

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

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

`schema`

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

`procedure`

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

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

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

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

- `PROCEDURE_CAT`
- `PROCEDURE_SCHEM`
- `PROCEDURE_NAME`
- `NUM_INPUT_PARAMS`
- `NUM_OUTPUT_PARAMS`
- `NUM_RESULT_SETS`
- `REMARKS`
- `PROCEDURE_TYPE`

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

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

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

Версия | Описание
--- | ---
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);
    $procedures = odbc_procedures($conn, $catalog, $schema, '%');

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

    ?>

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

    Array
    (
        [PROCEDURE_CAT] => TutorialDB
        [PROCEDURE_SCHEM] => dbo
        [PROCEDURE_NAME] => GetEmployeeSalesYTD;1
        [NUM_INPUT_PARAMS] => -1
        [NUM_OUTPUT_PARAMS] => -1
        [NUM_RESULT_SETS] => -1
        [REMARKS] =>
        [PROCEDURE_TYPE] => 2
    )

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

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

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