--mysqlx[=value]

このオプションは、起動時にサーバーが X プラグイン をロードする方法を制御します。 MySQL 8.0 では、X プラグイン はデフォルトで有効になっていますが、このオプションを使用してアクティブ化状態を制御できます。

セクション5.6.1「プラグインのインストールおよびアンインストール」で説明したように、オプションの値は、プラグインのロードオプションに指定可能な値のいずれかである必要があります。

mysqlx_bind_address

X プラグイン が TCP/IP 接続をリスニングするネットワークアドレス。 この変数は動的ではなく、起動時にのみ構成できます。 これは bind_address システム変数と同等の X プラグイン です。詳細は、その変数の説明を参照してください。

デフォルトでは、X プラグイン は、すべてのサーバーホスト IPv4 インタフェースで TCP/IP 接続を受け入れ、サーバーホストが IPv6 をサポートしている場合は、すべての IPv6 インタフェースで TCP/IP 接続を受け入れます。 mysqlx_bind_address が指定されている場合、その値は次の要件を満たす必要があります:

IP アドレスは、IPv4 または IPv6 アドレスとして指定できます。 ホスト名である値の場合、X プラグイン は名前を IP アドレスに解決し、そのアドレスにバインドします。 ホスト名が複数の IP アドレスに解決される場合、X プラグイン は最初の IPv4 アドレス (存在する場合) または最初の IPv6 アドレスを使用します。

X プラグイン では、様々なタイプのアドレスが次のように扱われます:

アドレスのネットワークネームスペースの指定には、次のルールが適用されます:

ネットワークネームスペースの詳細は、セクション5.1.14「ネットワークネームスペースのサポート」 を参照してください。

mysqlx_compression_algorithms

X プロトコル 接続で使用できる圧縮アルゴリズム。 デフォルトでは、Deflate、LZ4 および zstd アルゴリズムはすべて許可されています。 どのアルゴリズムも許可しないようにするには、許可するアルゴリズムのみを含むように mysqlx_compression_algorithms を設定します。 アルゴリズム名 deflate_stream、lz4_message および zstd_stream は任意の組合せで指定でき、順序と大/小文字は重要ではありません。 システム変数を空の文字列に設定した場合、圧縮アルゴリズムは許可されず、圧縮されていない接続のみが使用されます。 アルゴリズム固有のシステム変数を使用して、許可される各アルゴリズムのデフォルトおよび最大の圧縮レベルを調整します。 X プロトコル の接続圧縮と MySQL Server の同等の設定との関連の詳細は、セクション20.5.5「X プラグイン での接続圧縮」 を参照してください。

mysqlx_connect_timeout

新しく接続されたクライアントから最初のパケットが受信されるまで X プラグイン が待機する秒数。 これは connect_timeout と同等の X プラグイン です。詳細は、その変数の説明を参照してください。

mysqlx_deflate_default_compression_level

サーバーが X プロトコル 接続の Deflate アルゴリズムに使用するデフォルトの圧縮レベル。 レベルは、1 (最小圧縮作業) から 9 (最大作業) の整数で指定します。 このレベルは、クライアントが機能ネゴシエーション中に圧縮レベルをリクエストしない場合に使用されます。 このシステム変数を指定しない場合、サーバーはレベル 3 をデフォルトとして使用します。 詳細は、セクション20.5.5「X プラグイン での接続圧縮」を参照してください。

mysqlx_deflate_max_client_compression_level

サーバーが X プロトコル 接続の Deflate アルゴリズムに許可する最大圧縮レベル。 範囲は、このアルゴリズムのデフォルトの圧縮レベルと同じです。 クライアントがこれより高い圧縮レベルをリクエストした場合、サーバーはここで設定したレベルを使用します。 このシステム変数を指定しない場合、サーバーは最大圧縮レベルを 5 に設定します。

mysqlx_document_id_unique_prefix

