system.documentation

설명

시스템의 공통 구성 요소에 대한 내장 문서를 하나의 테이블에 모아 둡니다. 각 행은 하나의 엔터티(함수, 테이블 엔진, 데이터 타입 등)에 해당하며, 해당 엔터티의 참고 문서를 Markdown으로 렌더링한 내용을 담고 있습니다. 이 내용은 웹사이트에 게시되는 콘텐츠와 종류별 system.* 테이블에 노출되는 콘텐츠와 동일합니다. description은 내장 문서의 구조화된 부분(description, syntax, 인수, 예시 등)으로 구성되므로, 하나의 컬럼에 엔터티의 전체 문서가 담깁니다. 내장 문서의 description에 전체 참고 페이지가 들어 있는 경우(웹사이트 페이지가 이로부터 자동 생성되는 구성 요소, 즉 테이블 엔진, 데이터베이스 엔진, 데이터 타입, 포맷, 테이블 함수가 이에 해당), 해당 페이지는 구조화된 메타데이터 필드로 구성된 섹션을 추가하지 않고 있는 그대로 게시됩니다. 페이지 본문에 이미 그 내용이 포함되어 있기 때문입니다. 별칭은 기준 엔터티를 짧게 참조하는 형태로 렌더링됩니다. 예: Alias of `trunc`. 이 테이블은 어떤 의미에서는 종류별 문서 테이블(system.functions, system.table_engines, system.data_type_families 등)에서 제공되는 정보를 한곳에 모아 둔 것입니다. 특히 클라이언트의 대화형 help 명령을 지원하기 위한 용도이지만, 그 자체로도 유용합니다. 다음 유형의 엔터티가 수집됩니다(type 컬럼의 값은 괄호 안에 표시됨).

함수 (Function)
집계 함수 (Aggregate Function)
테이블 함수 (Table Function)
테이블 엔진 (Table Engine)
데이터베이스 엔진 (Database Engine)
데이터 타입 (Data Type)
딕셔너리 레이아웃 (Dictionary Layout)
딕셔너리 소스 (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)

설정(모든 종류 포함)의 경우 문서에는 해당 설정의 설명과 함께 유형 및 기본값이 포함되며, 더 이상 사용되지 않는 설정은 노출되지 않습니다. 또한 ClickHouse 버전별 설정 기본값 변경 이력도 포함됩니다. 여기에는 설정이 도입된 버전과 이후 기본값이 변경된 모든 내역이 이전 값, 새 값, 변경 사유와 함께 기록됩니다. 이는 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으로 렌더링됩니다. 내장 문서(웹사이트에 게시된 내용과 동일)에서 조합되며, 해당하는 경우 구문, 예시 및 기타 구조화된 부분을 포함합니다.
source (String) — 엔터티의 문서가 정의된 소스 파일 경로이며, 리포지토리 루트를 기준으로 한 상대 경로입니다. 소스 위치를 알 수 없으면 비어 있습니다.

예시

특정 엔터티에 대한 문서를 참조하세요:

Query

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

같은 이름이 여러 종류의 엔터티를 가리킬 수 있으므로(예를 들어 file 테이블 함수와 file 딕셔너리 소스가 모두 있음), 모든 종류를 대상으로 이름을 조회하는 것이 편리합니다:

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;

설정이 도입된 버전과 이후 기본값이 어떻게 변경되었는지 확인합니다:

Query

SELECT description
FROM system.documentation
WHERE type = 'Setting' AND name = 'async_insert_max_data_size'
FORMAT TSVRaw;

SQL 참고

데이터 타입

엔진

함수

포맷

인터페이스

설정

시스템 테이블

데이터 레이크

설명

컬럼

예시

관련 항목

​설명

​컬럼

​예시

​관련 항목

설명

컬럼

예시

관련 항목