DESC
DESC
説明
次の操作を実行するために、DESC[RIBE]ステートメントを使用できます。
- StarRocksクラスターに格納されているテーブルのスキーマを表示し、テーブルのソートキーとマテリアライズドビューのタイプも表示します。
- StarRocks 2.4以降のバージョンでのみ、次の外部データソース（Apache Hive™など）に格納されているテーブルのスキーマを表示できます。
構文
DESC[RIBE] [catalog_name.][db_name.]table_name [ALL];
パラメータ
パラメータ | 必須 | 説明 |
|---|---|---|
catalog_name | なし | 内部カタログまたは外部カタログの名前です。
|
db_name | なし | データベースの名前です。 |
table_name | 必須 | テーブルの名前です。 |
ALL | なし |
|
出力
+-----------+---------------+-------+------+------+-----+---------+-------+
| IndexName | IndexKeysType | Field | Type | Null | Key | Default | Extra |
+-----------+---------------+-------+------+------+-----+---------+-------+
次の表は、このステートメントによって返されるパラメータについて説明しています。
パラメータ | 説明 |
|---|---|
IndexName | テーブルの名前です。外部データソースに格納されたテーブルのスキーマを表示する場合、このパラメータは返されません。 |
IndexKeysType | テーブルのソートキーのタイプです。外部データソースに格納されたテーブルのスキーマを表示する場合、このパラメータは返されません。 |
Field | カラム名です。 |
Type | カラムのデータ型です。 |
Null | カラムの値がNULLであるかどうかを示します。
|
Key | カラムがソートキーとして使用されているかどうかを示します。
|
Default | カラムのデータ型のデフォルト値です。データ型にデフォルト値がない場合は、NULLが返されます。 |
Extra |
|
注意：マテリアライズドビューが出力にどのように表示されるかの情報については、例2を参照してください。
例
例1：StarRocksクラスターに格納されているexample_tableのスキーマを表示します。
DESC example_table;
または
DESC default_catalog.example_db.example_table;
上記のステートメントの出力は次のようになります。
+-------+---------------+------+-------+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+-------+---------------+------+-------+---------+-------+
| k1 | TINYINT | Yes | true | NULL | |
| k2 | DECIMAL(10,2) | Yes | true | 10.5 | |
| k3 | CHAR(10) | Yes | false | NULL | |
| v1 | INT | Yes | false | NULL | |
+-------+---------------+------+-------+---------+-------+
例2：StarRocksク ラスターに格納されているsales_recordsのスキーマ、ソートキーのタイプ、およびマテリアライズドビューを表示します。以下の例では、sales_recordsに基づいて1つのマテリアライズドビューstore_amtが作成されています。
DESC db1.sales_records ALL;
+---------------+---------------+-----------+--------+------+-------+---------+-------+
| IndexName | IndexKeysType | Field | Type | Null | Key | Default | Extra |
+---------------+---------------+-----------+--------+------+-------+---------+-------+
| sales_records | DUP_KEYS | record_id | INT | Yes | true | NULL | |
| | | seller_id | INT | Yes | true | NULL | |
| | | store_id | INT | Yes | true | NULL | |
| | | sale_date | DATE | Yes | false | NULL | NONE |
| | | sale_amt | BIGINT | Yes | false | NULL | NONE |
| | | | | | | | |
| store_amt | AGG_KEYS | store_id | INT | Yes | true | NULL | |
| | | sale_amt | BIGINT | Yes | false | NULL | SUM |
+---------------+---------------+-----------+--------+------+-------+---------+-------+
例3：Hiveクラスターに格納されているhive_tableのスキーマを表示します。
DESC hive_catalog.hive_db.hive_table;
+-------+----------------+------+-------+---------+---------------+
| Field | Type | Null | Key | Default | Extra |
+-------+----------------+------+-------+---------+---------------+
| id | INT | Yes | false | NULL | |
| name | VARCHAR(65533) | Yes | false | NULL | |
| date | DATE | Yes | false | NULL | partition key |
+-------+----------------+------+-------+---------+---------------+