ドキュメントがコレクションに追加されたときにサーバーによって生成されるドキュメント ID の最初の 4 バイトを設定します。 この変数をインスタンスごとに一意の値に設定することで、ドキュメント ID がインスタンス間で一意であることを確認できます。 Understanding Document IDsを参照してください。

mysqlx_enable_hello_notice

X プロトコル を介した接続を試行する クラシック MySQL プロトコル クライアントに送信されるメッセージを制御します。 有効にすると、サーバーの X プロトコル ポートに接続しようとする X プロトコル をサポートしていないクライアントは、間違ったプロトコルを使用していることを説明するエラーを受け取ります。

mysqlx_idle_worker_thread_timeout

アイドル状態のワーカースレッドが終了するまでの秒数。

mysqlx_interactive_timeout

対話型クライアントの mysqlx_wait_timeout セッション変数のデフォルト値。 (対話型クライアントがタイムアウトするまで待機する秒数。)

mysqlx_lz4_default_compression_level

サーバーが X プロトコル 接続の LZ4 アルゴリズムに使用するデフォルトの圧縮レベル。 レベルは、0 (最小圧縮作業) から 16 (最大作業) の整数で指定します。 このレベルは、クライアントが機能ネゴシエーション中に圧縮レベルをリクエストしない場合に使用されます。 このシステム変数を指定しない場合、サーバーはレベル 2 をデフォルトとして使用します。 詳細は、セクション20.5.5「X プラグイン での接続圧縮」を参照してください。

mysqlx_lz4_max_client_compression_level

サーバーが X プロトコル 接続で LZ4 アルゴリズムに対して許可する最大圧縮レベル。 範囲は、このアルゴリズムのデフォルトの圧縮レベルと同じです。 クライアントがこれより高い圧縮レベルをリクエストした場合、サーバーはここで設定したレベルを使用します。 このシステム変数を指定しない場合、サーバーは最大圧縮レベルを 8 に設定します。

mysqlx_max_allowed_packet

X プラグイン で受信できるネットワークパケットの最大サイズ。 この制限は、接続に圧縮が使用される場合にも適用されるため、メッセージが解凍された後は、ネットワークパケットをこのサイズより小さくする必要があります。 これは max_allowed_packet と同等の X プラグイン です。詳細は、その変数の説明を参照してください。

mysqlx_max_connections

X プラグイン が受け入れることができる同時クライアント接続の最大数。 これは max_connections と同等の X プラグイン です。詳細は、その変数の説明を参照してください。

この変数を変更する場合、新しい値が現在の接続数より小さいと、新しい接続に対してのみ新しい制限が考慮されます。

mysqlx_min_worker_threads

クライアントリクエストを処理するために X プラグイン で使用されるワーカースレッドの最小数。

mysqlx_port

X プラグイン が TCP/IP 接続をリスニングするネットワークポート。 これは port と同等の X プラグイン です。詳細は、その変数の説明を参照してください。

mysqlx_port_open_timeout

X プラグイン が TCP/IP ポートが解放されるまで待機する秒数。

mysqlx_read_timeout

X プラグイン が読取り操作のブロックの完了を待機する秒数。 この時間が経過すると、読取り操作が成功しない場合、X プラグイン は接続をクローズし、エラーコード ER_IO_READ_ERROR の警告通知をクライアントアプリケーションに返します。

mysqlx_socket

X プラグイン が接続に使用する Unix ソケットファイルへのパス。 この設定は、MySQL Server が Unix オペレーティングシステムで実行している場合にのみ使用されます。 クライアントはこのソケットを使用して、X プラグイン を使用して MySQL Server に接続できます。

デフォルトの mysqlx_socket パスおよびファイル名は、MySQL Server のメインソケットファイルのデフォルトパスおよびファイル名に基づいており、ファイル名に x が追加されています。 メインソケットファイルのデフォルトのパスとファイル名は/tmp/mysql.sock であるため、X プラグイン ソケットファイルのデフォルトのパスとファイル名は/tmp/mysqlx.sock です。

