--help, -?

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

--auto-generate-sql, -a

SQL ステートメントがファイルおよびコマンドオプションを使用して指定されない場合、自動的に生成します。

--auto-generate-sql-add-autoincrement

AUTO_INCREMENT カラムを自動生成されたテーブルに追加します。

--auto-generate-sql-execute-number=N

自動的に生成するクエリーの数を指定します。

--auto-generate-sql-guid-primary

自動生成されたテーブルに GUID ベースの主キーを追加します。

--auto-generate-sql-load-type=type

テストの負荷タイプを指定します。 許可される値は、read (テーブルのスキャン)、write (テーブルに挿入)、key (主キーの読み取り)、update (主キーの更新)、または mixed (挿入とスキャンして選択が半分ずつ) です。 デフォルトは mixed です。

--auto-generate-sql-secondary-indexes=N

自動生成されたテーブルに追加するセカンダリインデックスの数を指定します。 デフォルトでは、何も追加されません。

--auto-generate-sql-unique-query-number=N

自動テスト用に生成する異なるクエリーの数。 たとえば、1000 回の選択を行う key テストを実施する場合、このオプションの値を 1000 にして一意のクエリーを 1000 個実行することも、値を 50 にして異なるクエリーを 50 回行うこともできます。 デフォルトは 10 です。

--auto-generate-sql-unique-write-number=N

--auto-generate-sql-write-number 用に生成する異なるクエリーの数を指定します。 デフォルトは 10 です。

--auto-generate-sql-write-number=N

実行する行挿入の数。 デフォルトは 100 です。

--commit=N

コミットの前に実行するステートメントの数。 デフォルトは 0 (コミットは行われない) です。

--compress, -C

可能であれば、クライアントとサーバーの間で送信されるすべての情報を圧縮します。 セクション4.2.8「接続圧縮制御」を参照してください。

MySQL 8.0.18 では、このオプションは非推奨です。 MySQL の将来のバージョンで削除されることが予想されます。 レガシー接続圧縮の構成を参照してください。

--compression-algorithms=value

サーバーへの接続に許可される圧縮アルゴリズム。 使用可能なアルゴリズムは、protocol_compression_algorithms システム変数の場合と同じです。 デフォルト値は uncompressed です。

詳細は、セクション4.2.8「接続圧縮制御」を参照してください。

このオプションは MySQL 8.0.18 で追加されました。

--concurrency=N, -c N

シミュレートするパラレルクライアントの数。

--create=value

テーブルの作成に使用するステートメントを含むファイルまたは文字列。

--create-schema=value

テストを実行するスキーマ。

--csv[=file_name]

カンマ区切りの値の形式で出力を生成します。 出力は指定されたファイルか、ファイルが指定されていない場合標準出力に送られます。

--debug[=debug_options], -# [debug_options]

デバッグのログを書き込みます。 一般的な debug_options 文字列は d:t:o,file_name です。 デフォルトは d:t:o,/tmp/mysqlslap.trace です。

このオプションは、MySQL が WITH_DEBUG を使用して構築された場合にのみ使用できます。 Oracle によって提供される MySQL リリースバイナリは、このオプションを使用して構築されません。

--debug-check

プログラムの終了時に、デバッグ情報を出力します。

このオプションは、MySQL が WITH_DEBUG を使用して構築された場合にのみ使用できます。 Oracle によって提供される MySQL リリースバイナリは、このオプションを使用して構築されません。

--debug-info, -T

プログラムの終了時に、デバッグ情報とメモリーおよび CPU 使用率の統計を出力します。

このオプションは、MySQL が WITH_DEBUG を使用して構築された場合にのみ使用できます。 Oracle によって提供される MySQL リリースバイナリは、このオプションを使用して構築されません。

--default-auth=plugin

使用するクライアント側認証プラグインに関するヒント。 セクション6.2.17「プラガブル認証」を参照してください。

--defaults-extra-file=file_name

