トップページ　→関数リファレンス　→データベース関連　→抽象化レイヤー　→ODBC　→ODBC 関数

関数・クラス解説

odbc_procedures

version:PHP 4, PHP 5, PHP 7 (公式)

指定したデータソースに保存されているプロシージャのリストを取得する

公式リファレンス

書式

odbc_procedures ( resource $connection_id ) : resource|false

odbc_procedures ( resource $connection_id , string $catalog , string $schema , string $name ) : resource|false

説明

指定した範囲の全てのプロシージャのリストを取得します。

パラメータ

connection_id: ODBC 接続 ID。詳細はodbc_connect() を参照ください。
catalog: カタログ(ODBC 2 の用語では '修飾子')。
schema: スキーマ (ODBC 2 の用語では '所有者')。このパラメータには以下の検索パターンを使用できます。% はゼロ個以上の文字にマッチし、_ はひとつの文字にマッチします。
name: 名前。このパラメータには以下の検索パターンを使用できます。% はゼロ個以上の文字にマッチし、_ はひとつの文字にマッチします。

返値

情報を含む ODBC 結果 ID を返します。失敗した場合に 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 でソートされます。

サンプル

例1 データベースのプロシージャ一覧を表示する 

$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
)