system.documentation

関数、テーブルエンジン、データ型など、システムを構成する各種要素の埋め込みドキュメントを 1 つのテーブルに集約し、リファレンスドキュメントを Markdown としてレンダリングするシステムテーブル。

説明

システムの各種コンポーネントに埋め込まれたドキュメントを、1 つのテーブルに集約します。各行は 1 つのエンティティ (関数、テーブルエンジン、データ型など) に対応し、そのエンティティのリファレンスドキュメントを Markdown として格納します。内容は、Web サイトで公開されているものや、種類ごとの system.* テーブルで提供されているものと同一です。

description は、埋め込みドキュメントの構造化された各部分 (description、syntax、引数、例 など) から組み立てられるため、1 つのカラムにエンティティの完全なドキュメントが収まります。別名は、正規のエンティティへの短い参照として表示されます。たとえば Alias of `trunc`. のようになります。

このテーブルは、ある意味で、種類ごとのドキュメントテーブル (system.functions、system.table_engines、system.data_type_families など) で利用できる情報を集約したものです。特に、client の対話型 help コマンドの基盤となることを想定していますが、それ単体でも有用です。

収集されるエンティティの種類は次のとおりです (括弧内は type カラムの値です) :

• 関数 (Function)
• 集約関数 (Aggregate Function)
• テーブル関数 (Table Function)
• テーブルエンジン (Table Engine)
• データベースエンジン (Database Engine)
• データ型 (Data Type)
• Dictionary レイアウト (Dictionary Layout)
• Dictionary ソース (Dictionary Source)
• 集約関数コンビネータ (Aggregate Function Combinator)
• データスキッピングインデックスの型 (Data Skipping Index)
• ディスクタイプ (Disk Type)
• 設定 (Setting)
• MergeTree 設定 (MergeTree Setting)
• サーバー設定 (Server Setting)
• フォーマット (Format)

設定については、その設定の説明がドキュメントとして格納されます。廃止された設定は公開されません。

カラム

• 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)) — エンティティの種類。たとえば Function や Table Engine。
• description (String) — Markdown としてレンダリングされるエンティティのリファレンスドキュメントです。埋め込みドキュメント (Web サイトで公開されているものと同じ内容) から組み立てられており、構文、例、その他の構造化された部分が存在する場合は、それらも含まれます。

例

特定のエンティティに関するドキュメントを参照してください。

Query

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

同じ名前が複数の種類のエンティティを指すことがあります (たとえば、file table function と file Dictionary ソース の両方があります) 。そのため、あらゆる種類をまたいで名前を調べられると便利です。

Query

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

各種類ごとに、文書化されているエンティティの数を数えます:

Query

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

関連項目

• 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 — フォーマット。