このオプションファイルは、グローバルオプションファイルのあとに読み取りますが、(UNIX では) ユーザーオプションファイルの前に読み取るようにしてください。 ファイルが存在しないかアクセスできない場合、エラーが発生します。file_name は、フルパス名でなく相対パス名として指定された場合、現行ディレクトリを基準にして解釈されます。

このオプションおよびその他のオプションファイルオプションの詳細は、セクション4.2.2.3「オプションファイルの処理に影響するコマンド行オプション」 を参照してください。

--defaults-file=file_name

指定されたオプションファイルのみ使用します。 ファイルが存在しないかアクセスできない場合、エラーが発生します。file_name は、フルパス名でなく相対パス名として指定された場合、現行ディレクトリを基準にして解釈されます。

例外: --defaults-file でも、クライアントプログラムは .mylogin.cnf を読み取ります。

このオプションおよびその他のオプションファイルオプションの詳細は、セクション4.2.2.3「オプションファイルの処理に影響するコマンド行オプション」 を参照してください。

--defaults-group-suffix=str

通常のオプショングループだけでなく、通常の名前に str のサフィクスが付いたグループも読み取ります。 たとえば、mysqlslap は通常 [client] グループおよび [mysqlslap] グループを読み取ります。 --defaults-group-suffix=_other オプションを指定した場合、mysqlslap は [client_other] グループおよび [mysqlslap_other] グループも読み取ります。

このオプションおよびその他のオプションファイルオプションの詳細は、セクション4.2.2.3「オプションファイルの処理に影響するコマンド行オプション」 を参照してください。

--delimiter=str, -F str

ファイルまたはコマンドオプションを使用して提供される SQL ステートメントで使用される区切り文字。

--detach=N

N 個のステートメントごとに各接続を切り離します (閉じてからふたたび開きます)。 デフォルトは 0 (接続は切り離されない) です。

--enable-cleartext-plugin

mysql_clear_password 平文認証プラグインを有効にします。 (セクション6.4.1.4「クライアント側クリアテキストプラガブル認証」を参照してください。)

--engine=engine_name, -e engine_name

テーブルの作成に使用するストレージエンジンを指定します。

--get-server-public-key

キーペアベースのパスワード交換に使用する RSA 公開キーをサーバーにリクエストします。 このオプションは、caching_sha2_password 認証プラグインで認証されるアカウントを使用してサーバーに接続するクライアントに適用されます。 このようなアカウントによる接続の場合、サーバーは要求されないかぎり公開鍵をクライアントに送信しません。 このオプションは、そのプラグインで認証されないアカウントでは無視されます。 クライアントがセキュアな接続を使用してサーバーに接続する場合と同様に、RSA ベースのパスワード交換が不要な場合も無視されます。

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

caching_sha2_password プラグインの詳細は、セクション6.4.1.2「SHA-2 プラガブル認証のキャッシュ」 を参照してください。

--host=host_name, -h host_name

指定されたホストの MySQL サーバーに接続します。

--iterations=N, -i N

実行するテストの回数。

--login-path=name

.mylogin.cnf ログインパスファイルの指定されたログインパスからオプションを読み取ります。 「「ログインパス」」は、接続先の MySQL サーバーおよび認証に使用するアカウントを指定するオプションを含むオプショングループです。 ログインパスファイルを作成または変更するには、mysql_config_editor ユーティリティを使用します。 セクション4.6.7「mysql_config_editor — MySQL 構成ユーティリティー」を参照してください。

このオプションおよびその他のオプションファイルオプションの詳細は、セクション4.2.2.3「オプションファイルの処理に影響するコマンド行オプション」 を参照してください。

--no-drop

mysqlslap がテスト実行中に作成するスキーマをドロップしないようにします。

--no-defaults

オプションファイルを読み取りません。 オプションファイルから不明のオプションを読み取ることが原因でプログラムの起動に失敗する場合、--no-defaults を使用して、オプションを読み取らないようにできます。

