system.documentation

함수, 테이블 엔진, 데이터 타입 등 시스템의 여러 구성 요소에 대한 내장 문서를 Markdown으로 렌더링된 참고 문서와 함께 하나의 테이블에 수집하는 시스템 테이블입니다.

설명

시스템의 공통 구성 요소에 대한 내장 문서를 하나의 테이블에 모아 둡니다. 각 행은 하나의 엔터티(함수, 테이블 엔진, 데이터 타입 등)에 해당하며, 해당 엔터티의 참고 문서를 Markdown으로 렌더링한 내용을 담고 있습니다. 이 내용은 웹사이트에 게시되는 콘텐츠와 종류별 system.* 테이블에 노출되는 콘텐츠와 동일합니다.

description은 내장 문서의 구조화된 부분(description, syntax, 인수, 예시 등)으로 구성되므로, 하나의 컬럼에 엔터티의 전체 문서가 담깁니다. 별칭은 기준 엔터티를 짧게 참조하는 형태로 렌더링됩니다. 예: 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)

설정의 경우 문서는 해당 설정의 설명이며, 더 이상 사용되지 않는 설정은 노출되지 않습니다.

컬럼

• 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)) — 엔터티의 종류입니다. 예: Function 또는 Table Engine.
• description (String) — 엔터티의 참고 문서로, Markdown으로 렌더링됩니다. 내장 문서(웹사이트에 게시된 내용과 동일)에서 조합되며, 해당하는 경우 구문, 예시 및 기타 구조화된 부분을 포함합니다.

예시

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

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;

관련 항목

• 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.formats — 포맷.