system-commands

システムに登録されたクエリコマンドの一覧と各コマンドの詳細情報を照会します。

コマンドプロパティ

項目説明
コマンドタイプドライバークエリ
必要な権限なし
ライセンス使用量集計しない
並列実行非対応
分散実行非対応

構文

system-commands

オプション

なし

出力フィールド

フィールドタイプ説明
namestringクエリコマンドの名前
descriptionstringクエリコマンドの説明
optionsmapクエリコマンド実行時に入力できるオプション。各オプションの必須フラグ、表示名、説明を含みます。
outputsmapクエリコマンド実行時に出力されるフィールドと説明
usagestringクエリコマンドの使用例
display_groupstringクエリコマンドが属するグループ(Maestro、Sonar、Forensicなど)
display_namestringクエリコマンドの表示名

エラーコード

パースエラー

該当なし

ランタイムエラー

該当なし

説明

system-commandsコマンドは、システムに登録されたすべてのクエリコマンドの一覧と各コマンドの詳細情報を照会します。セッションのロケール設定に従い、説明・オプション・出力フィールドの情報が該当言語で返されます。

optionsフィールドは各オプションについて、必須フラグ(required)、表示名(display_name)、説明(description)をマップ形式で返します。outputsフィールドも同じ構造で各出力フィールドの情報を返します。

使用例

  1. すべてのクエリコマンド一覧を照会する

    system-commands
    

    システムに登録されたすべてのクエリコマンドの名前と詳細情報を照会します。

  2. 特定コマンドの情報を照会する

    system-commands | search name == "stats"
    

    statsコマンドの説明、オプション、出力フィールド情報を照会します。

  3. Sonarコマンドのみ照会する

    system-commands | search display_group == "Sonar"
    

    Sonarグループに属するクエリコマンドのみを照会します。