db2_columns
(PECL ibm_db2 >= 1.0.0)
db2_columns — テーブルのカラムおよび関連するメタデータを含む結果セットを返す
説明
db2_columns(
resource
?string
?string
?string
?string
): resource
resource
$connection
,?string
$qualifier
= null
,?string
$schema
= null
,?string
$table_name
= null
,?string
$column_name
= null
): resource
テーブルのカラムおよび関連するメタデータを含む結果セットを返します。
パラメータ
connection
-
IBM 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' の場合はできません。 |
参考
- db2_column_privileges() - テーブルのカラムおよび関連する権限情報を含む結果セットを返す
- db2_foreign_keys() - テーブルの外部キーを含む結果セットを返す
- db2_primary_keys() - テーブルの主キーを含む結果セットを返す
- db2_procedure_columns() - ストアドプロシージャのパラメータを含む結果セットを返す
- db2_procedures() - データベース内に登録されているストアドプロシージャの一覧を含む結果セットを返す
- db2_special_columns() - テーブルのユニーク行 ID カラムを含む結果セットを返す
- db2_statistics() - インデックスの情報およびテーブルの統計情報を含む結果セットを返す
- db2_table_privileges() - データベース内のテーブルおよび関連する権限情報を含む結果セットを返す
- db2_tables() - データベース内のテーブルおよび関連するメタデータを含む結果セットを返す
+add a note
User Contributed Notes 3 notes
Anonymous ¶
10 years ago
As with previous message, passing null as the last param with db2_columns results in nothing being returned. Passing '%' instead works. The documentation really needs to be updated to correct this error as it's very misleading and was reported as wrong 8 years ago!
david dot rekowski at gmx dot de ¶
16 years ago
must be
db2_columns($conn, '', '%', $table, '%');
Don't forget that table names are UPPERCASE. That gave me quite some headache.
lada(at)hoidekr.net ¶
18 years ago
This is not true!
column-name
The name of the column. To match all columns in the table, pass NULL or an empty string.
You should pass '%' to match all columns