> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Tabela de sistema que reúne em uma única tabela a documentação embutida dos componentes do sistema (funções, motores de tabela, tipos de dados e assim por diante), com a documentação de referência renderizada em Markdown.

# system.documentation

<div id="description">
  ## Descrição
</div>

Reúne em uma única tabela a documentação embutida dos componentes uniformes do sistema. Cada linha corresponde a uma entidade (uma função, um motor de tabela, um tipo de dado e assim por diante) e contém a documentação de referência dessa entidade em Markdown — o mesmo conteúdo publicado no site e exposto pelas tabelas `system.*` específicas por tipo.

A `description` é montada a partir das partes estruturadas da documentação embutida (`description`, `syntax`, argumentos, exemplos e assim por diante), de modo que uma única coluna contenha a documentação completa de uma entidade. Os aliases são exibidos como uma referência curta à entidade canônica, por exemplo ``Alias of `trunc`.``

De certa forma, esta tabela reúne as informações disponíveis nas tabelas de documentação específicas por tipo ([`system.functions`](/pt-BR/reference/system-tables/functions), [`system.table_engines`](/pt-BR/reference/system-tables/table_engines), [`system.data_type_families`](/pt-BR/reference/system-tables/data_type_families) e outras). Ela foi concebida, em particular, para dar suporte a um comando `help` interativo no client, mas também é útil por si só.

Os seguintes tipos de entidades são reunidos (o valor da coluna `type` é mostrado entre parênteses):

* Funções (`Function`)
* Funções agregadas (`Aggregate Function`)
* Funções de tabela (`Table Function`)
* Motores de tabela (`Table Engine`)
* Motores de banco de dados (`Database Engine`)
* Tipos de dados (`Data Type`)
* Layouts de dicionário (`Dictionary Layout`)
* Fontes de dicionário (`Dictionary Source`)
* Combinadores de funções agregadas (`Aggregate Function Combinator`)
* Tipos de índice data skipping (`Data Skipping Index`)
* Tipos de disco (`Disk Type`)
* Configurações (`Setting`)
* Configurações do MergeTree (`MergeTree Setting`)
* Configurações do servidor (`Server Setting`)
* Formatos (`Format`)

No caso das configurações, a documentação corresponde à descrição da configuração; configurações obsoletas não são expostas.

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

* `name` ([String](/pt-BR/reference/data-types/index)) — O nome da entidade, por exemplo `domainWithoutWWW` ou `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)](/pt-BR/reference/data-types/index)) — O tipo da entidade, por exemplo `Function` ou `Table Engine`.
* `description` ([String](/pt-BR/reference/data-types/index)) — A documentação de referência da entidade, renderizada em Markdown e compilada a partir da documentação embutida (o mesmo conteúdo publicado no site), incluindo sintaxe, exemplos e outras partes estruturadas, se houver.

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

Consulte a documentação de uma entidade específica:

```sql title="Query" theme={null}
SELECT description
FROM system.documentation
WHERE type = 'Table Engine' AND name = 'MergeTree'
FORMAT TSVRaw;
```

O mesmo nome pode se referir a vários tipos de entidades (por exemplo, existe tanto a função de tabela `file` quanto a origem de dicionário `file`), por isso é útil procurar esse nome em todos os tipos:

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

Conte as 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">
  ## Veja também
</div>

* [`system.functions`](/pt-BR/reference/system-tables/functions) — Funções regulares e funções de agregação.
* [`system.table_functions`](/pt-BR/reference/system-tables/table_functions) — Funções de tabela.
* [`system.table_engines`](/pt-BR/reference/system-tables/table_engines) — Motores de tabela.
* [`system.database_engines`](/pt-BR/reference/system-tables/database_engines) — Motores de banco de dados.
* [`system.data_type_families`](/pt-BR/reference/system-tables/data_type_families) — Tipos de dados.
* [`system.disk_types`](/pt-BR/reference/system-tables/disk_types) — Tipos de disco.
* [`system.settings`](/pt-BR/reference/system-tables/settings) — Configurações.
* [`system.merge_tree_settings`](/pt-BR/reference/system-tables/merge_tree_settings) — Configurações do MergeTree.
* [`system.server_settings`](/pt-BR/reference/system-tables/server_settings) — Configurações do servidor.
* [`system.formats`](/pt-BR/reference/system-tables/formats) — Formatos.