このページは機械翻訳したものです。

7.1.2 MySQL Shell レポートの登録

ユーザー定義レポートを MySQL Shell に登録するには、Python の JavaScript または shell.register_report() で shell.registerReport() メソッドをコールします。 メソッドの構文は次のとおりです:

shell.registerReport(name, type, report[, description])

ここでは:

• name は、レポートの一意の名前を示す文字列です。

• type は、「list」、「report」 または 「print」 のいずれかの出力形式を決定するレポートタイプを示す文字列です。

• report は、レポートの起動時にコールされる関数です。

• description は、レポートがサポートするオプション、レポートが受け入れる追加の引数、および MySQL Shell ヘルプシステムで提供されるヘルプ情報を指定するために使用できるオプションを含むディクショナリです。

name、type および report パラメータはすべて必須です。 レポート名は次の要件を満たしている必要があります:

• MySQL Shell インストールで一意である必要があります。

• 有効なスクリプト識別子である必要があるため、最初の文字は文字またはアンダースコア文字で、その後に任意の数の文字、数字またはアンダースコア文字が続く必要があります。

• 大文字と小文字を混在させることはできますが、小文字に変換する場合は、MySQL Shell インストールで一意である必要があります。

レポート名では、登録プロセス中や、\show および\watch コマンドを使用してレポートを実行する際に、大/小文字は区別されません。 shell.reports オブジェクトで対応する API 関数をコールする場合、レポート名では大/小文字が区別されます。 Python モードか JavaScript モードかにかかわらず、レポートの登録に使用された正確な名前を使用して関数をコールする必要があります。

オプションのディクショナリには次のキーが含まれており、これらはすべてオプションです:

brief

レポートの簡単な説明。

details

文字列の配列として提供されるレポートの詳細な説明。 これは、\show コマンドで\help コマンドまたは --help オプションを使用する場合に提供されます。

options

レポートが受け入れることができるレポート固有のオプション。 配列内の各ディクショナリには 1 つのオプションが記述されており、次のキーが含まれている必要があります:

• name (string、必須): 長い形式のオプションの名前。有効なスクリプト識別子である必要があります。

• brief (string、オプション): オプションの簡単な説明。

• shortcut (string、オプション): オプションの代替名 (単一の英数字)。

• details (文字列の配列、オプション): オプションの詳細な説明。 これは、\show コマンドで\help コマンドまたは --help オプションを使用する場合に提供されます。

• type (string、オプション): オプションの値タイプ。 許可される値は 「string」、「bool」、「integer」 および 「float」 で、type が指定されていない場合、デフォルトは 「string」 です。 「bool」 が指定されている場合、このオプションはスイッチとして機能: 指定しない場合、false にデフォルト設定され、\show または\watch コマンドを使用してレポートを実行する場合は true にデフォルト設定され (値は受け入れられません)、shell.reports オブジェクトを使用してレポートを実行する場合は有効な値が必要です。

• required (bool、オプション): オプションが必要かどうか。 required が指定されていない場合、デフォルトで false に設定されます。 オプションタイプが 「bool」 の場合、required は true にできません。

• values (文字列の配列、オプション): オプションに使用できる値のリスト。 このキーを持つことができるのは、「string」 タイプのオプションのみです。 values が指定されていない場合、このオプションは任意の値を受け入れます。

argc

レポートで想定される追加の引数の数を指定する文字列。次のいずれかを指定できます:

• 単一の数値として指定される引数の正確な数。

• アスタリスクとして指定されたゼロ個以上の引数。

• 引数番号の範囲。ダッシュで区切られた 2 つの数値として指定されます (例: 「1-5」)。

• 最小値で最大値が指定されていない引数番号の範囲。数値とアスタリスクで区切ります (「1-*」 など)。