system.documentation

Tabla del sistema que recopila en una sola tabla la documentación integrada de los componentes homogéneos del sistema (funciones, motores de tabla, tipos de datos, etc.), con la documentación de referencia presentada en formato Markdown.

Descripción

Recopila en una sola tabla la documentación integrada de los componentes uniformes del sistema. Cada fila corresponde a una entidad (una función, un motor de tabla, un tipo de dato, etc.) y contiene la documentación de referencia de esa entidad en formato Markdown: el mismo contenido que se publica en el sitio web y que exponen las tablas system.* específicas de cada tipo.

La description se compone a partir de las partes estructuradas de la documentación integrada (description, syntax, argumentos, ejemplos, etc.), de modo que una sola columna contiene la documentación completa de una entidad. Los alias se muestran como una referencia breve a la entidad canónica; por ejemplo, Alias of `trunc`.

Esta tabla, en cierto modo, recopila la información disponible en las tablas de documentación específicas de cada tipo (system.functions, system.table_engines, system.data_type_families y otras). Está pensada, en particular, como base para un comando help interactivo en el client, pero también es útil por sí sola.

Se recopilan los siguientes tipos de entidades (el valor de la columna type se muestra entre paréntesis):

• Funciones (Function)
• Funciones de agregación (Aggregate Function)
• Funciones de tabla (Table Function)
• Motores de tabla (Table Engine)
• Motores de base de datos (Database Engine)
• Tipos de datos (Data Type)
• Diseños de diccionario (Dictionary Layout)
• Fuentes de diccionario (Dictionary Source)
• Combinadores de funciones de agregación (Aggregate Function Combinator)
• Tipos de índices de omisión de datos (Data Skipping Index)
• Tipos de disco (Disk Type)
• Ajustes (Setting)
• Ajustes de MergeTree (MergeTree Setting)
• Ajustes del servidor (Server Setting)
• Formatos (Format)

En el caso de los ajustes, la documentación es la descripción del ajuste; los ajustes obsoletos no se exponen.

Columnas

• name (String) — El nombre de la entidad, p. ej. domainWithoutWWW o 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)) — El tipo de la entidad, p. ej. Function o Table Engine.
• description (String) — La documentación de referencia de la entidad en formato Markdown, generada a partir de la documentación integrada (el mismo contenido que se publica en el sitio web), incluida la sintaxis, los ejemplos y otras partes estructuradas, si las hay.

Ejemplo

Consulta la documentación de una entidad concreta:

Query

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

El mismo nombre puede referirse a varios tipos de entidades (por ejemplo, existe tanto la función de tabla file como el origen del diccionario file), por lo que conviene buscar ese nombre en todos los tipos:

Query

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

Cuenta las entidades documentadas de cada tipo:

Query

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

Véase también

• system.functions — Funciones normales y de agregación.
• system.table_functions — Funciones de tabla.
• system.table_engines — Motores de tabla.
• system.database_engines — Motores de base de datos.
• system.data_type_families — Tipos de datos.
• system.disk_types — Tipos de disco.
• system.settings — Ajustes.
• system.merge_tree_settings — Ajustes de MergeTree.
• system.server_settings — Ajustes del servidor.
• system.formats — Formatos.