X プラグイン のアクティブ化を制御するには、このオプションを使用します:
-
コマンド行形式 --mysqlx[=value]型 列挙 デフォルト値 ON有効な値 ONOFFFORCEFORCE_PLUS_PERMANENTこのオプションは、起動時にサーバーが X プラグイン をロードする方法を制御します。 MySQL 8.0 では、X プラグイン はデフォルトで有効になっていますが、このオプションを使用してアクティブ化状態を制御できます。
セクション5.6.1「プラグインのインストールおよびアンインストール」で説明したように、オプションの値は、プラグインのロードオプションに指定可能な値のいずれかである必要があります。
X プラグイン が有効になっている場合、操作を制御できるいくつかのシステム変数が公開されます:
-
コマンド行形式 --mysqlx-bind-address=addrシステム変数 mysqlx_bind_addressスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 文字列 デフォルト値 *X プラグイン が TCP/IP 接続をリスニングするネットワークアドレス。 この変数は動的ではなく、起動時にのみ構成できます。 これは
bind_addressシステム変数と同等の X プラグイン です。詳細は、その変数の説明を参照してください。デフォルトでは、X プラグイン は、すべてのサーバーホスト IPv4 インタフェースで TCP/IP 接続を受け入れ、サーバーホストが IPv6 をサポートしている場合は、すべての IPv6 インタフェースで TCP/IP 接続を受け入れます。
mysqlx_bind_addressが指定されている場合、その値は次の要件を満たす必要があります:MySQL 8.0.21 より前では、
mysqlx_bind_addressは、単一の非ワイルドカード IP アドレス (IPv4 または IPv6)、ホスト名、または複数のネットワークインタフェースでのリスニングを許可するワイルドカードアドレス形式 (*、0.0.0.0または::) を受け入れます。MySQL 8.0.21 では、
mysqlx_bind_addressは前述の単一の値またはカンマ区切り値のリストを受け入れます。 変数が複数の値のリストを指定する場合、各値は単一のワイルドカード以外の IP アドレス (IPv4 または IPv6) またはホスト名を指定する必要があります。 ワイルドカードアドレス書式 (*、0.0.0.0または::) は、値リストでは使用できません。MySQL 8.0.22 の時点では、値にネットワークネームスペース指定子が含まれる場合があります。
IP アドレスは、IPv4 または IPv6 アドレスとして指定できます。 ホスト名である値の場合、X プラグイン は名前を IP アドレスに解決し、そのアドレスにバインドします。 ホスト名が複数の IP アドレスに解決される場合、X プラグイン は最初の IPv4 アドレス (存在する場合) または最初の IPv6 アドレスを使用します。
X プラグイン では、様々なタイプのアドレスが次のように扱われます:
アドレスが
*の場合、X プラグイン はすべてのサーバーホスト IPv4 インタフェースで TCP/IP 接続を受け入れ、サーバーホストが IPv6 をサポートしている場合は、すべての IPv6 インタフェースで TCP/IP 接続を受け入れます。 このアドレスを使用して、X プラグイン の IPv4 接続と IPv6 接続の両方を許可します。 この値がデフォルトです。 変数で複数の値のリストが指定されている場合、この値は許可されません。アドレスが
0.0.0.0の場合、X プラグイン はすべてのサーバーホスト IPv4 インタフェースで TCP/IP 接続を受け入れます。 変数で複数の値のリストが指定されている場合、この値は許可されません。アドレスが
::の場合、X プラグイン はすべてのサーバーホスト IPv4 および IPv6 インタフェースで TCP/IP 接続を受け入れます。 変数で複数の値のリストが指定されている場合、この値は許可されません。アドレスが IPv4 マップアドレスの場合、X プラグイン はそのアドレスの TCP/IP 接続を IPv4 または IPv6 形式で受け入れます。 たとえば、X プラグイン が
::ffff:127.0.0.1にバインドされている場合、MySQL Shell などのクライアントは--host=127.0.0.1または--host=::ffff:127.0.0.1を使用して接続できます。アドレスが 「regular」 IPv4 アドレスまたは IPv6 アドレス (
127.0.0.1、::1など) の場合、X プラグイン はその IPv4 アドレスまたは IPv6 アドレスに対してのみ TCP/IP 接続を受け入れます。
アドレスのネットワークネームスペースの指定には、次のルールが適用されます:
ネットワークネームスペースは、IP アドレスまたはホスト名に指定できます。
ワイルドカード IP アドレスにはネットワークネームスペースを指定できません。
指定されたアドレスでは、ネットワーク名前空間はオプションです。 指定する場合は、アドレスの直後に
/接尾辞として指定する必要があります。ns/接尾辞のないアドレスは、ホストシステムのグローバルネームスペースを使用します。 したがって、グローバルネームスペースがデフォルトです。ns/接尾辞の付いたアドレスは、nsnsという名前のネームスペースを使用します。ホストシステムはネットワークネームスペースをサポートしている必要があり、各名前付きネームスペースは事前に設定されている必要があります。 存在しないネームスペースに名前を付けると、エラーが発生します。
変数値に複数のアドレスが指定されている場合は、グローバルネームスペース、名前付きネームスペースまたはその組合せにアドレスを含めることができます。
ネットワークネームスペースの詳細は、セクション5.1.14「ネットワークネームスペースのサポート」 を参照してください。
重要X プラグイン は必須プラグインではないため、指定されたアドレスまたはアドレスリストにエラーがある場合、サーバーの起動は妨げられません (MySQL Server が
bind_addressエラーの場合と同様)。 X プラグイン では、リストされたアドレスのいずれかを解析できない場合、または X プラグイン がアドレスにバインドできない場合、アドレスはスキップされ、エラーメッセージがログに記録され、X プラグイン は残りの各アドレスへのバインドを試行します。X プラグインMysqlx_addressステータス変数には、バインドが成功したアドレスのみがリストに表示されます。 リストされたアドレスのいずれもバインドに成功しなかった場合、または単一の指定されたアドレスで障害が発生した場合、X プラグイン は X プロトコル を使用できないことを示すエラーメッセージ ER_XPLUGIN_FAILED_TO_PREPARE_IO_INTERFACES をログに記録します。mysqlx_bind_addressは動的ではないため、問題を修正するには、サーバーを停止し、システム変数値を修正してサーバーを再起動する必要があります。 -
コマンド行形式 --mysqlx-compression-algorithms=value導入 8.0.19 システム変数 mysqlx_compression_algorithmsスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Set デフォルト値 deflate_stream,lz4_message,zstd_stream有効な値 deflate_streamlz4_messagezstd_streamX プロトコル 接続で使用できる圧縮アルゴリズム。 デフォルトでは、Deflate、LZ4 および zstd アルゴリズムはすべて許可されています。 どのアルゴリズムも許可しないようにするには、許可するアルゴリズムのみを含むように
mysqlx_compression_algorithmsを設定します。 アルゴリズム名deflate_stream、lz4_messageおよびzstd_streamは任意の組合せで指定でき、順序と大/小文字は重要ではありません。 システム変数を空の文字列に設定した場合、圧縮アルゴリズムは許可されず、圧縮されていない接続のみが使用されます。 アルゴリズム固有のシステム変数を使用して、許可される各アルゴリズムのデフォルトおよび最大の圧縮レベルを調整します。 X プロトコル の接続圧縮と MySQL Server の同等の設定との関連の詳細は、セクション20.5.5「X プラグイン での接続圧縮」 を参照してください。 -
コマンド行形式 --mysqlx-connect-timeout=#システム変数 mysqlx_connect_timeoutスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 30最小値 1最大値 1000000000新しく接続されたクライアントから最初のパケットが受信されるまで X プラグイン が待機する秒数。 これは
connect_timeoutと同等の X プラグイン です。詳細は、その変数の説明を参照してください。 -
mysqlx_deflate_default_compression_levelコマンド行形式 --mysqlx_deflate_default_compression_level=#導入 8.0.20 システム変数 mysqlx_deflate_default_compression_levelスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 3最小値 1最大値 9サーバーが X プロトコル 接続の Deflate アルゴリズムに使用するデフォルトの圧縮レベル。 レベルは、1 (最小圧縮作業) から 9 (最大作業) の整数で指定します。 このレベルは、クライアントが機能ネゴシエーション中に圧縮レベルをリクエストしない場合に使用されます。 このシステム変数を指定しない場合、サーバーはレベル 3 をデフォルトとして使用します。 詳細は、セクション20.5.5「X プラグイン での接続圧縮」を参照してください。
-
mysqlx_deflate_max_client_compression_levelコマンド行形式 --mysqlx_deflate_max_client_compression_level=#導入 8.0.20 システム変数 mysqlx_deflate_max_client_compression_levelスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 5最小値 1最大値 9サーバーが X プロトコル 接続の Deflate アルゴリズムに許可する最大圧縮レベル。 範囲は、このアルゴリズムのデフォルトの圧縮レベルと同じです。 クライアントがこれより高い圧縮レベルをリクエストした場合、サーバーはここで設定したレベルを使用します。 このシステム変数を指定しない場合、サーバーは最大圧縮レベルを 5 に設定します。
-
mysqlx_document_id_unique_prefixコマンド行形式 --mysqlx-document-id-unique-prefix=#システム変数 mysqlx_document_id_unique_prefixスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 0最小値 0最大値 65535ドキュメントがコレクションに追加されたときにサーバーによって生成されるドキュメント ID の最初の 4 バイトを設定します。 この変数をインスタンスごとに一意の値に設定することで、ドキュメント ID がインスタンス間で一意であることを確認できます。 Understanding Document IDsを参照してください。
-
コマンド行形式 --mysqlx-enable-hello-notice[={OFF|ON}]システム変数 mysqlx_enable_hello_noticeスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Boolean デフォルト値 ONX プロトコル を介した接続を試行する クラシック MySQL プロトコル クライアントに送信されるメッセージを制御します。 有効にすると、サーバーの X プロトコル ポートに接続しようとする X プロトコル をサポートしていないクライアントは、間違ったプロトコルを使用していることを説明するエラーを受け取ります。
-
mysqlx_idle_worker_thread_timeoutコマンド行形式 --mysqlx-idle-worker-thread-timeout=#システム変数 mysqlx_idle_worker_thread_timeoutスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 60最小値 0最大値 3600アイドル状態のワーカースレッドが終了するまでの秒数。
-
コマンド行形式 --mysqlx-interactive-timeout=#システム変数 mysqlx_interactive_timeoutスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 28800最小値 1最大値 2147483対話型クライアントの
mysqlx_wait_timeoutセッション変数のデフォルト値。 (対話型クライアントがタイムアウトするまで待機する秒数。) -
mysqlx_lz4_default_compression_levelコマンド行形式 --mysqlx_lz4_default_compression_level=#導入 8.0.20 システム変数 mysqlx_lz4_default_compression_levelスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 2最小値 0最大値 16サーバーが X プロトコル 接続の LZ4 アルゴリズムに使用するデフォルトの圧縮レベル。 レベルは、0 (最小圧縮作業) から 16 (最大作業) の整数で指定します。 このレベルは、クライアントが機能ネゴシエーション中に圧縮レベルをリクエストしない場合に使用されます。 このシステム変数を指定しない場合、サーバーはレベル 2 をデフォルトとして使用します。 詳細は、セクション20.5.5「X プラグイン での接続圧縮」を参照してください。
-
mysqlx_lz4_max_client_compression_levelコマンド行形式 --mysqlx_lz4_max_client_compression_level=#導入 8.0.20 システム変数 mysqlx_lz4_max_client_compression_levelスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 8最小値 0最大値 16サーバーが X プロトコル 接続で LZ4 アルゴリズムに対して許可する最大圧縮レベル。 範囲は、このアルゴリズムのデフォルトの圧縮レベルと同じです。 クライアントがこれより高い圧縮レベルをリクエストした場合、サーバーはここで設定したレベルを使用します。 このシステム変数を指定しない場合、サーバーは最大圧縮レベルを 8 に設定します。
-
コマンド行形式 --mysqlx-max-allowed-packet=#システム変数 mysqlx_max_allowed_packetスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 67108864最小値 512最大値 1073741824X プラグイン で受信できるネットワークパケットの最大サイズ。 この制限は、接続に圧縮が使用される場合にも適用されるため、メッセージが解凍された後は、ネットワークパケットをこのサイズより小さくする必要があります。 これは
max_allowed_packetと同等の X プラグイン です。詳細は、その変数の説明を参照してください。 -
コマンド行形式 --mysqlx-max-connections=#システム変数 mysqlx_max_connectionsスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 100最小値 1最大値 65535X プラグイン が受け入れることができる同時クライアント接続の最大数。 これは
max_connectionsと同等の X プラグイン です。詳細は、その変数の説明を参照してください。この変数を変更する場合、新しい値が現在の接続数より小さいと、新しい接続に対してのみ新しい制限が考慮されます。
-
コマンド行形式 --mysqlx-min-worker-threads=#システム変数 mysqlx_min_worker_threadsスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 2最小値 1最大値 100クライアントリクエストを処理するために X プラグイン で使用されるワーカースレッドの最小数。
-
コマンド行形式 --mysqlx-port=port_numシステム変数 mysqlx_portスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 Integer デフォルト値 33060最小値 1最大値 65535X プラグイン が TCP/IP 接続をリスニングするネットワークポート。 これは
portと同等の X プラグイン です。詳細は、その変数の説明を参照してください。 -
コマンド行形式 --mysqlx-port-open-timeout=#システム変数 mysqlx_port_open_timeoutスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 Integer デフォルト値 0最小値 0最大値 120X プラグイン が TCP/IP ポートが解放されるまで待機する秒数。
-
コマンド行形式 --mysqlx-read-timeout=#システム変数 mysqlx_read_timeoutスコープ セッション 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 28800最小値 30最大値 2147483X プラグイン が読取り操作のブロックの完了を待機する秒数。 この時間が経過すると、読取り操作が成功しない場合、X プラグイン は接続をクローズし、エラーコード ER_IO_READ_ERROR の警告通知をクライアントアプリケーションに返します。
-
コマンド行形式 --mysqlx-socket=file_nameシステム変数 mysqlx_socketスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 文字列 デフォルト値 /tmp/mysqlx.sockX プラグイン が接続に使用する 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=file_nameシステム変数 mysqlx_ssl_caスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 ファイル名 デフォルト値 NULLmysqlx_ssl_caシステム変数はssl_caと似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。 -
コマンド行形式 --mysqlx-ssl-capath=dir_nameシステム変数 mysqlx_ssl_capathスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 ディレクトリ名 デフォルト値 NULLmysqlx_ssl_capathシステム変数はssl_capathと似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。 -
コマンド行形式 --mysqlx-ssl-cert=file_nameシステム変数 mysqlx_ssl_certスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 ファイル名 デフォルト値 NULLmysqlx_ssl_certシステム変数はssl_certと似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。 -
コマンド行形式 --mysqlx-ssl-cipher=nameシステム変数 mysqlx_ssl_cipherスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 文字列 デフォルト値 NULLmysqlx_ssl_cipherシステム変数はssl_cipherと似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。 -
コマンド行形式 --mysqlx-ssl-crl=file_nameシステム変数 mysqlx_ssl_crlスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 ファイル名 デフォルト値 NULLmysqlx_ssl_crlシステム変数はssl_crlと似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。 -
コマンド行形式 --mysqlx-ssl-crlpath=dir_nameシステム変数 mysqlx_ssl_crlpathスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 ディレクトリ名 デフォルト値 NULLmysqlx_ssl_crlpathシステム変数はssl_crlpathと似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。 -
コマンド行形式 --mysqlx-ssl-key=file_nameシステム変数 mysqlx_ssl_keyスコープ グローバル 動的 いいえ SET_VARヒントの適用いいえ 型 ファイル名 デフォルト値 NULLmysqlx_ssl_keyシステム変数はssl_keyと似ていますが、MySQL Server のメイン接続インタフェースではなく X プラグイン に適用される点が異なります。 X プラグイン の暗号化サポートの構成の詳細は、セクション20.5.3「X プラグイン での暗号化接続の使用」 を参照してください。 -
コマンド行形式 --mysqlx-wait-timeout=#システム変数 mysqlx_wait_timeoutスコープ セッション 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 28800最小値 1最大値 2147483X プラグイン が接続のアクティビティを待機する秒数。 この時間が経過すると、読取り操作が成功しない場合、X プラグイン は接続をクローズします。 クライアントが非対話型の場合、セッション変数の初期値はグローバル
mysqlx_wait_timeout変数からコピーされます。 対話型クライアントの場合、初期値はセッションmysqlx_interactive_timeoutからコピーされます。 -
コマンド行形式 --mysqlx-write-timeout=#システム変数 mysqlx_write_timeoutスコープ セッション 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 60最小値 1最大値 2147483X プラグイン が書込み操作のブロックの完了を待機する秒数。 この時間が経過すると、書込み操作が成功しない場合、X プラグイン は接続をクローズします。
-
mysqlx_zstd_default_compression_levelコマンド行形式 --mysqlx_zstd_default_compression_level=#導入 8.0.20 システム変数 mysqlx_zstd_default_compression_levelスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 3最小値 -131072最大値 22サーバーが X プロトコル 接続で zstd アルゴリズムに使用するデフォルトの圧縮レベル。 1.4.0 の zstd ライブラリのバージョンでは、正の値を 1 から 22 (最高の圧縮作業)、またはプログレッシブローエフォートを表す負の値に設定できます。 値 0 は値 1 に変換されます。 zstd ライブラリの以前のバージョンでは、値 3 のみを指定できます。 このレベルは、クライアントが機能ネゴシエーション中に圧縮レベルをリクエストしない場合に使用されます。 このシステム変数を指定しない場合、サーバーはレベル 3 をデフォルトとして使用します。 詳細は、セクション20.5.5「X プラグイン での接続圧縮」を参照してください。
-
mysqlx_zstd_max_client_compression_levelコマンド行形式 --mysqlx_zstd_max_client_compression_level=#導入 8.0.20 システム変数 mysqlx_zstd_max_client_compression_levelスコープ グローバル 動的 はい SET_VARヒントの適用いいえ 型 Integer デフォルト値 11最小値 -131072最大値 22サーバーが X プロトコル 接続で zstd アルゴリズムに対して許可する最大圧縮レベル。 範囲は、このアルゴリズムのデフォルトの圧縮レベルと同じです。 クライアントがこれより高い圧縮レベルをリクエストした場合、サーバーはここで設定したレベルを使用します。 このシステム変数を指定しない場合、サーバーは最大圧縮レベルを 11 に設定します。