メインコンテンツまでスキップ
バージョン: 3.2

DESC

Description

このステートメントを使用して、次の操作を実行できます。

  • StarRocks クラスターに保存されているテーブルのスキーマを表示し、テーブルの ソートキーマテリアライズドビュー のタイプを確認します。
  • Apache Hive™ などの外部データソースに保存されているテーブルのスキーマを表示します。この操作は StarRocks 2.4 以降のバージョンでのみ実行できます。

Syntax

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

Parameters

ParameterRequiredDescription
catalog_nameNo内部 catalog または外部 catalog の名前。
  • パラメータの値を内部 catalog の名前、つまり default_catalog に設定すると、StarRocks クラスターに保存されているテーブルのスキーマを表示できます。
  • パラメータの値を外部 catalog の名前に設定すると、外部データソースに保存されているテーブルのスキーマを表示できます。
db_nameNoデータベース名。
table_nameYesテーブル名。
ALLNo
  • このキーワードを指定すると、StarRocks クラスターに保存されているテーブルのソートキー、マテリアライズドビュー、およびスキーマのタイプを表示できます。このキーワードを指定しない場合は、テーブルスキーマのみを表示します。
  • 外部データソースに保存されているテーブルのスキーマを表示する場合、このキーワードを指定しないでください。

Output

+-----------+---------------+-------+------+------+-----+---------+-------+
| IndexName | IndexKeysType | Field | Type | Null | Key | Default | Extra |
+-----------+---------------+-------+------+------+-----+---------+-------+

このステートメントによって返されるパラメータを以下に説明します。

ParameterDescription
IndexNameテーブル名。外部データソースに保存されているテーブルのスキーマを表示する場合、このパラメータは返されません。
IndexKeysTypeテーブルのソートキーのタイプ。外部データソースに保存されているテーブルのスキーマを表示する場合、このパラメータは返されません。
Fieldカラム名。
Typeカラムのデータ型。
Nullカラムの値が NULL 可能かどうか。
  • yes: 値が NULL 可能であることを示します。
  • no: 値が NULL ではないことを示します。
Keyカラムがソートキーとして使用されているかどうか。
  • true: カラムがソートキーとして使用されていることを示します。
  • false: カラムがソートキーとして使用されていないことを示します。
Defaultカラムのデータ型のデフォルト値。データ型にデフォルト値がない場合、NULL が返されます。
Extra
  • StarRocks クラスターに保存されているテーブルのスキーマを表示する場合、このフィールドはカラムに関する次の情報を表示します。
    • カラムで使用される集計関数、例えば SUMMIN
    • カラムにブルームフィルターインデックスが作成されているかどうか。作成されている場合、Extra の値は BLOOM_FILTER です。
  • 外部データソースに保存されているテーブルのスキーマを表示する場合、このフィールドはカラムがパーティションカラムであるかどうかを表示します。カラムがパーティションカラムである場合、Extra の値は partition key です。

Note: 出力におけるマテリアライズドビューの表示方法については、Example 2 を参照してください。

Examples

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

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

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

References