> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> 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.

# system.documentation

<div id="description">
  ## Descripción
</div>

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. Cuando la documentación integrada contiene en su `description` toda la página de referencia (como ocurre con los componentes cuyas páginas web se generan automáticamente a partir de ella: motores de tabla, motores de base de datos, tipos de datos, formatos y funciones de tabla), la página se publica tal cual, sin añadir secciones compuestas a partir de los campos de metadatos estructurados, ya que el cuerpo de la página ya cubre ese material. 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`](/docs/es/reference/system-tables/functions), [`system.table_engines`](/docs/es/reference/system-tables/table_engines), [`system.data_type_families`](/docs/es/reference/system-tables/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`)
* Códecs de compresión (`Compression Codec`)
* Eventos de perfil (`Profile Event`)
* Métricas actuales (`Current Metric`)
* Métricas asincrónicas (`Asynchronous Metric`)
* Tablas del sistema (`System Table`)

En el caso de los ajustes (de cualquier tipo), la documentación es la descripción del ajuste, junto con su tipo y su valor predeterminado; los ajustes obsoletos no se exponen. En el caso de las tablas del sistema, la documentación es el comentario de la tabla junto con la lista de sus columnas (el nombre, el tipo y la descripción de cada una).

La columna `source` contiene la ruta del archivo fuente donde se define la documentación de la entidad, relativa a la raíz del repositorio. Para la mayoría de las entidades, se captura automáticamente en el lugar donde se construye el objeto de documentación (el punto de registro del componente); para los tipos que se documentan cada uno en un único archivo fuente (como los ajustes, los eventos de perfil y las métricas actuales), ese archivo es el que se usa.

<div id="columns">
  ## Columnas
</div>

* `name` ([String](/docs/es/reference/data-types/index)) — 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, 'Compression Codec' = 16, 'Profile Event' = 17, 'Current Metric' = 18, 'Asynchronous Metric' = 19, 'System Table' = 20)](/docs/es/reference/data-types/index)) — El tipo de la entidad, p. ej. `Function` o `Table Engine`.
* `description` ([String](/docs/es/reference/data-types/index)) — 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.
* `source` ([String](/docs/es/reference/data-types/index)) — La ruta al archivo fuente donde se define la documentación de la entidad, relativa a la raíz del repositorio. Vacío si se desconoce la ubicación del archivo fuente.

<div id="example">
  ## Ejemplo
</div>

Consulta la documentación de una entidad concreta:

```sql title="Query" theme={null}
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:

```sql title="Query" theme={null}
SELECT type, name
FROM system.documentation
WHERE name = 'file'
ORDER BY type;
```

Cuenta las entidades documentadas de cada tipo:

```sql title="Query" theme={null}
SELECT type, count()
FROM system.documentation
GROUP BY type
ORDER BY count() DESC;
```

<div id="see-also">
  ## Véase también
</div>

* [`system.functions`](/docs/es/reference/system-tables/functions) — Funciones normales y de agregación.
* [`system.table_functions`](/docs/es/reference/system-tables/table_functions) — Funciones de tabla.
* [`system.table_engines`](/docs/es/reference/system-tables/table_engines) — Motores de tabla.
* [`system.database_engines`](/docs/es/reference/system-tables/database_engines) — Motores de base de datos.
* [`system.data_type_families`](/docs/es/reference/system-tables/data_type_families) — Tipos de datos.
* [`system.disk_types`](/docs/es/reference/system-tables/disk_types) — Tipos de disco.
* [`system.settings`](/docs/es/reference/system-tables/settings) — Ajustes.
* [`system.merge_tree_settings`](/docs/es/reference/system-tables/merge_tree_settings) — Ajustes de MergeTree.
* [`system.server_settings`](/docs/es/reference/system-tables/server_settings) — Ajustes del servidor.
* [`system.formats`](/docs/es/reference/system-tables/formats) — Formatos.