例外として、.mylogin.cnf ファイルは、存在する場合はすべての場合に読み取られます。 これにより、--no-defaults が使用された場合にも、コマンド行よりも安全な方法でパスワードを指定できます。(.mylogin.cnf は mysql_config_editor ユーティリティーによって作成されます。 セクション4.6.7「mysql_config_editor — MySQL 構成ユーティリティー」を参照してください)。

このオプションおよびその他のオプションファイルオプションの詳細は、セクション4.2.2.3「オプションファイルの処理に影響するコマンド行オプション」 を参照してください。

--number-char-cols=N, -x N

--auto-generate-sql が指定されている場合に使用する VARCHAR カラムの数。

--number-int-cols=N, -y N

--auto-generate-sql が指定されている場合に使用する INT カラムの数。

--number-of-queries=N

各クライアントのクエリー数をおよそこの数に制限します。 クエリーのカウントには、ステートメント区切り文字が考慮されます。 たとえば、mysqlslap を次のように起動する場合、; 区切り文字が認識され、クエリー文字列の各インスタンスは 2 つのクエリーとカウントされます。 その結果、(10 ではなく) 5 つの行が挿入されます。

shell> mysqlslap --delimiter=";" --number-of-queries=10
         --query="use test;insert into t values(null)"

--only-print

データベースには接続しません。mysqlslap は、実行したであろう内容を出力するだけです。

--password[=password], -p[password]

サーバーへの接続に使用される MySQL アカウントのパスワード。 パスワード値はオプションです。 指定しない場合、mysqlslap によってプロンプトが表示されます。 指定する場合は、--password= または -p とそれに続くパスワードの間にスペースなしが存在する必要があります。 パスワードオプションを指定しない場合、デフォルトではパスワードは送信されません。

コマンド行でのパスワード指定は、セキュアでないと考えるべきです。 コマンド行でパスワードを指定しないようにするには、オプションファイルを使用します。 セクション6.1.2.1「パスワードセキュリティーのためのエンドユーザーガイドライン」を参照してください。

パスワードがなく、mysqlslap でパスワードの入力を求められないように明示的に指定するには、--skip-password オプションを使用します。

--pipe, -W

Windows で、名前付きパイプを使用してサーバーに接続します。 このオプションは、ネームパイプ接続をサポートするために named_pipe システム変数を有効にしてサーバーを起動した場合にのみ適用されます。 また、接続を行うユーザーは、named_pipe_full_access_group システム変数で指定された Windows グループのメンバーである必要があります。

--plugin-dir=dir_name

プラグインを検索するディレクトリ。 このオプションは、--default-auth オプションを使用して認証プラグインを指定しても、mysqlslap がそれを検出しない場合に指定します。 セクション6.2.17「プラガブル認証」を参照してください。

--port=port_num, -P port_num

TCP/IP 接続の場合、使用するポート番号。

--post-query=value

テスト完了後に実行するステートメントを含むファイルまたは文字列。 この実行は、タイミングの目的ではカウントされません。

--post-system=str

テスト完了後に system() を使用して実行する文字列。 この実行は、タイミングの目的ではカウントされません。

--pre-query=value

テストの実行前に実行するステートメントを含むファイルまたは文字列。 この実行は、タイミングの目的ではカウントされません。

--pre-system=str

テストの実行前に system() を使用して実行する文字列。 この実行は、タイミングの目的ではカウントされません。

--print-defaults

プログラム名と、オプションファイルから受け取るすべてのオプションを出力します。

このオプションおよびその他のオプションファイルオプションの詳細は、セクション4.2.2.3「オプションファイルの処理に影響するコマンド行オプション」 を参照してください。

--protocol={TCP|SOCKET|PIPE|MEMORY}

サーバーへの接続に使用するトランスポートプロトコル。 これは、他の接続パラメータが通常、必要なプロトコル以外のプロトコルを使用する場合に便利です。 許可される値の詳細は、セクション4.2.7「接続トランスポートプロトコル」を参照してください。

--query=value, -q value

