system-command-manuals
쿼리 명령어의 상세 설명서를 마크다운 형식으로 출력합니다.
명령어 속성
| 항목 | 설명 |
|---|---|
| 명령어 유형 | 드라이버 쿼리 |
| 필요 권한 | 없음 |
| 라이선스 사용량 | 집계 안 함 |
| 병렬 실행 | 미지원 |
| 분산 실행 | 미지원 |
문법
system-command-manuals [lang={en|ko|en,ko}]
옵션
lang={en|ko|en,ko}- 출력할 설명서의 언어를 지정합니다. 여러 언어를 설정할 때는 쉼표로 구분합니다. 지정하지 않으면 모든 언어의 설명서를 출력합니다.
en: 영문 설명서만 출력ko: 국문 설명서만 출력en,ko: 영문과 국문 설명서를 모두 출력
출력 필드
| 필드 | 타입 | 설명 |
|---|---|---|
| name | 문자열 | 쿼리 명령어의 이름 |
| en | 문자열 | 영문으로 된 쿼리 명령어 설명서 |
| ko | 문자열 | 국문으로 된 쿼리 명령어 설명서 |
오류 코드
파싱 오류
| 오류 코드 | 메시지 | 설명 |
|---|---|---|
| 95140 | 지원하지 않는 언어입니다: [lang] | lang 옵션에 en 또는 ko 외의 값을 지정한 경우 |
런타임 오류
해당 사항 없음
설명
system-command-manuals 명령어는 시스템에 등록된 모든 쿼리 명령어의 상세 설명서를 마크다운 형식으로 출력합니다. 각 설명서에는 명령어 설명, 문법, 옵션, 출력 필드, 사용 예시가 포함됩니다.
lang 옵션을 지정하지 않으면 영문(en)과 국문(ko) 두 언어의 설명서를 모두 출력합니다.
사용 예
-
모든 언어의 쿼리 명령어 설명서 출력
system-command-manuals -
국문 쿼리 명령어 설명서 출력
system-command-manuals lang=ko -
특정 명령어의 설명서 조회
system-command-manuals lang=ko | search name == "stats"
호환성
system-command-manuals 명령어는 소나 4.0.2308.0 버전부터 제공되었습니다.