system-command-manuals
クエリコマンドの詳細マニュアルをMarkdown形式で出力します。
コマンドプロパティ
| 項目 | 説明 |
|---|---|
| コマンドタイプ | ドライバークエリ |
| 必要な権限 | なし |
| ライセンス使用量 | 集計しない |
| 並列実行 | 非対応 |
| 分散実行 | 非対応 |
構文
system-command-manuals [lang={en|ko|en,ko}]
オプション
lang={en|ko|en,ko}- 出力するマニュアルの言語を指定します。複数の言語を設定する場合はカンマで区切ります。指定しない場合はすべての言語のマニュアルを出力します。
en:英語マニュアルのみ出力ko:韓国語マニュアルのみ出力en,ko:英語と韓国語のマニュアルを両方出力
出力フィールド
| フィールド | タイプ | 説明 |
|---|---|---|
| name | string | クエリコマンドの名前 |
| en | string | 英語で記述されたクエリコマンドマニュアル |
| ko | string | 韓国語で記述されたクエリコマンドマニュアル |
エラーコード
パースエラー
| エラーコード | メッセージ | 説明 |
|---|---|---|
| 95140 | サポートされていない言語です:[lang] | langオプションにenまたはko以外の値を指定した場合 |
ランタイムエラー
該当なし
説明
system-command-manualsコマンドは、システムに登録されたすべてのクエリコマンドの詳細マニュアルをMarkdown形式で出力します。各マニュアルにはコマンドの説明、構文、オプション、出力フィールド、使用例が含まれます。
langオプションを指定しない場合は、英語(en)と韓国語(ko)の両言語のマニュアルを出力します。
使用例
-
すべての言語のクエリコマンドマニュアルを出力する
system-command-manualsシステムに登録されたすべてのクエリコマンドの英語および韓国語マニュアルを照会します。
-
韓国語のクエリコマンドマニュアルを出力する
system-command-manuals lang=koすべてのクエリコマンドの韓国語マニュアルを照会します。
-
特定コマンドのマニュアルを照会する
system-command-manuals lang=ko | search name == "stats"statsコマンドの韓国語マニュアルを照会します。