socket システム変数を使用して、サーバーの起動時にメインソケットファイルの代替パスとファイル名を指定した場合、これは X プラグイン ソケットファイルのデフォルトには影響しません。 この場合、両方のソケットを単一のパスに格納するには、mysqlx_socket システム変数も設定する必要があります。 たとえば、構成ファイルでは次のようになります:

socket=/home/sockets/mysqld/mysql.sock
mysqlx_socket=/home/sockets/xplugin/xplugin.sock

コンパイル時に MYSQL_UNIX_ADDR コンパイルオプションを使用してメインソケットファイルのデフォルトパスおよびファイル名を変更すると、MYSQL_UNIX_ADDR ファイル名に x を追加することによって形成される X プラグイン ソケットファイルのデフォルトに影響します。 コンパイル時に X プラグイン ソケットファイルに別のデフォルトを設定する場合は、MYSQLX_UNIX_ADDR コンパイルオプションを使用します。

MYSQLX_UNIX_PORT 環境変数を使用して、サーバーの起動時に X プラグイン ソケットファイルのデフォルトを設定することもできます (セクション4.9「環境変数」 を参照)。 この環境変数を設定すると、コンパイルされた MYSQLX_UNIX_ADDR 値はオーバーライドされますが、mysqlx_socket 値によってオーバーライドされます。

mysqlx_ssl_ca

mysqlx_ssl_ca システム変数は ssl_ca と似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。

mysqlx_ssl_capath

mysqlx_ssl_capath システム変数は ssl_capath と似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。

mysqlx_ssl_cert

mysqlx_ssl_cert システム変数は ssl_cert と似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。

mysqlx_ssl_cipher

mysqlx_ssl_cipher システム変数は ssl_cipher と似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。

mysqlx_ssl_crl

mysqlx_ssl_crl システム変数は ssl_crl と似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。

mysqlx_ssl_crlpath

mysqlx_ssl_crlpath システム変数は ssl_crlpath と似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。

mysqlx_ssl_key

mysqlx_ssl_key システム変数は ssl_key と似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。

mysqlx_wait_timeout

X プラグイン が接続のアクティビティを待機する秒数。 この時間が経過すると、読取り操作が成功しない場合、X プラグイン は接続をクローズします。 クライアントが非対話型の場合、セッション変数の初期値はグローバル mysqlx_wait_timeout 変数からコピーされます。 対話型クライアントの場合、初期値はセッション mysqlx_interactive_timeout からコピーされます。

mysqlx_write_timeout

X プラグイン が書込み操作のブロックの完了を待機する秒数。 この時間が経過すると、書込み操作が成功しない場合、X プラグイン は接続をクローズします。

mysqlx_zstd_default_compression_level

サーバーが X プロトコル 接続で zstd アルゴリズムに使用するデフォルトの圧縮レベル。 1.4.0 の zstd ライブラリのバージョンでは、正の値を 1 から 22 (最高の圧縮作業)、またはプログレッシブローエフォートを表す負の値に設定できます。 値 0 は値 1 に変換されます。 zstd ライブラリの以前のバージョンでは、値 3 のみを指定できます。 このレベルは、クライアントが機能ネゴシエーション中に圧縮レベルをリクエストしない場合に使用されます。 このシステム変数を指定しない場合、サーバーはレベル 3 をデフォルトとして使用します。 詳細は、セクション20.5.5「X プラグイン での接続圧縮」を参照してください。

mysqlx_zstd_max_client_compression_level

サーバーが X プロトコル 接続で zstd アルゴリズムに対して許可する最大圧縮レベル。 範囲は、このアルゴリズムのデフォルトの圧縮レベルと同じです。 クライアントがこれより高い圧縮レベルをリクエストした場合、サーバーはここで設定したレベルを使用します。 このシステム変数を指定しない場合、サーバーは最大圧縮レベルを 11 に設定します。