(PHP 4, PHP 5, PHP 7, PHP 8)
odbc_procedures — Get the list of procedures stored in a specific data source
$odbc
,$catalog
= null
,$schema
= null
,$procedure
= null
Lists all procedures in the requested range.
odbc
The ODBC connection identifier, see odbc_connect() for details.
catalog
The catalog ('qualifier' in ODBC 2 parlance).
schema
The schema ('owner' in ODBC 2 parlance).
This parameter accepts the following search patterns:
%
to match zero or more characters,
and _
to match a single character.
procedure
The name.
This parameter accepts the following search patterns:
%
to match zero or more characters,
and _
to match a single character.
Returns an ODBC
result identifier containing the information or false
on failure.
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
The result set is ordered by PROCEDURE_CAT
,
PROCEDURE_SCHEMA
and PROCEDURE_NAME
.
Version | Description |
---|---|
8.0.0 | Prior to this version, the function could only be called with either one or four arguments. |
Example #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
}
?>
The above example will output something similar to:
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 )