--help, -?

ヘルプメッセージを表示して終了します。

--

mysqlsh オプションのリストの最後と、MySQL ShellAPI コマンド行統合のためのコマンドとその引数の開始をマークします。 次の構文を使用して、コマンドラインから MySQL Shell グローバルオブジェクトのメソッドを実行できます:

mysqlsh [options]  -- object method [arguments]

詳しくはセクション5.8「API コマンドラインインタフェース」をご覧ください。

--auth-method=method

アカウントに使用する認証方式。 アカウントパスワードに使用される認証プラグインによって異なります。 クラシック MySQL プロトコル を使用した MySQL Shell 接続の場合は、caching_sha2_password などの認証プラグインの名前を指定します。 X プロトコル を使用する MySQL Shell 接続の場合は、次のいずれかのオプションを指定します:

--cluster

ターゲットサーバーが InnoDB クラスタの一部であることを確認し、その場合は cluster グローバル変数をクラスタオブジェクトに設定します。

--column-type-info

SQL モードでは、クエリーに対して返された結果セットを出力する前に、結果セット内の各カラムのメタデータ (カラムタイプや照合順序など) を出力します。

カラムタイプは、MySQL Shell (Type) で使用されるタイプと元のデータベース (DBType) で使用されるタイプの両方として返されます。 クラシック MySQL プロトコル を使用する MySQL Shell 接続の場合、DBType はプロトコルによって返され、X プロトコル 接続の場合、DBType は使用可能な情報から推測されます。 カラムの長さ (Length) はバイト単位で返されます。

--compress[={required|preferred|disabled}], -C [{required|preferred|disabled}]

この接続を使用してクライアントとサーバー間で送信される情報の圧縮を制御します。 8.0.19 を介した MySQL Shell 8.0.14 では、このオプションは クラシック MySQL プロトコル 接続にのみ使用でき、required、preferred および disabled オプションは使用しません。 これらのリリースでは、--compress を指定すると、可能であれば圧縮がアクティブ化されます。 MySQL Shell 8.0.20 からは、X プロトコル 接続にも使用でき、オプションで required、preferred または disabled を指定できます。 --compress のみが MySQL Shell 8.0.20 から指定されている場合、その意味は --compress=required です。 すべてのリリースでの MySQL Shell 圧縮制御の使用の詳細は、セクション4.3.4「圧縮接続の使用」 を参照してください。

--connect-timeout=ms

コマンドライン引数で指定されたグローバルセッションの確立を MySQL Shell が待機する時間 (ミリ秒) を構成します。

--credential-store-helper=helper

パスワードの格納および取得に使用されるシークレットストアヘルパー。 セクション4.4「プラガブルパスワードストア」を参照してください。

--database=name, -D name

使用するデフォルトスキーマ。 これは --schema のエイリアスです。

--dba=enableXProtocol

MySQL 5.7 サーバーとの接続で X プラグイン を有効にして、後続の接続に X プロトコル 接続を使用できるようにします。 クラシック MySQL プロトコル を使用した接続が必要です。 X プラグイン がデフォルトで有効になっている MySQL 8.0 サーバーには関係ありません。

--dba-log-sql[=0|1|2]

AdminAPI 操作によって実行される SQL ステートメントをログに記録します (サンドボックス操作を除く)。 デフォルトでは、--log-level および --verbose オプションが設定されている場合でも、このカテゴリのステートメントは MySQL Shell アプリケーションログファイルに書き込まれず、コンソールに冗長出力として送信されません。 オプションの値は 0 から 2 の範囲の整数です。0 はこのカテゴリのステートメントを記録または表示しません。これは、オプションを指定しない場合のデフォルトの動作です。1 は、SELECT ステートメントおよび SHOW ステートメントを除き、AdminAPI 操作によって実行される SQL ステートメントをログに記録します (これは、コマンドラインで値なしでオプションを指定した場合のデフォルト設定です)。2 は、通常の AdminAPI 操作によって実行される SQL ステートメントをすべてログに記録します。 詳しくは第9章「MySQL Shell のロギングおよびデバッグ」をご覧ください。

--dbpassword[=password]

MySQL Shell のバージョン 8.0.13 では非推奨です。 かわりに --password[=password]を使用してください。

--dbuser=user_name

MySQL Shell のバージョン 8.0.13 では非推奨です。 かわりに --user=user_name を使用してください。

--execute=command, -e command

現在アクティブな言語を使用してコマンドを実行し、終了します。 このオプションは、--file=file_name オプションと相互に排他的です。

