メインコンテンツまでスキップ

DESC TABLE

説明

このステートメントは、指定されたテーブルのスキーマ情報を表示するために使用されます。

構文

DESC[RIBE] [db_name.]table_name [ALL];

必須パラメータ

1.<table_name>

テーブル識別子(名前)を指定します。これは配置されているデータベース内で一意である必要があります。

識別子は英字(unicode名前サポートが有効の場合は言語の任意の文字)で始まる必要があり、識別子文字列全体がバッククォートで囲まれていない限り(例:My Object)、スペースや特殊文字を含むことはできません。

識別子は予約キーワードを使用できません。

詳細については、Identifier Requirements and Reserved Keywordsを参照してください。

オプションパラメータ

1.<db_name>

データベースの識別子(つまり名前)を指定します。

識別子は英字(unicode名前サポートが有効の場合は特定の言語の任意の文字)で始まる必要があり、識別子文字列全体がバッククォートで囲まれていない限り(例:My Database)、スペースや特殊文字を含むことはできません。

識別子は予約キーワードを使用できません。

詳細については、Identifier Requirements and Reserved Keywordsを参照してください。

2.RIBE

テーブル内のすべてのカラムの説明情報を返します

3.ALL

すべてのカラムの説明情報を返します

戻り値

column namedescription
IndexNameテーブル名
IndexKeysTypeテーブルモデル
Fieldカラム名
Typeデータ型
NullNULL値が許可されているか
Keyキーカラムかどうか
Defaultデフォルト値
Extra追加情報を表示
Visible可視
DefineExpr定義式
WhereClauseフィルタ条件関連定義

アクセス制御要件

このSQLコマンドを実行するユーザーは、少なくとも以下の権限を持っている必要があります:

PrivilegeObjectNotes
SELECT_PRIVTableDESCを実行する際、クエリ対象のテーブルに対するSELECT_PRIV権限が必要です

使用上の注意

  • ALLが指定されている場合、テーブルのすべてのインデックス(rollup)のスキーマが表示されます。

  1. Baseテーブルスキーマを表示
DESC test_table;
+---------+-------------+------+-------+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+---------+-------------+------+-------+---------+-------+
| user_id | bigint | No | true | NULL | |
| name | varchar(20) | Yes | false | NULL | NONE |
| age | int | Yes | false | NULL | NONE |
+---------+-------------+------+-------+---------+-------+
  1. テーブル内の全インデックスのスキーマを表示する
DESC demo.test_table ALL;
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+
| IndexName | IndexKeysType | Field | Type | InternalType | Null | Key | Default | Extra | Visible | DefineExpr | WhereClause |
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+
| test_table | DUP_KEYS | user_id | bigint | bigint | No | true | NULL | | true | | |
| | | name | varchar(20) | varchar(20) | Yes | false | NULL | NONE | true | | |
| | | age | int | int | Yes | false | NULL | NONE | true | | |
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+