describe
describe 命令用于查询索引元数据。该命令只能用作 PPL 查询中的第一条命令。
语法
describe 命令的语法如下。该命令的参数是一个由可选数据源、可选模式和必需表名组成的点分隔路径：
describe [<data-source>.][<schema>.]<table-name>
参数
describe 命令支持以下参数。
| 参数 | 必需/可选 | 描述 |
|---|---|---|
<table-name> |
必需 | 要查询的表。 |
<data-source> |
可选 | 要使用的数据源。默认为 UDB-SX datasource。 |
<schema> |
可选 | 要使用的模式。默认为默认模式。 |
示例 1：获取所有元数据
此示例描述 accounts 索引：
describe accounts
查询返回以下结果：
| TABLE_CAT | TABLE_SCHEM | TABLE_NAME | COLUMN_NAME | DATA_TYPE | TYPE_NAME | COLUMN_SIZE | BUFFER_LENGTH | DECIMAL_DIGITS | NUM_PREC_RADIX | NULLABLE | REMARKS | COLUMN_DEF | SQL_DATA_TYPE | SQL_DATETIME_SUB | CHAR_OCTET_LENGTH | ORDINAL_POSITION | IS_NULLABLE | SCOPE_CATALOG | SCOPE_SCHEMA | SCOPE_TABLE | SOURCE_DATA_TYPE | IS_AUTOINCREMENT | IS_GENERATEDCOLUMN |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| docTestCluster | null | accounts | account_number | null | bigint | null | null | null | 10 | 2 | null | null | null | null | null | 0 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | firstname | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 1 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | address | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 2 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | balance | null | bigint | null | null | null | 10 | 2 | null | null | null | null | null | 3 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | gender | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 4 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | city | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 5 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | employer | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 6 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | state | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 7 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | age | null | bigint | null | null | null | 10 | 2 | null | null | null | null | null | 8 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 9 | null | null | null | null | NO | |||
| docTestCluster | null | accounts | lastname | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 10 | null | null | null | null | NO |
示例 2：根据条件和过滤器获取元数据
此示例从 accounts 索引中检索类型为 bigint 的列：
describe accounts
| where TYPE_NAME="bigint"
| fields COLUMN_NAME
查询返回以下结果：
