Описание
system.* для каждого типа.
description формируется из структурированных частей встроенной документации (description, syntax, аргументов, примеров и так далее), так что в одном столбце содержится полная документация по сущности. Когда встроенная документация содержит всю справочную страницу в своём description (как в случае с компонентами, страницы которых на сайте автоматически генерируются на его основе: движки таблиц, движки баз данных, типы данных, форматы, табличные функции), страница публикуется как есть, без добавления разделов, составленных из структурированных полей метаданных, — содержимое страницы уже охватывает этот материал. Псевдонимы отображаются как краткая ссылка на каноническую сущность, например: Псевдоним `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) - Кодеки сжатия (
Compression Codec) - События профиля (
Profile Event) - Текущие метрики (
Current Metric) - Асинхронные метрики (
Asynchronous Metric) - Системные таблицы (
System Table)
source хранится путь к исходному файлу, в котором определена документация сущности, относительно корня репозитория. Для большинства сущностей он фиксируется автоматически в месте, где создаётся объект документации (в месте регистрации компонента); для типов, документация по которым находится в одном исходном файле (например, настройки, события профиля и текущие метрики), указывается этот файл.
Столбцы
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, ‘Compression Codec’ = 16, ‘Profile Event’ = 17, ‘Current Metric’ = 18, ‘Asynchronous Metric’ = 19, ‘System Table’ = 20)) — Вид сущности, напримерFunctionилиTable Engine.description(String) — Справочная документация по сущности, представленная в формате Markdown и собранная из встроенной документации (то же содержимое, что опубликовано на сайте), включая синтаксис, примеры и другие структурированные разделы, если они есть.source(String) — Путь к исходному файлу, в котором определена документация сущности, относительно корня репозитория. Пусто, если расположение исходного файла неизвестно.
Пример
Query
file, и источник данных словаря file), поэтому удобно искать это имя сразу по всем видам:
Query
Query
См. также
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— Форматы.