Skip to main content
문서 검색 페이지는 내장 참고 문서를 즉시 검색할 수 있는 작고 독립적인 웹 UI입니다. 이 페이지는 모든 ClickHouse HTTP 포트의 /docs 경로에서 제공됩니다. 열려면 ClickHouse HTTP 포트의 /docs로 이동하십시오(예: http://localhost:8123/docs).

​
동작 방식

이 페이지는 입력하는 동안 HTTP를 통해 system.documentation 테이블을 쿼리하고, 선택한 엔터티의 Markdown을 렌더링합니다. system.documentation을 읽기 때문에 이 테이블이 노출하는 모든 엔터티(함수, 집계 함수, 테이블 함수, 테이블 엔진, 데이터베이스 엔진, 데이터 타입, 설정, 포맷, 압축 코덱, profile events, 메트릭, 시스템 테이블 자체 등)를 포괄하며, 항상 실행 중인 서버에 내장된 문서와 일치합니다. 검색 상자에 입력하면 유형별 색상으로 구분된 목록에 일치하는 항목이 표시되며, 항목을 선택하면 해당 문서가 렌더링됩니다. 렌더링에는 다음이 포함됩니다.
  • 엔터티 제목 옆의 연필 링크로 GitHub의 소스 파일을 열 수 있으며, 이 링크는 system.documentation의 source 컬럼에서 가져옵니다.
  • /play UI와 동일한 내장 lexer(Lexer.wasm)를 사용한 코드 블록의 ClickHouse SQL 구문 강조;
  • KaTeX를 통한 TeX 수식 렌더링(예: corr 페이지의 수식);
  • :::note/:::tip/… 안내문, 공유 가능한 링크가 있는 제목 앵커, 코드 블록에 마우스를 올리면 표시되는 “Copy” 버튼;
  • 상대 링크는 해당 엔터티가 있으면 앱 내의 다른 문서화된 엔터티로 해석되고, 없으면 https://clickhouse.com/docs로 연결됩니다. “Related” 및 “Alias of” 참조도 앱 내 링크로 바뀝니다.
현재 검색어, 열려 있는 엔터티, 섹션은 URL fragment에 반영되므로 특정 페이지나 섹션에 직접 링크할 수 있으며, 브라우저의 뒤로/앞으로 탐색으로도 복원됩니다. 자동 감지를 지원하는 밝은/어두운 테마 전환기도 /play와 일치합니다.

​
연결

헤더에는 /play와 정확히 동일한 URL, user, password 입력란이 있습니다. 페이지가 ClickHouse를 통해 제공되면 URL은 기본적으로 현재 오리진을 사용합니다. 페이지를 로컬 파일로 열면 기본값은 http://localhost:8123/이므로, 원격 서버를 대상으로 페이지를 로컬에서 열 수도 있습니다. 연결이 변경되면 교차 링크 이름 캐시가 자동으로 다시 생성됩니다.

​
에셋

Markdown 렌더러(Marked), 수학 렌더러(KaTeX 및 해당 글꼴), SQL lexer를 포함한 모든 에셋은 페이지가 HTTP를 통해 제공될 때 ClickHouse 바이너리 자체에서 제공됩니다. ClickHouse HTTP 오리진에서는 타사 CDN을 로드하지 않으므로 페이지는 자체 완결적으로 동작하고, 오프라인에서도 사용할 수 있으며, 처리하는 자격 증명과 함께 타사 네트워크 코드를 실행하지 않습니다.

​
보안 고려 사항

이 페이지는 헤더에 입력한 자격 증명을 사용해 ClickHouse HTTP 엔드포인트로 쿼리를 보내므로, HTTP protocol에 적용되는 것과 동일한 주의 사항이 여기에도 적용됩니다:
  • 신뢰할 수 없는 환경에서는 자격 증명을 보호하기 위해 항상 /docs를 HTTPS로 제공하십시오.
  • HTTP protocol에 대한 접근을 제한하는 것과 동일한 방식으로 네트워크 수준(방화벽, 리버스 프록시 또는 listen_host 구성)에서 접근을 제한하십시오.
system.documentation에는 서버에 내장된 정적 참고 문서만 포함되어 있으므로, 이 페이지는 테이블의 어떤 데이터도 노출하지 않습니다.
마지막 수정일 2026년 7월 23일