system.documentation

Системная таблица, которая собирает встроенную документацию по однотипным компонентам системы (функциям, движкам таблиц, типам данных и т. д.) в единую таблицу, где справочная документация отображается в формате Markdown.

Описание

Собирает встроенную документацию по унифицированным компонентам системы в одну таблицу. Каждая строка соответствует одной сущности (функции, движку таблицы, типу данных и так далее) и содержит справочную документацию по этой сущности, отрендеренную в Markdown — то же содержимое, которое публикуется на сайте и доступно через таблицы system.* для каждого типа.

description формируется из структурированных частей встроенной документации (description, syntax, аргументов, примеров и так далее), так что в одном столбце содержится полная документация по сущности. Псевдонимы отображаются как краткая ссылка на каноническую сущность, например: Псевдоним `trunc`.

Эта таблица в некотором смысле объединяет информацию, доступную в таблицах документации для отдельных типов (system.functions, system.table_engines, system.data_type_families и других). В частности, она предназначена для поддержки интерактивной команды help в клиенте, но полезна и сама по себе.

Собираются следующие виды сущностей (значение столбца type показано в скобках):

• Функции (Function)
• Агрегатные функции (Aggregate Function)
• Табличные функции (Table Function)
• Движки таблиц (Table Engine)
• Движки баз данных (Database Engine)
• Типы данных (Data Type)
• Структуры словарей (Dictionary Layout)
• Источники словарей (Dictionary Source)
• Комбинаторы агрегатных функций (Aggregate Function Combinator)
• Типы индексов пропуска данных (Data Skipping Index)
• Типы дисков (Disk Type)
• Настройки (Setting)
• Настройки MergeTree (MergeTree Setting)
• Настройки сервера (Server Setting)
• Форматы (Format)

Для настроек документацией служит описание самой настройки; устаревшие настройки не показываются.

Столбцы

• name (String) — Имя сущности, например domainWithoutWWW или MergeTree.
• type (Enum8(‘Function’ = 1, ‘Aggregate Function’ = 2, ‘Table Function’ = 3, ‘Table Engine’ = 4, ‘Database Engine’ = 5, ‘Data Type’ = 6, ‘Dictionary Layout’ = 7, ‘Dictionary Source’ = 8, ‘Aggregate Function Combinator’ = 9, ‘Data Skipping Index’ = 10, ‘Disk Type’ = 11, ‘Setting’ = 12, ‘MergeTree Setting’ = 13, ‘Server Setting’ = 14, ‘Format’ = 15)) — Вид сущности, например Function или Table Engine.
• description (String) — Справочная документация по сущности, представленная в формате Markdown и собранная из встроенной документации (то же содержимое, что опубликовано на сайте), включая синтаксис, примеры и другие структурированные разделы, если они есть.

Пример

Ознакомьтесь с документацией по конкретному объекту:

Query

SELECT description
FROM system.documentation
WHERE type = 'Table Engine' AND name = 'MergeTree'
FORMAT TSVRaw;

Одно и то же имя может относиться к нескольким видам сущностей (например, есть и табличная функция file, и источник данных словаря file), поэтому удобно искать это имя сразу по всем видам:

Query

SELECT type, name
FROM system.documentation
WHERE name = 'file'
ORDER BY type;

Подсчитайте количество описанных сущностей каждого вида:

Query

SELECT type, count()
FROM system.documentation
GROUP BY type
ORDER BY count() DESC;

См. также

• system.functions — Обычные и агрегатные функции.
• system.table_functions — Табличные функции.
• system.table_engines — Движки таблиц.
• system.database_engines — Движки баз данных.
• system.data_type_families — Типы данных.
• system.disk_types — Типы дисков.
• system.settings — Настройки.
• system.merge_tree_settings — Настройки MergeTree.
• system.server_settings — Настройки сервера.
• system.formats — Форматы.