説明
system.* テーブルで提供されているものと同一です。
description は、埋め込みドキュメントの構造化された各部分 (description、syntax、引数、例 など) から組み立てられるため、1 つのカラムにエンティティの完全なドキュメントが収まります。埋め込みドキュメントの description にリファレンスページ全体が含まれている場合 (その内容から Web サイトのページが自動生成されるコンポーネント、つまりテーブルエンジン、データベース エンジン、データ型、フォーマット、テーブル関数がこれに該当します)、そのページはそのまま公開され、構造化されたメタデータフィールドから組み立てたセクションは追記されません。ページ本文にすでにその内容が含まれているためです。別名は、正規のエンティティへの短い参照として表示されます。たとえば 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) - 圧縮コーデック (
Compression Codec) - プロファイルイベント (
Profile Event) - 現在のメトリクス (
Current Metric) - 非同期メトリクス (
Asynchronous Metric) - システムテーブル (
System Table)
compatibility 設定および system.settings_changes の基盤となるデータと同一であるため、その仕組みが導入されて以降に記録された変更を対象とします。デフォルト値が一度も変更されていない古い設定には履歴がなく、compatibility の対象外であるサーバー設定にも履歴はありません。設定の別名で記録された変更は、compatibility が適用するのと同様に、その設定の履歴に属します。そのため、リネームされた設定の履歴はリネーム時点で途切れません。例外は、その別名を登録することのみを目的として別名で書き込まれたレコードで、これは別名だけの履歴となります。別名には、その名前自身の履歴が含まれます。つまり、その別名で書き込まれたすべてのレコードに加え、別名として登録したレコードも含まれます。履歴ファイルでは、このレコードが同じ設定の別の名前で書き込まれることがあります。
システムテーブルについては、テーブルコメントに加えて、そのカラムの一覧 (各カラムの名前、型、説明) がドキュメントとして格納されます。
source カラムには、エンティティのドキュメントが定義されているソースファイルのパスが、リポジトリルートからの相対パスで格納されます。ほとんどのエンティティでは、ドキュメントオブジェクトが構築される場所 (コンポーネントの登録箇所) で自動的に取得されます。種類ごとに単一のソースファイルでドキュメント化されているもの (設定、プロファイルイベント、現在のメトリクスなど) については、そのファイルが格納されます。
カラム
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, ‘Compression Codec’ = 16, ‘Profile Event’ = 17, ‘Current Metric’ = 18, ‘Asynchronous Metric’ = 19, ‘System Table’ = 20)) — エンティティの種類。たとえばFunctionやTable Engine。description(String) — Markdown としてレンダリングされるエンティティのリファレンスドキュメントです。埋め込みドキュメント (Web サイトで公開されているものと同じ内容) から組み立てられており、構文、例、その他の構造化された部分が存在する場合は、それらも含まれます。source(String) — エンティティのドキュメントが定義されているソースファイルへのパスで、リポジトリルート からの相対パスです。ソースの場所が不明な場合は空です。
例
Query
file テーブル関数 と file Dictionary ソース の両方があります) 。そのため、あらゆる種類をまたいで名前を調べられると便利です。
Query
Query
Query
関連項目
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.settings_changes— 設定のデフォルト値の変更履歴。system.formats— フォーマット。