API コマンドラインインタフェース

• JSON 形式が出力に使用されています

• MySQL Shell は対話モードで実行されています。

出力には「When JSON」形式が使用され、メタデータは JSON オブジェクトの一部として返されます。対話型モードでは、メタデータは結果の後に出力されます。

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

API インタフェースの例

さい。引用符が必要な場合は、親シェルの引用符のみを考慮するようにしてください。つまり、「foo bar」が bash でパラメータとして使用されている場合、引用符は削除され、エスケープが処理されます。

引数のリストでは、2 つのタイプの引数を使用できます: 位置指定引数と名前付き引数。位置引数は、文字列、数値、

ブール、null などの単純な型です。名前付き引数はキーと値のペアで、値は単純な型です。使用方法は、次のパターンに従う必要があります:

[ positional_argument ]* [ { named_argument* } ]* [ named_argument ]*

この構文を使用するためのルールは次のとおりです:

• 構文のすべての部分はオプションであり、任意の順序で指定できます

• 中カッコのネストは禁止されています

• 名前付き引数として指定するすべてのキー値は、スコープ内で一意の名前を持つ必要があります。スコープは、グループ化されていないか、グループ内 (中カッコ内) にあります。

これらの引数は、次の方法でメソッドコールに渡される引数に変換されます:

• グループ化されていない名前付き引数はすべて、それらが出現する場所に関係なく単一のディクショナリに結合され、最後のパラメータとしてメソッドに渡されます

• 中カッコ内にグループ化された名前付き引数は、単一のディクショナリに結合されます

• グループ化された名前付き引数によって生成された位置指定引数およびディクショナリは、コマンドラインに表示された順序で arguments リストに挿入されます

API インタフェースの例

API 統合を使用すると、--execute オプションを使用するよりも、MySQL Shell コマンドをコールする方が簡単で扱いにくくなります。次の例では、この機能の使用方法を示します:

• サーバーインスタンスがアップグレードに適していることを確認し、その後の処理のために結果を JSON として返すには:

$ mysqlsh -- util check-for-server-upgrade { --user=root --host=localhost --port=3301 } --password='password' --outputFormat=JSON --config-path=/etc/mysql/my.cnf