--file=file_name, -f file_name

バッチモードで処理するファイルを指定します。 この後に指定したオプションは、処理済ファイルの引数として使用されます。

--force

エラーが発生した場合でも、SQL およびバッチモードで処理を続行します。

--histignore=strings

MySQL Shell 履歴に追加されない文字列を指定します。 文字列はコロンで区切られます。 照合では大文字と小文字は区別されず、ワイルドカード * および ? を使用できます。 無視されるデフォルトの文字列は、「*IDENTIFIED*:*PASSWORD*」 として指定されます。 セクション5.5「コード履歴」を参照してください。

--host=host_name, -h host_name

指定されたホストの MySQL サーバーに接続します。 Windows では、--host=. または -h . (ピリオドとしてホスト名を指定) を指定すると、MySQL Shell はデフォルトの名前付きパイプ (MySQL という名前) または --socket オプションを使用して指定した代替の名前付きパイプを使用して接続します。

--get-server-public-key

MySQL Shell は --get-server-public-key と同等です。

--server-public-key-path=file_name が指定され、有効な公開キーファイルが指定されている場合は、--get-server-public-key よりも優先されます。

SHA-2 プラガブル認証のキャッシュを参照してください。

--import

JSON インポートユーティリティを使用して、JSON ドキュメントをファイルまたは標準入力から MySQL Server コレクションまたはリレーショナルテーブルにインポートします。 その手順は、セクション8.2「JSON インポートユーティリティ」を参照してください。

--interactive[=full], -i

バッチモードで対話モードをエミュレートします。

--js, --javascript

JavaScript モードで起動します。

--json[={off|pretty|raw}]

このセッションからの MySQL Shell 出力の JSON ラッピングを制御します。 このオプションは、テストの一環としてなど、MySQL Shell を他のプログラムとインタフェースするためのものです。 JSON 形式を使用するようにクエリー結果の出力を変更するには、--result-format を参照してください。

--json オプションに値または pretty の値がない場合、出力は整形出力 JSON として生成されます。 値が raw の場合、出力は RAW JSON 形式で生成されます。 いずれの場合も、--result-format オプションとそのエイリアス、および resultFormat MySQL Shell 構成オプションの値は無視されます。 値が off の場合、JSON ラッピングは実行されず、結果セットは --result-format オプションまたは resultFormat 構成オプションで指定された形式で通常どおり出力されます。

--log-level=N

MySQL Shell アプリケーションログファイルのロギングレベルを変更するか、ファイルへのロギングを無効にします。 このオプションには、1 から 8 の範囲の整数、none, internal, error, warning, info, debug, debug2 または debug3 のいずれかの値が必要です。 1 または none を指定すると、アプリケーションログファイルへのロギングが無効になります。 このオプションを指定しない場合、レベル 5 (info) がデフォルトです。 第9章「MySQL Shell のロギングおよびデバッグ」を参照してください。

-ma

MySQL Shell のバージョン 8.0.13 では非推奨です。 X プロトコル を使用してセッション接続を自動的に作成し、X プロトコル が使用できない場合は クラシック MySQL プロトコル にフォールバックします。

--mysql, --mc

クラシック MySQL プロトコル 接続を使用するように、起動時に作成されるグローバルセッションを設定します。 --mc オプションは、MySQL Shell 8.0.13 の以前の単一ハイフンの -mc オプションに置き換わります。

--mysqlx, --mx

X プロトコル 接続を使用するために起動時に作成されるグローバルセッションを設定します。 --mx オプションは、MySQL Shell 8.0.13 の以前の単一ハイフンの -mx オプションに置き換わります。

--name-cache

アクティブなデフォルトスキーマに基づいたテーブル名の自動ロードを有効にします。

--no-name-cache, -A

アクティブなデフォルトスキーマおよび DevAPI db オブジェクトに基づいて、自動補完のためのテーブル名のロードを無効にします。 \rehash を使用して、名前情報を手動でリロードします。

--no-password

サーバーへの接続時に、ユーザーがパスワードなしのアカウントを持っている場合 (セキュアではなく推奨されない)、またはソケットピア資格証明認証が使用されている場合 (Unix ソケット接続の場合)、--no-password を使用してパスワードが指定されず、パスワードプロンプトが不要であることを明示的に指定する必要があります。

--no-wizard, -nw

