db2_procedure_columns

(PECL ibm_db2 >= 1.0.0)

db2_procedure_columns ストアドプロシージャのパラメータを含む結果セットを返す

説明

db2_procedure_columns(
    resource$connection,
    ?string$qualifier,
    string$schema,
    string$procedure,
    ?string$parameter
): resource

ストアドプロシージャのパラメータを含む結果セットを返します。

パラメータ

connection

IBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。

qualifier

OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。 その他のデータベースの場合には null あるいは空の文字列を渡します。

schema

プロシージャを含むスキーマ。このパラメータでは、ワイルドカードとして _ および % を含む検索パターンを使用可能です。

procedure

プロシージャの名前。このパラメータでは、ワイルドカードとして _ および % を含む検索パターンを使用可能です。

parameter

パラメータの名前。このパラメータでは、ワイルドカードとして _ および % を含む検索パターンを使用可能です。 このパラメータが null の場合、指定したストアドプロシージャの すべてのパラメータが返されます。

戻り値

指定したパラメータに一致するストアドプロシージャのパラメータ情報を含む結果セットの ステートメントリソースを返します。 行の内容は、以下のカラムで構成されています。

カラム名説明
PROCEDURE_CAT プロシージャを含むカタログ。テーブルがカタログを保持していない場合は null
PROCEDURE_SCHEMストアドプロシージャを含むスキーマの名前。
PROCEDURE_NAMEプロシージャの名前。
COLUMN_NAMEパラメータの名前。
COLUMN_TYPE

パラメータの型を表す整数値。

返される値パラメータの型
1 (SQL_PARAM_INPUT)入力 (IN) パラメータ。
2 (SQL_PARAM_INPUT_OUTPUT)入力/出力 (INOUT) パラメータ。
3 (SQL_PARAM_OUTPUT)出力 (OUT) パラメータ。
DATA_TYPE パラメータの SQL データ型を表す整数値。
TYPE_NAMEパラメータのデータ型を表す文字列。
COLUMN_SIZEパラメータのサイズを表す整数値。
BUFFER_LENGTH このパラメータのデータを保存するために必要な最大バイト数。
DECIMAL_DIGITS パラメータの位取り。位取りが適用できない場合は null
NUM_PREC_RADIX10 (正確な数値データ型を表す)、 2 (概数データ型を表す)、 あるいは null (基数が適用できないデータ型を表す) のいずれか。
NULLABLEパラメータが null 値をとることができるかどうかを表す整数値。
REMARKSパラメータの説明。
COLUMN_DEFパラメータのデフォルト値。
SQL_DATA_TYPEパラメータのサイズを表す整数値。
SQL_DATETIME_SUB datetime 型のコードを表す整数値、 あるいはこれが適用できない SQL データ型である場合に null
CHAR_OCTET_LENGTH 文字型のパラメータにおける最大のオクテット数。 シングルバイト文字セットのデータの場合、これは COLUMN_SIZE に一致します。文字型でないカラムの場合は null となります。
ORDINAL_POSITIONCALL 文の中でのパラメータの位置を表す、1 から始まるインデックス。
IS_NULLABLE パラメータが null 値をとることができるかどうかを表す文字列。 'YES' の場合は null 値をとることができ、 'NO' の場合はできません。

参考

  • db2_column_privileges() - テーブルのカラムおよび関連する権限情報を含む結果セットを返す
  • db2_columns() - テーブルのカラムおよび関連するメタデータを含む結果セットを返す
  • db2_foreign_keys() - テーブルの外部キーを含む結果セットを返す
  • db2_primary_keys() - テーブルの主キーを含む結果セットを返す
  • db2_procedures() - データベース内に登録されているストアドプロシージャの一覧を含む結果セットを返す
  • db2_special_columns() - テーブルのユニーク行 ID カラムを含む結果セットを返す
  • db2_statistics() - インデックスの情報およびテーブルの統計情報を含む結果セットを返す
  • db2_table_privileges() - データベース内のテーブルおよび関連する権限情報を含む結果セットを返す
  • db2_tables() - データベース内のテーブルおよび関連するメタデータを含む結果セットを返す
To Top