system.documentation

Description

Collecte dans une seule table la documentation embarquée des composants uniformes du système. Chaque ligne correspond à une entité (une fonction, un moteur de table, un type de données, etc.) et contient la documentation de référence de cette entité au format Markdown — le même contenu que celui publié sur le site web et exposé par les tables system.* propres à chaque type. La description est construite à partir des parties structurées de la documentation embarquée (description, syntax, arguments, exemples, etc.), de sorte qu’une seule colonne contient la documentation complète d’une entité. Lorsque la documentation embarquée contient toute la page de référence dans sa description (comme c’est le cas pour les composants dont les pages du site web sont générées automatiquement à partir de celle-ci : moteurs de table, moteurs de base de données, types de données, formats, fonctions de table), la page est publiée telle quelle, sans ajouter de sections composées à partir des champs de métadonnées structurées — le corps de la page couvre déjà ces informations. Les alias sont présentés sous la forme d’un bref renvoi vers l’entité canonique, par ex. Alias of `trunc`. Cette table regroupe, d’une certaine manière, les informations disponibles dans les tables de documentation propres à chaque type (system.functions, system.table_engines, system.data_type_families, entre autres). Elle est notamment conçue pour servir de base à une commande help interactive dans le client, mais elle est également utile à elle seule. Les types d’entités suivants sont collectés (la valeur de la colonne type est indiquée entre parenthèses) :

Fonctions (Function)
Fonctions d’agrégat (Aggregate Function)
Fonctions de table (Table Function)
Moteurs de table (Table Engine)
Moteurs de base de données (Database Engine)
Types de données (Data Type)
Structures de dictionnaire (Dictionary Layout)
Sources de dictionnaire (Dictionary Source)
Combinateurs de fonctions d’agrégat (Aggregate Function Combinator)
Types d’index de saut de données (Data Skipping Index)
Types de disque (Disk Type)
Paramètres (Setting)
Paramètres MergeTree (MergeTree Setting)
Paramètres du serveur (Server Setting)
Formats (Format)
Codecs de compression (Compression Codec)
Événements de profil (Profile Event)
Métriques actuelles (Current Metric)
Métriques asynchrones (Asynchronous Metric)
Tables système (System Table)

Pour les paramètres (de tout type), la documentation correspond à la description du paramètre, ainsi qu’à son type et à sa valeur par défaut ; les paramètres obsolètes ne sont pas exposés. Pour les tables système, la documentation correspond au commentaire de la table ainsi qu’à la liste de ses colonnes (le nom, le type et la description de chacune). La colonne source contient le chemin du fichier source dans lequel la documentation de l’entité est définie, relatif à la racine du dépôt. Pour la plupart des entités, il est capturé automatiquement à l’endroit où l’objet de documentation est construit (le point d’enregistrement du composant) ; pour les types documentés chacun dans un fichier source unique (comme les paramètres, les événements de profil et les métriques actuelles), il s’agit de ce fichier.

Colonnes

name (String) — Le nom de l’entité, par ex. 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, ‘Compression Codec’ = 16, ‘Profile Event’ = 17, ‘Current Metric’ = 18, ‘Asynchronous Metric’ = 19, ‘System Table’ = 20)) — Le type de l’entité, par ex. Function ou Table Engine.
description (String) — La documentation de référence de l’entité, au format Markdown, est générée à partir de la documentation embarquée (le même contenu que celui publié sur le site web), y compris la syntaxe, les exemples et d’autres parties structurées, le cas échéant.
source (String) — Le chemin d’accès au fichier source où la documentation de l’entité est définie, relatif à la racine du dépôt. Vide si l’emplacement de la source est inconnu.

Exemple

Consultez la documentation d’une entité donnée :

Query

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

Le même nom peut désigner plusieurs types d’entités (par exemple, il existe à la fois une fonction de table file et une source de dictionnaire file) ; il est donc pratique de rechercher un nom dans tous les types :

Query

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

Comptez les entités documentées de chaque type :

Query

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

Voir aussi

system.functions — Fonctions standard et d’agrégation.
system.table_functions — Fonctions de table.
system.table_engines — Moteurs de table.
system.database_engines — Moteurs de base de données.
system.data_type_families — Types de données.
system.disk_types — Types de disques.
system.settings — Paramètres.
system.merge_tree_settings — Paramètres MergeTree.
system.server_settings — Paramètres du serveur.
system.formats — Formats.

Get started

Setup

Sample datasets

Migrate

Description

Colonnes

Exemple

Voir aussi

​Description

​Colonnes

​Exemple

​Voir aussi

Description

Colonnes

Exemple

Voir aussi