接続、dba.configureInstance()、Cluster.rebootClusterFromCompleteOutage() などの操作によって提供される対話型ウィザードを無効にします。 このオプションは、MySQL Shell をスクリプト化し、対話型プロンプトを表示しない場合に使用します。 詳細は、セクション5.6「バッチコード実行」 および セクション5.8「API コマンドラインインタフェース」 を参照してください。

--pager=name

MySQL Shell で使用される外部ページャツール。SQL モードで実行されるステートメントおよびオンラインヘルプなどの選択された他のコマンドのテキスト出力を表示します。 ページャを設定しない場合は、PAGER 環境変数で指定されたページャが使用されます。 セクション4.6「ページャの使用」を参照してください。

--passwords-from-stdin

端末からではなく標準入力からパスワードを読み取ります。 このオプションは、パスワードプロンプトなどの他のパスワードの動作には影響しません。

--password[=password], -ppassword

サーバーに接続する際に使用するパスワードです。 MySQL Shell への接続に使用できるパスワードの最大長は 128 文字です。

--port=port_num, -P port_num

接続に使用する TCP/IP ポート番号。 デフォルトはポート 33060 です。

--py, --python

Python モードで起動します。

--pym

指定した Python モジュールを MySQL ShellPython モードでスクリプトとして実行します。--pym は、Python -m コマンドラインオプションと同じ方法で動作します。 このオプションは、MySQL Shell 8.0.22 から使用できます。

--quiet-start[=1|2]

紹介情報を印刷せずに開始します。MySQL Shell は通常、製品に関する情報、セッションに関する情報 (デフォルトのスキーマや接続 ID など)、警告メッセージ、および起動時と接続時に返されるエラーを出力します。 --quiet-start を値なしまたは値 1 で指定すると、MySQL Shell 製品に関する情報は出力されませんが、セッション情報、警告およびエラーが出力されます。 値が 2 の場合、エラーのみが出力されます。

--recreate-schema

URI のような接続文字列の一部として、または --schema、--database または -D オプションを使用して、接続オプションで指定されたスキーマを削除して再作成します。 スキーマが存在する場合は削除されます。

--redirect-primary

ターゲットサーバーが InnoDB クラスタ または InnoDB ReplicaSet の一部であることを確認し、プライマリでない場合はプライマリを検索して接続します。このオプションの使用時に次のいずれかに該当する場合、MySQL Shell はエラーで終了します:

--replicaset

ターゲットサーバーが InnoDB ReplicaSet に属していることを確認し、属している場合は、rs グローバル変数に InnoDB ReplicaSet を移入します。 その後、rs.status() を発行するなどして、rs グローバル変数を使用して InnoDB ReplicaSet を管理できます。

--redirect-secondary

ターゲットサーバーが単一プライマリ InnoDB クラスタまたは InnoDB ReplicaSet の一部であることを確認し、セカンダリでない場合はセカンダリを検索して接続します。このオプションの使用時に次のいずれかに該当する場合、MySQL Shell はエラーで終了します:

--result-format={table|tabbed|vertical|json|json/pretty|ndjson|json/raw|json/array}

このセッションの resultFormat MySQL Shell 構成オプションの値を設定します。 形式は次のとおりです:

--json コマンドラインオプションを使用してセッションの出力の JSON ラッピングをアクティブ化する場合、--result-format オプションとそのエイリアス、および resultFormat 構成オプションの値は無視されます。

--save-passwords={always|prompt|never}

パスワードを自動的にシークレットストアに格納するかどうかを制御します。always は、パスワードがストアにすでに存在する場合、またはサーバー URL がフィルタによって除外されている場合を除き、パスワードが常に格納されることを意味します。never は、パスワードが格納されないことを意味します。prompt(デフォルト) は、ユーザーがパスワードを格納するかどうかを尋ねられることを意味します。 セクション4.4「プラガブルパスワードストア」を参照してください。

--schema=name, -D name

使用するデフォルトスキーマ。

--server-public-key-path=file_name

MySQL Shell は --server-public-key-path と同等です。

--server-public-key-path=file_name が指定され、有効な公開キーファイルが指定されている場合は、--get-server-public-key よりも優先されます。

caching_sha2_password plugin SHA-2 プラガブル認証のキャッシュ を参照してください。

--show-warnings={true|false}

true(デフォルト) が SQL モードで指定されている場合、MySQL Shell では各 SQL ステートメントの後に警告が表示されます (存在する場合)。 false を指定した場合、警告は表示されません。

--socket[=path], -S [path]

