Перейти к основному содержимому
Перейти к основному содержимому

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 │
└───────────┴───────────────────────────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┴──────────────┘

Смотрите также