DESCRIBE TABLE

テーブルのカラムに関する情報を返します。

構文

DESC|DESCRIBE TABLE [db.]table [INTO OUTFILE filename] [FORMAT format]

DESCRIBE ステートメントは、各テーブルカラムに対して以下の String 値を持つ行を返します:

name — カラム名。
type — カラムの型。
default_type — カラムのデフォルト式で使用される句：DEFAULT、MATERIALIZED、または ALIAS。デフォルト式がない場合は空文字列が返されます。
default_expression — DEFAULT句の後に指定された式。
comment — カラムコメント。
codec_expression — カラムに適用されたコーデック。
ttl_expression — 有効期限 (TTL)式。
is_subcolumn — 内部サブカラムの場合は 1 となるフラグ。describe_include_subcolumns 設定でサブカラムの記述が有効になっている場合のみ結果に含まれます。

ネストされたデータ構造内のすべてのカラムは個別に記述されます。各カラムの名前は親カラム名とドットで接頭辞を付けられます。

他のデータ型の内部サブカラムを表示するには、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 │
└───────────┴───────────────────────────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┴──────────────┘

関連項目

describe_include_subcolumns 設定。