データ取得のため使用する SELECT ステートメントを含むファイルまたは文字列。

--server-public-key-path=file_name

RSA キーペアベースのパスワード交換のためにサーバーが必要とする公開キーのクライアント側コピーを含む、PEM 形式のファイルへのパス名。 このオプションは、sha256_password または caching_sha2_password 認証プラグインで認証されるクライアントに適用されます。 これらのプラグインのいずれかで認証されないアカウントでは、このオプションは無視されます。 クライアントがセキュアな接続を使用してサーバーに接続する場合と同様に、RSA ベースのパスワード交換を使用しない場合も無視されます。

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

sha256_password の場合、このオプションは、MySQL が OpenSSL を使用して構築された場合にのみ適用されます。

sha256_password および caching_sha2_password プラグインの詳細は、セクション6.4.1.3「SHA-256 プラガブル認証」 および セクション6.4.1.2「SHA-2 プラガブル認証のキャッシュ」 を参照してください。

--shared-memory-base-name=name

Windows の場合、共有メモリを使用してローカルサーバに接続するために使用する共有メモリ名。 デフォルト値は MYSQL です。 共有メモリー名では大文字と小文字が区別されます。

このオプションは、共有メモリー接続をサポートするために shared_memory システム変数を有効にしてサーバーを起動した場合にのみ適用されます。

--silent, -s

サイレントモード。 出力はありません。

--socket=path, -S path

localhost への接続用に使用する、Unix ソケットファイル、または Windows では使用する名前付きパイプの名前。

Windows では、このオプションは、名前付きパイプ接続をサポートするために named_pipe システム変数を有効にしてサーバーを起動した場合にのみ適用されます。 また、接続を行うユーザーは、named_pipe_full_access_group システム変数で指定された Windows グループのメンバーである必要があります。

--sql-mode=mode

クライアントセッションの SQL モードを設定します。

--ssl*

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

--ssl-fips-mode={OFF|ON|STRICT}

クライアント側で FIPS モードを有効にするかどうかを制御します。 --ssl-fips-mode オプションは、暗号化された接続の確立には使用されず、許可する暗号化操作に影響する点で、他の --ssl-xxx オプションとは異なります。 セクション6.8「FIPS のサポート」を参照してください。

次の --ssl-fips-mode 値を使用できます:

--tls-ciphersuites=ciphersuite_list

TLSv1.3 を使用する暗号化された接続に許可される暗号スイート。 値は、コロンで区切られた 1 つ以上の暗号スイート名のリストです。 このオプションに指定できる暗号スイートは、MySQL のコンパイルに使用される SSL ライブラリによって異なります。 詳細は、セクション6.3.2「暗号化された接続 TLS プロトコルおよび暗号」を参照してください。

このオプションは MySQL 8.0.16 で追加されました。

--tls-version=protocol_list

暗号化された接続に許可される TLS プロトコル。 値は、1 つまたは複数のコンマ区切りプロトコル名のリストです。 このオプションに指定できるプロトコルは、MySQL のコンパイルに使用される SSL ライブラリによって異なります。 詳細は、セクション6.3.2「暗号化された接続 TLS プロトコルおよび暗号」を参照してください。

--user=user_name, -u user_name

サーバーへの接続に使用する MySQL アカウントのユーザー名。

--verbose, -v

冗長モード。 プログラムの動作についてより多くの情報を出力します。 このオプションは情報量を増加させるために複数回使用できます。

--version, -V

バージョン情報を表示して終了します。

--zstd-compression-level=level

zstd 圧縮アルゴリズムを使用するサーバーへの接続に使用する圧縮レベル。 許可されるレベルは 1 から 22 で、大きい値は圧縮レベルの増加を示します。 デフォルトの zstd 圧縮レベルは 3 です。 圧縮レベルの設定は、zstd 圧縮を使用しない接続には影響しません。

詳細は、セクション4.2.8「接続圧縮制御」を参照してください。

このオプションは MySQL 8.0.18 で追加されました。