/docs パスで提供されます。
任意の ClickHouse HTTP ポートの /docs にアクセスすると開けます (例: http://localhost:8123/docs) 。
何をするか
system.documentation テーブルにクエリを実行し、選択したエンティティの Markdown を表示します。system.documentation を読み取るため、このテーブルで公開されているすべてのエンティティ、つまり関数、集約関数、テーブル関数、テーブルエンジン、データベースエンジン、データ型、設定、フォーマット、圧縮コーデック、プロファイルイベント、メトリクス、システムテーブル自体などを対象とし、実行中のサーバーに埋め込まれているドキュメントと常に一致します。
検索ボックスに入力すると、一致する項目が種別ごとに色分けされたリストに表示されます。項目を選択すると、そのドキュメントが表示されます。表示内容には次が含まれます。
- エンティティのタイトルの横にある鉛筆アイコンのリンク。
system.documentationのsourceカラムをもとに、GitHub 上のソースファイルを開きます。 /playUI と同じ埋め込みレキサー (Lexer.wasm) を使った、コードブロックの ClickHouse SQL 構文ハイライト。- KaTeX による TeX 数式 (たとえば
corrページの数式) 。 :::note/:::tip/… の補足表示、共有可能なリンク付き見出しアンカー、コードブロックにホバーしたときの “Copy” ボタン。- 相対リンクは、存在する場合はアプリ内の別の文書化済みエンティティに解決され、存在しない場合は
https://clickhouse.com/docsに解決されます。“Related” と “Alias of” の参照もアプリ内リンクになります。
/play に合わせられています。
接続
/play とまったく同じ URL、user、password の入力欄があります。ページが ClickHouse から配信される場合、URL の既定値は現在のオリジンになります。ページをローカルファイルとして開く場合は、既定値が http://localhost:8123/ になるため、ローカルで開いたページからリモートサーバーに接続することもできます。クロスリンク名の cache は、接続が変わると自動的に再構築されます。
アセット
セキュリティに関する考慮事項
- 信頼できない環境では、認証情報を保護するため、
/docsは必ず HTTPS 経由で公開してください。 - HTTP プロトコルへのアクセスを制限するのと同様に、ネットワークレベル (ファイアウォール、リバースプロキシ、または
listen_host設定) でもアクセスを制限してください。
system.documentation には、サーバーに組み込まれた静的なリファレンスドキュメントしか含まれないため、このページからテーブル内のデータが公開されることはありません。