mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-17 13:13:36 +00:00
5.3 KiB
5.3 KiB
toc_priority | toc_title |
---|---|
42 | DESCRIBE |
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.
Каждый столбец 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) │ │ │ │ │ │
└──────┴───────────────────────────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┘
Второй запрос дополнительно выводит информацию о подстолбцах:
┌─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.