Returns information about table columns.
構文
DESC|DESCRIBE TABLE [db.]table [INTO OUTFILE filename] [FORMAT format]
DESCRIBE
ステートメントは、次の String 値を持つ各テーブルカラムの行を返します:
name
— カラム名。
type
— カラムタイプ。
default_type
— カラムの default expression に使用される句: DEFAULT
、MATERIALIZED
、または ALIAS
。デフォルト式がない場合は、空の文字列が返されます。
default_expression
— DEFAULT
句の後に指定された式。
comment
— カラムコメント。
codec_expression
— カラムに適用される codec。
ttl_expression
— TTL 式。
is_subcolumn
— 内部サブカラムに対して 1
と等しくなるフラグ。サブカラムの説明が describe_include_subcolumns 設定によって有効な場合のみ結果に含まれます。
Nested データ構造内のすべてのカラムは別々に記述されます。各カラムの名前は、親カラム名とドットで接頭辞が付けられます。
他のデータ型の内部サブカラムを表示するには、describe_include_subcolumns 設定を使用します。
例
クエリ:
CREATE TABLE describe_example (
id UInt64, text String DEFAULT 'unknown' CODEC(ZSTD),
user Tuple (name String, age UInt8)
) ENGINE = MergeTree() ORDER BY id;
DESCRIBE TABLE describe_example;
DESCRIBE TABLE describe_example SETTINGS describe_include_subcolumns=1;
結果:
┌─name─┬─type──────────────────────────┬─default_type─┬─default_expression─┬─comment─┬─codec_expression─┬─ttl_expression─┐
│ id │ UInt64 │ │ │ │ │ │
│ text │ String │ DEFAULT │ 'unknown' │ │ ZSTD(1) │ │
│ user │ Tuple(name String, age UInt8) │ │ │ │ │ │
└──────┴───────────────────────────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┘
2 回目のクエリは、追加でサブカラムを表示します:
┌─name──────┬─type──────────────────────────┬─default_type─┬─default_expression─┬─comment─┬─codec_expression─┬─ttl_expression─┬─is_subcolumn─┐
│ id │ UInt64 │ │ │ │ │ │ 0 │
│ text │ String │ DEFAULT │ 'unknown' │ │ ZSTD(1) │ │ 0 │
│ user │ Tuple(name String, age UInt8) │ │ │ │ │ │ 0 │
│ user.name │ String │ │ │ │ │ │ 1 │
│ user.age │ UInt8 │ │ │ │ │ │ 1 │
└───────────┴───────────────────────────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┴──────────────┘
関連項目