DESC TABLE
説明
このステートメントは、指定されたTableのスキーマ情報を表示するために使用されます。
構文
DESC[RIBE] [db_name.]table_name [ALL];
必須パラメータ
1.<table_name>
Table識別子（名前）を指定します。これは配置されるデータベース内で一意である必要があります。
識別子は英字（またはunicode name supportが有効な場合は任意の言語の文字）で始まる必要があり、識別子文字列全体がバッククォートで囲まれていない限り（例：
My Object）、スペースや特殊文字を含むことはできません。識別子は予約キーワードを使用できません。
詳細については、Identifier Requirements and Reserved Keywordsを参照してください。
オプションパラメータ
1.<db_name>
データベースの識別子（すなわち名前）を指定します。
識別子は英字（またはunicode name supportが有効な場合は指定された言語の任意の文字）で始まる必要があり、識別子文字列全体がバッククォートで囲まれていない限り（例：
My Database）、スペースや特殊文字を含むことはできません。識別子は予約キーワードを使用できません。
詳細については、Identifier Requirements and Reserved Keywordsを参照してください。
2.RIBE
Table内のすべての列の説明情報を返します
3.ALL
すべての列の説明情報を返します
戻り値
| column name | description |
|---|---|
| IndexName | Table名 |
| IndexKeysType | Tableモデル |
| Field | 列名 |
| タイプ | データタイプ |
| Null | NULL値が許可されるかどうか |
| Key | キー列かどうか |
| Default | デフォルト値 |
| Extra | いくつかの追加情報を表示 |
| Visible | 可視性 |
| DefineExpr | 定義式 |
| WhereClause | フィルター条件関連定義 |
アクセス制御要件
このSQLコマンドを実行するユーザーは、少なくとも以下の権限を持つ必要があります：
| Privilege | Object | 注釈 |
|---|---|---|
| SELECT_PRIV | Table | DESCを実行する際は、クエリ対象のTableに対してSELECT_PRIV権限が必要です |
使用上の注意
- ALLが指定された場合、Tableのすべてのインデックス（rollup）のスキーマが表示されます。
例
- BaseTableスキーマを表示
DESC test_table;
+---------+-------------+------+-------+---------+-------+
| Field | タイプ | Null | Key | Default | Extra |
+---------+-------------+------+-------+---------+-------+
| user_id | bigint | No | true | NULL | |
| name | varchar(20) | Yes | false | NULL | NONE |
| age | int | Yes | false | NULL | NONE |
+---------+-------------+------+-------+---------+-------+
- Table内のすべてのインデックスのスキーマを表示する
DESC demo.test_table ALL;
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+
| IndexName | IndexKeysType | Field | タイプ | 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 | | |
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+