Unix では、パスが指定されている場合、パスは接続に使用する Unix ソケットファイルの名前です。 値なしで等号なしで --socket を指定した場合、または値なしで -S を指定した場合は、適切なプロトコルのデフォルトの Unix ソケットファイルが使用されます。

Windows の場合、パスは接続に使用する名前付きパイプの名前です。 パイプ名では大文字と小文字は区別されません。 Windows では、パスを指定する必要があり、--socket オプションは クラシック MySQL プロトコル セッションでのみ使用できます。

Unix では localhost 以外のポートまたはホスト名を指定し、Windows ではピリオド (.) を指定した場合は、ソケットを指定できません。

--sql

SQL モードで開始し、接続情報の一部として指定されていない場合に使用するプロトコルを自動検出します。 使用するプロトコルが指定されていない場合、デフォルトで X プロトコル 接続に設定され、クラシック MySQL プロトコル 接続に戻ります。 接続で特定のプロトコルを強制的に使用するには、--sqlx または --sqlc のオプションを参照してください。 または、URI のような接続文字列の一部として使用するプロトコルを指定するか、--port オプションを使用します。 詳細は、セクション4.3「MySQL Shell 接続」 および「MySQL Shell ポートリファレンス」を参照してください。

--sqlc

たとえば、X プロトコル をサポートしていないサーバーで MySQL Shell を使用するために、クラシック MySQL プロトコル を使用するように接続を強制する SQL モードで起動します。 接続の一部としてポートを指定しない場合、このオプションを指定すると、MySQL Shell はデフォルトの クラシック MySQL プロトコル ポート (通常 3306) を使用します。 接続先のポートは クラシック MySQL プロトコル をサポートしている必要があるため、たとえば、指定する接続で X プロトコル のデフォルトポート 33060 が使用されている場合、接続はエラーで失敗します。 詳細は、セクション4.3「MySQL Shell 接続」 および「MySQL Shell ポートリファレンス」を参照してください。

--sqlx

SQL モードで起動し、X プロトコル を使用するように接続を強制します。 接続の一部としてポートを指定しない場合、このオプションを指定すると、MySQL Shell はデフォルトの X プロトコル ポート (通常 33060) を使用します。 接続先のポートは X プロトコル をサポートする必要があるため、たとえば、指定した接続で クラシック MySQL プロトコル のデフォルトポート 3306 が使用されている場合、接続はエラーで失敗します。 詳細は、セクション4.3「MySQL Shell 接続」 および「MySQL Shell ポートリファレンス」を参照してください。

--ssl*

--ssl で始まるオプションは、SSL を使用してサーバーに接続することを許可するかどうかを指定し、SSL 鍵および証明書を検索する場所を指定します。 mysqlsh の SSL オプションは、MySQL Server の SSL オプションと同じように機能します。詳細は、暗号化接続のコマンドオプション を参照してください。

mysqlsh は、次の SSL オプションを受け入れます: --ssl-mode, --ssl-ca, --ssl-capath, --ssl-cert, --ssl-cipher, --ssl-crl, --ssl-crlpath, --ssl-key, --tls-version。

--tabbed

対話モードで結果をタブ区切り形式で表示します。 そのモードのデフォルトはテーブル形式です。 このオプションは、--result-format=tabbed オプションのエイリアスです。

--table

バッチモードで結果をテーブル形式で表示します。 そのモードのデフォルトはタブ区切り形式です。 このオプションは、--result-format=table オプションのエイリアスです。

--uri=str

起動時に接続を作成し、URI 類似文字列またはキーと値のペアを使用したサーバーへの接続 で説明されている URI のような文字列に接続オプションを指定します。

--user=user_name, -u user_name

サーバーへの接続時に使用する MySQL ユーザー名。

--verbose[=0|1|2|3|4]

コンソールへの詳細出力をアクティブ化し、詳細のレベルを指定します。 値は 0 から 4 の範囲の整数です。0 はメッセージを表示しません。これは、オプションを指定しない場合のデフォルトの冗長性設定です。1 は、エラー、警告および情報メッセージを表示します (これは、値を指定せずにコマンドラインでオプションを指定した場合のデフォルト設定です)。2、3 および 4 は、より高いレベルのデバッグメッセージを追加します。 詳しくは第9章「MySQL Shell のロギングおよびデバッグ」をご覧ください。

--version, -V

MySQL Shell のバージョンを表示して終了します。

--vertical, -E

\G ターミネータが SQL クエリーに使用されている場合と同様に、結果を垂直に表示します。 このオプションは、--result-format=vertical オプションのエイリアスです。