> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> HTTPインターフェイスの `/docs` パスで提供され、`system.documentation` テーブルをバックエンドとする組み込みリファレンスドキュメント検索 Web UI のドキュメント

# ドキュメント検索

ドキュメント検索ページは、組み込みのリファレンスドキュメントを即座に検索できる、小規模で自己完結型の Web UI です。任意の ClickHouse HTTP ポートの `/docs` パスで提供されます。

任意の ClickHouse HTTP ポートの `/docs` にアクセスすると開けます (例: `http://localhost:8123/docs`) 。

<div id="what-it-does">
  ## 何をするか
</div>

このページは、入力に応じて HTTP 経由で [`system.documentation`](/docs/ja/reference/system-tables/documentation) テーブルにクエリを実行し、選択したエンティティの Markdown を表示します。`system.documentation` を読み取るため、このテーブルで公開されているすべてのエンティティ、つまり関数、集約関数、テーブル関数、テーブルエンジン、データベースエンジン、データ型、設定、フォーマット、圧縮コーデック、プロファイルイベント、メトリクス、システムテーブル自体などを対象とし、実行中のサーバーに埋め込まれているドキュメントと常に一致します。

検索ボックスに入力すると、一致する項目が種別ごとに色分けされたリストに表示されます。項目を選択すると、そのドキュメントが表示されます。表示内容には次が含まれます。

* エンティティのタイトルの横にある鉛筆アイコンのリンク。`system.documentation` の `source` カラムをもとに、GitHub 上のソースファイルを開きます。
* [`/play`](/docs/ja/concepts/features/interfaces/http) UI と同じ埋め込みレキサー (`Lexer.wasm`) を使った、コードブロックの ClickHouse SQL 構文ハイライト。
* [KaTeX](https://katex.org/) による TeX 数式 (たとえば `corr` ページの数式) 。
* `:::note`/`:::tip`/… の補足表示、共有可能なリンク付き見出しアンカー、コードブロックにホバーしたときの "Copy" ボタン。
* 相対リンクは、存在する場合はアプリ内の別の文書化済みエンティティに解決され、存在しない場合は `https://clickhouse.com/docs` に解決されます。"Related" と "Alias of" の参照もアプリ内リンクになります。

現在の検索語、開いているエンティティ、セクションは URL フラグメントに反映されるため、特定のページやセクションに直接リンクでき、ブラウザーの戻る/進む操作でも復元されます。自動検出付きのライト/ダークテーマ切り替えも `/play` に合わせられています。

<div id="connecting">
  ## 接続
</div>

ヘッダーには、`/play` とまったく同じ `URL`、`user`、`password` の入力欄があります。ページが ClickHouse から配信される場合、`URL` の既定値は現在のオリジンになります。ページをローカルファイルとして開く場合は、既定値が `http://localhost:8123/` になるため、ローカルで開いたページからリモートサーバーに接続することもできます。クロスリンク名の cache は、接続が変わると自動的に再構築されます。

<div id="assets">
  ## アセット
</div>

Markdown レンダラー ([Marked](https://marked.js.org/)) 、数式レンダラー (KaTeX とそのフォント) 、SQL レキサーを含むすべてのアセットは、ページが HTTP 経由で配信される場合、ClickHouse バイナリ自体から配信されます。ClickHouse の HTTP オリジンではサードパーティ製 CDN は読み込まれないため、このページは自己完結しており、オフラインでも動作し、処理対象の認証情報とともにサードパーティのネットワークコードが実行されることもありません。

<div id="security">
  ## セキュリティに関する考慮事項
</div>

このページは、ヘッダーに入力した認証情報を使って ClickHouse の HTTP エンドポイントにクエリを送信するため、HTTP プロトコルと同じ注意事項が当てはまります。

* 信頼できない環境では、認証情報を保護するため、`/docs` は必ず HTTPS 経由で公開してください。
* HTTP プロトコルへのアクセスを制限するのと同様に、ネットワークレベル (ファイアウォール、リバースプロキシ、または `listen_host` 設定) でもアクセスを制限してください。

`system.documentation` には、サーバーに組み込まれた静的なリファレンスドキュメントしか含まれないため、このページからテーブル内のデータが公開されることはありません。