(PECL ibm_db2 >= 1.0.0)
db2_columns — テーブルのカラムおよび関連するメタデータを含む結果セットを返す
$connection
[, string $qualifier
[, string $schema
[, string $table-name
[, string $column-name
]]]] )テーブルのカラムおよび関連するメタデータを含む結果セットを返します。
connectionIBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。
qualifier
OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。
その他のデータベースの場合には NULL あるいは空の文字列を渡します。
schemaテーブルを含むスキーマ。すべてのスキーマに一致させるには、 '%' を渡します。
table-name
テーブルあるいはビューの名前。データベース内のすべてのテーブルに一致させるには、
NULL あるいは空の文字列を渡します。
column-name
カラムの名前。テーブル内のすべてのカラムに一致させるには、
NULL あるいは空の文字列を渡します。
指定したパラメータに一致するカラムの情報を含む結果セットの ステートメントリソースを返します。 行の内容は、以下のカラムで構成されています。
| カラム名 | 説明 |
|---|---|
| TABLE_CAT | カタログの名前。テーブルがカタログを保持していない場合は NULL。 |
| TABLE_SCHEM | スキーマの名前。 |
| TABLE_NAME | テーブルあるいはビューの名前。 |
| COLUMN_NAME | カラムの名前。 |
| DATA_TYPE | カラムの SQL データ型を整数値で表したもの。 |
| TYPE_NAME | カラムのデータ型を文字列で表したもの。 |
| COLUMN_SIZE | カラムのサイズを表す整数値。 |
| BUFFER_LENGTH | このカラムのデータを保存するために必要な最大のバイト数。 |
| DECIMAL_DIGITS |
カラムの位取り。位取りが適用できない場合は NULL。
|
| NUM_PREC_RADIX |
10 (正確な数値データ型を表す)、
2 (概数データ型を表す)、
あるいは NULL (基数が適用できないデータ型を表す)
のいずれか。
|
| NULLABLE | カラムが null 値をとることができるかどうかを表す整数値。 |
| REMARKS | カラムの説明。 |
| COLUMN_DEF | カラムのデフォルト値。 |
| SQL_DATA_TYPE | カラムのサイズを表す整数値。 |
| SQL_DATETIME_SUB |
datetime 型のコードを表す整数値、
あるいはこれが適用できない SQL データ型である場合に NULL。
|
| CHAR_OCTET_LENGTH |
文字型のカラムにおける最大のオクテット数。
シングルバイト文字セットのデータの場合、これは COLUMN_SIZE
に一致します。文字型でないカラムの場合は NULL となります。
|
| ORDINAL_POSITION | テーブル内でのカラムの位置を表す、1 から始まるインデックス。 |
| IS_NULLABLE | カラムが null 値をとることができるかどうかを表す文字列。 'YES' の場合は null 値をとることができ、 'NO' の場合はできません。 |