Get the list of procedures stored in a specific data source

# odbc_procedures

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

odbc_procedures — Get the list of procedures stored in a specific data source

### 说明

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

Lists all procedures in the requested range.

### 参数

`odbc`
  ODBC 连接对象，详见 odbc_connect()。
`catalog`

  The catalog ('qualifier' in ODBC 2 parlance).

`schema`

  The schema ('owner' in ODBC 2 parlance). 此参数接受下列查询模式： `%` 来匹配零到多个字符， `_` 来匹配单个字符。

`procedure`

  The name. 此参数接受下列查询模式： `%` 来匹配零到多个字符， `_` 来匹配单个字符。

### 返回值

返回 ODBC 结果对象 containing the information 或者在失败时返回 `false`.

The result set has the following columns:

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

Drivers can report additional columns.

The result set is ordered by `PROCEDURE_CAT`, `PROCEDURE_SCHEMA` and `PROCEDURE_NAME`.

### 更新日志

版本 | 说明
--- | ---
8.4.0 | `odbc` 现在需要 Odbc\Connection 实例；之前需要 resource。
8.4.0 | 此函数现在返回 Odbc\Result 实例；之前返回 resource。
8.0.0 | Prior to this version, the function could only be called with either one or four arguments.

### 示例

示例 #1 List stored Procedures of a Database

    <?php
    $conn = odbc_connect($dsn, $user, $pass);
    $procedures = odbc_procedures($conn, $catalog, $schema, '%');
    while (($row = odbc_fetch_array($procedures))) {
        print_r($row);
        break; // further rows omitted for brevity
    }
    ?>

以上示例的输出类似于：

    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() - Retrieve information about parameters to procedures
- odbc_tables() - Get the list of table names stored in a specific data source

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