DESC TABLE

描述

该语句用于展示指定 table 的 schema 信息

语法

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

必选参数

1.<table_name>

指定表的标识符（即名称），在其所在的数据库（Database）中必须唯一。

标识符必须以字母字符（如果开启 unicode 名字支持，则可以是任意语言文字的字符）开头，并且不能包含空格或特殊字符，除非整个标识符字符串用反引号括起来（例如My Object）。

标识符不能使用保留关键字。

有关更多详细信息，请参阅标识符要求和保留关键字。

可选参数

1.<db_name>

指定数据库的标识符（即名称）。

标识符必须以字母字符（如果开启 unicode 名字支持，则可以是任意语言文字的字符）开头，并且不能包含空格或特殊字符，除非整个标识符字符串用反引号括起来（例如My Database）。

标识符不能使用保留关键字。

有关更多详细信息，请参阅标识符要求和保留关键字。

2.RIBE

返回表的所有列的描述信息

3.ALL

返回所有列的描述信息

返回值

列名	说明
IndexName	表名
IndexKeysType	表模型
Field	列名
Type	数据类型
Null	是否允许为 NULL 值
Key	是否为 key 列
Default	默认值
Extra	显示一些额外的信息
Visible	是否可见
DefineExpr	定义表达式
WhereClause	过滤条件相关的定义

权限控制

执行此 SQL 命令的用户必须至少具有以下权限：

权限（Privilege）	对象（Object）	说明（Notes）
SELECT_PRIV	表（Table）	当执行 DESC 时，需要拥有被查询的表的 SELECT_PRIV 权限

注意事项

如果指定 ALL，则显示该 table 的所有 index(rollup) 的 schema

举例

显示 Base 表 Schema

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  |
+---------+-------------+------+-------+---------+-------+

显示表所有 index 的 schema

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    |            |             |
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+

CREATE TABLE DROP TABLE