Home/ Manual/ uodbc / functions/ odbc_procedures

odbc_procedures

PHP function Edit on GitHub ✎

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

Get the list of procedures stored in a specific data source

Description

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

Lists all procedures in the requested range.

Parameters

odbc: Id
catalog: Catalog
schema: Schema Search
procedure: The name. Search

Return Values

Object-return containing the informationFalseforfailure.

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

Driver-specific

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

Changelog

Version	Description
8.0.0	Prior to this version, the function could only be called with either one or four arguments.

Examples

List stored Procedures of a Database

php

<?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
}
?>

The above example will output something similar to:

output

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
)