DESCRIBE コマンドは、表またはビューの列、索引、およびデータ・パーティションに関するメタデータを表示します。 このコマンドは、SELECT、CALL、または XQuery ステートメントの出力に関するメタデータも表示できます。
情報を表示するオブジェクト | 必要な特権または権限 |
---|---|
SELECT ステートメントまたは XQuery ステートメントの出力 | SELECT ステートメント内で参照されている表またはビューごとに、以下のいずれかの特権または権限:
|
CALL ステートメントの出力 | 以下の特権または権限のいずれか。
|
表またはビューの列 | SYSCAT.COLUMNS システム・カタログ表に対して、以下のいずれかの特権または権限:
SHOW DETAIL パラメーターを使用する場合、SYSCAT.DATAPARTITIONEXPRESSION システム・カタログ表に対しても、これらの特権または権限のいずれかが必要になります。 PUBLIC には宣言済み一時表に対するすべての特権が付与されているので、 このコマンドを使用して、接続内に存在するすべての宣言済み一時表に関する情報を表示できます。 |
表またはビューの索引 | SYSCAT.INDEXES システム・カタログ表に対して、以下のいずれかの特権または権限:
SHOW DETAIL パラメーターを使用する場合、GET_INDEX_COLNAMES() UDF に対する EXECUTE 特権も必要です。 PUBLIC には宣言済み一時表に対するすべての特権が付与されているので、 このコマンドを使用して、接続内に存在するすべての宣言済み一時表に関する情報を表示できます。 |
表またはビューのデータ・パーティション | SYSCAT.DATAPARTITIONS システム・カタログ表に対して、以下のいずれかの特権または権限:
PUBLIC には宣言済み一時表に対するすべての特権が付与されているので、 このコマンドを使用して、接続内に存在するすべての宣言済み一時表に関する情報を表示できます。 |
データベース
>>-DESCRIBE-----------------------------------------------------> .-OUTPUT-. >--+-+--------+--+-select-statement---------+--------------------------------+->< | +-call-statement-----------+ | | '-XQUERY--XQuery-statement-' | '-+-TABLE----------------------------------+--table-name--+-------------+-' +-+-----------------+--INDEXES FOR TABLE-+ '-SHOW DETAIL-' | +-RELATIONAL DATA-+ | | +-XML DATA--------+ | | '-TEXT SEARCH-----' | '-DATA PARTITIONS FOR TABLE--------------'
特定の索引タイプについてだけの情報をリストする索引タイプを指定します。 複数の索引タイプの指定はサポートされていません。
SHOW DETAIL を指定した場合、列名情報もリストされます。
SHOW DETAIL を指定した場合、以下の XML データに対する索引の情報もリストされます。
SHOW DETAIL を指定した場合、以下のテキスト検索索引情報もリストされます。
TEXT SEARCH オプションが指定され、テキスト検索オプションがインストールされていないか正しく構成されていない場合、エラー (SQLSTATE 42724) が戻されます。
列にリストされる情報については、DB2® Text Search の情報を参照してください。
CALL SYSPROC.ADMIN_CMD('describe select * from emp_photo')
Result set 1
--------------
SQLTYPE_ID SQLTYPE SQLLENGTH SQLSCALE SQLNAME_DATA ...
---------- ---------..- --------- -------- ------------..- ...
452 CHARACTER 6 0 EMPNO ...
448 VARCHAR 10 0 PHOTO_FORMAT ...
405 BLOB 102400 0 PICTURE ...
3 record(s) selected.
Return Status = 0
... SQLNAME_LENGTH SQLDATATYPENAME_DATA SQLDATATYPENAME_LENGTH
... -------------- ---------------------..- -----------------------
... 5 SYSIBM .CHARACTER 18
... 12 SYSIBM .VARCHAR 16
... 7 SYSIBM .BLOB 13
CALL SYSPROC.ADMIN_CMD('describe table org show detail')
Result set 1
--------------
COLNAME TYPESCHEMA TYPENAME FOR_BINARY_DATA ...
-------...- ----------...- --------...- ---------------...- ...
DEPTNUMB SYSIBM SMALLINT N ...
DEPTNAME SYSIBM VARCHAR N ...
MANAGER SYSIBM SMALLINT N ...
DIVISION SYSIBM VARCHAR N ...
LOCATION SYSIBM VARCHAR N ...
5 record(s) selected.
... LENGTH SCALE NULLABLE COLNO PARTKEYSEQ CODEPAGE DEFAULT
... ------ ----- -------- ----- ---------- -------- -------
... 2 0 N 0 1 0 -
... 14 0 Y 1 0 1208 -
... 2 0 Y 2 0 0 -
... 10 0 Y 3 0 1208 -
... 13 0 Y 4 0 1208 -
Result set 2
--------------
DATA_PARTITION_KEY_SEQ DATA_PARTITION_EXPRESSION
---------------------- --------------------------
0 record(s) selected.
Return Status = 0
CALL SYSPROC.ADMIN_CMD('describe table part_table1 show detail')
Result set 1
--------------
COLNAME TYPESCHEMA TYPENAME FOR_BINARY_DATA ...
-------...- ----------...- -------- --------------- ...
COL1 SYSIBM INTEGER N ...
1 record(s) selected.
... LENGTH SCALE NULLABLE COLNO PARTKEYSEQ CODEPAGE DEFAULT
... ------ ----- -------- ----- ---------- -------- -------
... 4 0 N 0 1 0 -
Result set 2
--------------
DATA_PARTITION_KEY_SEQ DATA_PARTITION_EXPRESSION
---------------------- --------------------------
1 COL1
1 record(s) selected
CALL SYSPROC.ADMIN_CMD('describe indexes for table user1.department')
Result set 1
--------------
INDSCHEMA INDNAME UNIQUE_RULE
----------... ------------------... -------------------
SYSIBM SQL070531145253450 DUPLICATES_ALLOWED
SYSIBM SQL070531145253620 UNIQUE_ENTRIES_ONLY
USER1 RELIDX1 DUPLICATES_ALLOWED
USER1 RELIDX2 DUPLICATES_ALLOWED
SYSIBM SQL070531145253650 PRIMARY_INDEX
USER1 XMLIDX1 DUPLICATES_ALLOWED
SYSIBM SQL070531154625650 DUPLICATES_ALLOWED
USER1 XMLIDX2 DUPLICATES_ALLOWED
SYSIBM SQL070531154626000 DUPLICATES_ALLOWED
USER1 XMLIDX3 DUPLICATES_ALLOWED
SYSIBM SQL070531154626090 DUPLICATES_ALLOWED
USER1 XMLIDX4 DUPLICATES_ALLOWED
SYSIBM SQL070531154626190 DUPLICATES_ALLOWED
USER1 XMLIDX5 DUPLICATES_ALLOWED
SYSIBM SQL070531154626290 DUPLICATES_ALLOWED
USER1 XMLIDX6 DUPLICATES_ALLOWED
SYSIBM SQL070531154626400 DUPLICATES_ALLOWED
USER1 TXTIDX1 -
USER1 TXTIDX2 -
19 record(s) selected.
Return Status = 0
... COLCOUNT INDEXTYPE
... --------- --------------------------
... - XML_DATA_REGIONS
... 1 XML_DATA_PATH
... 1 RELATIONAL_DATA
... 2 RELATIONAL_DATA
... 1 RELATIONAL_DATA
... 1 XML_DATA_VALUES_LOGICAL
... 1 XML_DATA_VALUES_PHYSICAL
... 1 XML_DATA_VALUES_LOGICAL
... 1 XML_DATA_VALUES_PHYSICAL
... 1 XML_DATA_VALUES_LOGICAL
... 1 XML_DATA_VALUES_PHYSICAL
... 1 XML_DATA_VALUES_LOGICAL
... 1 XML_DATA_VALUES_PHYSICAL
... 1 XML_DATA_VALUES_LOGICAL
... 1 XML_DATA_VALUES_PHYSICAL
... 1 XML_DATA_VALUES_LOGICAL
... 1 XML_DATA_VALUES_PHYSICAL
... 1 TEXT_SEARCH
... 1 TEXT_SEARCH
CALL SYSPROC.ADMIN_CMD('describe data partitions for table part_table2')
Result set 1
--------------
DATA_PARTITION_ID LOW_KEY_INCLUSIVE LOW_KEY_VALUE ...
----------------- ----------------- ------------- ...
0 Y 1 ...
1 Y 10 ...
2 Y 20 ...
3 record(s) selected.
... HIGH_KEY_INCLUSIVE HIGH_KEY_VALUE
... ------------------ --------------
... N 10
... N 20
... N 40
CALL SYSPROC.ADMIN_CMD('describe data partitions
for table part_table2 show detail')
Result set 1
--------------
DATA_PARTITION_ID LOW_KEY_INCLUSIVE LOW_KEY_VALUE ...
----------------- ----------------- ------------- ...
0 Y 1 ...
1 Y 10 ...
2 Y 20 ...
3 record(s) selected.
Return Status = 0
... HIGH_KEY_INCLUSIVE HIGH_KEY_VALUE
... ------------------ --------------
... N 10
... N 20
... N 40
Result set 2
--------------
DATA_PARTITION_ID DATA_PARTITION_NAME TBSPID ...
----------------- ------------------- ------ ...
0 PART0 3 ...
1 PART1 3 ...
2 PART2 3 ...
3 record(s) selected.
Return Status = 0
... PARTITION_OBJECT_ID LONG_TBSPID ACCESSMODE STATUS
... ------------------- ----------- ----------- ------
... 15 3 FULL_ACCESS
... 16 3 FULL_ACCESS
... 17 3 FULL_ACCESS
DESCRIBE コマンドが一時表を作成しようとして失敗した場合、SYSTOOLSTMPSPACE の作成が試みられ、その後、再び一時表の作成が、今回は SYSTOOLSTMPSPACE の中で試みられます。 SYSCTRL または SYSADM 権限は、SYSTOOLSTMPSPACE 表スペースを作成するために必要です。
列名 | データ・タイプ | LOB のみ1 | 説明 |
---|---|---|---|
SQLTYPE_ID | SMALLINT | いいえ | 列のデータ・タイプ。 SQL 記述子域 (SQLDA) の SQLTYPE フィールドに示されているのと同じ。 |
SQLTYPE | VARCHAR (257) | いいえ | SQLTYPE_ID 値に対応するデータ・タイプ。 |
SQLLEN | INTEGER | いいえ | 列の長さ属性。 SQLDA の SQLLEN フィールドに示されているのと同じ。 |
SQLSCALE | SMALLINT | いいえ | 10 進 (DECIMAL) 値の場合は小数部分の桁数。それ以外のデータ・タイプの場合は 0。 |
SQLNAME_DATA | VARCHAR (128) | いいえ | 列の名前。 |
SQLNAME_LENGTH | SMALLINT | いいえ | 列名の長さ。 |
SQLDATA_TYPESCHEMA | VARCHAR (128) | はい | データ・タイプ・スキーマ名。 |
SQLDATA_TYPENAME | VARCHAR (128) | はい | データ・タイプ名。 |
列名 | データ・タイプ | 詳細2 | 説明 |
---|---|---|---|
COLNAME | VARCHAR (128) | いいえ | 列名。 |
TYPESCHEMA | VARCHAR (128) | いいえ | 列名が特殊ならスキーマ名が戻され、そうでない場合は 'SYSIBM' が戻されます。 |
TYPENAME | VARCHAR (128) | いいえ | 列タイプの名前。 |
FOR_BINARY_DATA | CHAR (1) | はい | 列が CHAR、VARCHAR、または LONG VARCHAR のいずれかのタイプであり、かつ FOR BIT DATA として定義されているなら 'Y' が戻され、そうでない場合は 'N' が戻されます。 |
LENGTH | INTEGER | いいえ | データの最大長。 DECIMAL (10 進) データの場合、これは精度を示します。 特殊タイプの場合、0 が戻されます。 |
SCALE | SMALLINT | いいえ | DECIMAL (10 進) データの場合、これはスケールを示します。 それ以外のすべてタイプの場合、0 が戻されます。 |
NULLABLE | CHAR (1) | いいえ | 以下のいずれか
|
COLNO | SMALLINT | はい | 列の順序。 |
PARTKEYSEQ | SMALLINT | はい | 表のパーティション・キーの中での列の順序。 列がパーティション・キーの一部でない場合は NULL または 0 が戻され、副表および階層表の場合は NULL。 |
CODEPAGE | SMALLINT | はい | 列のコード・ページ。以下のうちいずれか。
|
DEFAULT | VARCHAR (254) | はい | 列のデータ・タイプに適した定数、特殊レジスター、または cast 関数で表された表の列のデフォルト値。 NULL の場合もあります。 |
列名 | データ・タイプ | 説明 |
---|---|---|
DATA_PARTITION_KEY_SEQ | INTEGER | データ・パーティション・キー番号。 例えば、最初のデータ・パーティション式の場合は 1、2 番目のデータ・パーティション式の場合は 2。 |
DATA_PARTITION_EXPRESSION | CLOB (32K) | SQL 構文によるこのデータ・パーティション・キーの式 |
列名 | データ・タイプ | 詳細3 | 索引タイプ・オプション4、5 | 説明 |
---|---|---|---|---|
INDSCHEMA | VARCHAR (128) | いいえ | RELATIONAL DATA |
索引スキーマ名。 |
INDNAME | VARCHAR (128) | いいえ | RELATIONAL DATA |
索引名。 |
UNIQUE_RULE | VARCHAR (30) | いいえ | RELATIONAL DATA |
以下の値のいずれか。
|
INDEX_PARTITIONING | CHAR(1) | いいえ | N/A | 索引のパーティション特性を示します。
可能な値は以下のとおりです。
|
COLCOUNT | SMALLINT | いいえ | RELATIONAL DATA |
キー内の列数と組み込み列 (存在する場合) の数の合計。 |
INDEX_TYPE | VARCHAR (30) | いいえ | RELATIONAL DATA |
索引のタイプ:
|
INDEX_ID | SMALLINT | はい | RELATIONAL DATA |
リレーショナル・データ索引の索引 ID、XML パス索引、XML 領域索引、または XML データに対する索引 |
DATA_TYPE | VARCHAR (128) | はい | XML DATA | XML データに対する索引に指定された SQL データ・タイプ。
以下の値のいずれか。
|
HASHED | CHAR (1) | はい | XML DATA | XML データに対する索引の値がハッシュされるかどうかを示します。
|
LENGTH | SMALLINT | はい | XML DATA | XML データに対する索引の場合、VARCHAR (integer) の長さ。その他の場合 0。 |
PATTERN | CLOB (2M) | はい | XML DATA | XML データに対する索引に指定された XML パターン式。 |
CODEPAGE | INTEGER | はい | TEXT SEARCH | テキスト検索索引に指定された文書コード・ページ |
LANGUAGE | VARCHAR (5) | はい | TEXT SEARCH | テキスト検索索引に指定された文書言語 |
FORMAT | VARCHAR (30) | はい | TEXT SEARCH | テキスト検索索引に指定された文書フォーマット |
UPDATEMINIMUM | INTEGER | はい | TEXT SEARCH | インクリメンタル更新が実行される前のテキスト検索ログ表内の項目の最小数 |
UPDATEFREQUENCY | VARCHAR (300) | はい | TEXT SEARCH | テキスト索引に更新を適用するために指定されるトリガー基準 |
COLLECTIONDIRECTORY | VARCHAR (512) | はい | TEXT SEARCH | テキスト検索索引ファイルに指定されたディレクトリー |
COLNAMES | VARCHAR (2048) | はい | RELATIONAL DATA |
列名のリスト。 それぞれの前に + が付いている場合は昇順、- が付いている場合は降順。 |
列名 | データ・タイプ | 詳細2 | 説明 |
---|---|---|---|
DATA_PARTITION_ID | INTEGER | いいえ | データ・パーティション ID。 |
LOW_KEY_INCLUSIVE | CHAR (1) | いいえ | キー値の下限を含む場合は 'Y'、そうでない場合は 'N'。 |
LOW_KEY_VALUE | VARCHAR (512) | いいえ | このデータ・パーティションのキー値の下限。 |
HIGH_KEY_INCLUSIVE | CHAR (1) | いいえ | キー値の上限を含む場合は 'Y'、そうでない場合は 'N'。 |
HIGH_KEY_VALUE | VARCHAR (512) | いいえ | このデータ・パーティションのキー値の上限。 |
列名 | データ・タイプ | 説明 |
---|---|---|
DATA_PARTITION_ID | INTEGER | データ・パーティション ID。 |
DATA_PARTITION_NAME | VARCHAR (128) | データ・パーティション名。 |
TBSPID | INTEGER | このデータ・パーティションが格納されている表スペースの ID。 |
PARTITION_OBJECT_ID | INTEGER | このデータ・パーティションが格納されている DMS オブジェクトの ID。 |
LONG_TBSPID | INTEGER | LONG データが格納されている表スペースの ID。 |
INDEX_TBSPID | INTEGER | 索引データが格納されている表スペースの ID。 |
ACCESSMODE | VARCHAR (20) | データ・パーティションのアクセシビリティーを定義。以下のいずれかが必要です。
|
STATUS | VARCHAR(64) | データ・パーティションの状況。以下のいずれかが必要です。
|