文档主页
MySQL 8.4 参考手册
相关文档 下载本手册
PDF (US Ltr) - 39.9Mb
PDF (A4) - 40.0Mb
手册页 (TGZ) - 258.5Kb
手册页 (Zip) - 365.5Kb
信息 (Gzip) - 4.0Mb
信息 (Zip) - 4.0Mb


MySQL 8.4 参考手册  /  ...  /  X 插件选项和系统变量

22.5.6.2 X 插件选项和系统变量

要控制 X 插件的激活,请使用此选项

  • --mysqlx[=value]

    命令行格式 --mysqlx[=value]
    类型 枚举
    默认值 ON
    有效值

    ON

    OFF

    FORCE

    FORCE_PLUS_PERMANENT

    此选项控制服务器在启动时如何加载 X 插件。在 MySQL 8.4 中,X 插件默认启用,但此选项可用于控制其激活状态。

    选项值应是插件加载选项可用的值之一,如 第 7.6.1 节“安装和卸载插件” 中所述。

如果启用了 X 插件,它将公开几个系统变量,这些变量允许控制其操作

  • mysqlx_bind_address

    命令行格式 --mysqlx-bind-address=addr
    系统变量 mysqlx_bind_address
    范围 全局
    动态
    SET_VAR 提示适用
    类型 字符串
    默认值 *

    X 插件监听 TCP/IP 连接的网络地址。此变量不是动态的,只能在启动时配置。这是 X 插件的等效项 bind_address 系统变量;有关更多信息,请参阅该变量描述。

    默认情况下,X 插件在所有服务器主机 IPv4 接口上接受 TCP/IP 连接,并且如果服务器主机支持 IPv6,则在所有 IPv6 接口上接受 TCP/IP 连接。如果指定了 mysqlx_bind_address,其值必须满足以下要求

    • 单个地址值,可以指定单个非通配符 IP 地址(IPv4 或 IPv6),或主机名,或允许在多个网络接口上监听的通配符地址格式之一(*0.0.0.0::)。

    • 逗号分隔值的列表。当变量命名多个值的列表时,每个值必须指定单个非通配符 IP 地址(IPv4 或 IPv6)或主机名。通配符地址格式(*0.0.0.0::)不允许在值的列表中使用。

    • 该值还可以包含网络命名空间说明符。

    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 插件将以 IPv4 或 IPv6 格式接受该地址的 TCP/IP 连接。例如,如果 X 插件绑定到 ::ffff:127.0.0.1,则像 MySQL Shell 这样的客户端可以使用 --host=127.0.0.1--host=::ffff:127.0.0.1 连接。

    • 如果地址是 常规 IPv4 或 IPv6 地址(例如 127.0.0.1::1),X 插件将仅接受该 IPv4 或 IPv6 地址的 TCP/IP 连接。

    以下规则适用于为地址指定网络命名空间

    • 可以为 IP 地址或主机名指定网络命名空间。

    • 不能为通配符 IP 地址指定网络命名空间。

    • 对于给定地址,网络命名空间是可选的。如果给出,则必须将其指定为地址后面的 /ns 后缀。

    • 没有 /ns 后缀的地址使用主机系统全局命名空间。因此,全局命名空间是默认值。

    • /ns 后缀的地址使用名为 ns 的命名空间。

    • 主机系统必须支持网络命名空间,并且必须事先设置每个命名命名空间。命名不存在的命名空间会导致错误。

    • 如果变量值指定了多个地址,则可以包含全局命名空间中的地址、命名命名空间中的地址,或者二者的混合。

    有关网络命名空间的更多信息,请参阅 第 7.1.14 节“网络命名空间支持”

    重要

    由于 X 插件不是强制插件,因此如果指定的地址或地址列表中存在错误,它不会阻止服务器启动(与 MySQL 服务器对 bind_address 错误的做法相同)。对于 X 插件,如果列表中的某个地址无法解析,或者 X 插件无法绑定到该地址,则该地址将被跳过,并记录错误消息,X 插件将尝试绑定到列表中剩余的每个地址。X 插件的 Mysqlx_address 状态变量仅显示列表中成功绑定到的地址。如果列表中的地址均未成功绑定,或者指定的单个地址失败,X 插件将记录错误消息 ER_XPLUGIN_FAILED_TO_PREPARE_IO_INTERFACES,指出无法使用 X 协议。 mysqlx_bind_address 不是动态的,因此要解决任何问题,您必须停止服务器,更正系统变量值,然后重新启动服务器。

  • mysqlx_compression_algorithms

    命令行格式 --mysqlx-compression-algorithms=value
    系统变量 mysqlx_compression_algorithms
    范围 全局
    动态
    SET_VAR 提示适用
    类型 设置
    默认值 deflate_stream,lz4_message,zstd_stream
    有效值

    deflate_stream

    lz4_message

    zstd_stream

    允许在 X 协议连接上使用的压缩算法。默认情况下,允许使用 Deflate、LZ4 和 zstd 算法。要禁止任何算法,请将 mysqlx_compression_algorithms 设置为仅包含您允许的算法。算法名称 deflate_streamlz4_messagezstd_stream 可以以任何组合指定,顺序和大小写无关紧要。如果您将系统变量设置为空字符串,则不允许使用任何压缩算法,并且仅使用未压缩的连接。使用特定于算法的系统变量来调整每个允许算法的默认和最大压缩级别。有关更多详细信息以及 X 协议的连接压缩与 MySQL 服务器的等效设置之间的关系,请参阅 第 22.5.5 节“X 插件的连接压缩”

  • mysqlx_connect_timeout

    命令行格式 --mysqlx-connect-timeout=#
    系统变量 mysqlx_connect_timeout
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 30
    最小值 1
    最大值 1000000000
    单位

    X 插件等待从新连接的客户端接收第一个数据包的秒数。这是 X 插件的等效项 connect_timeout;有关更多信息,请参阅该变量描述。

  • mysqlx_deflate_default_compression_level

    命令行格式 --mysqlx_deflate_default_compression_level=#
    系统变量 mysqlx_deflate_default_compression_level
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 3
    最小值 1
    最大值 9

    服务器在 X 协议连接上使用 Deflate 算法的默认压缩级别。将级别指定为从 1(最低压缩工作量)到 9(最高工作量)的整数。如果客户端在功能协商期间未请求压缩级别,则使用此级别。如果您未指定此系统变量,服务器将使用级别 3 作为默认级别。有关更多信息,请参见第 22.5.5 节,“使用 X 插件进行连接压缩”

  • mysqlx_deflate_max_client_compression_level

    命令行格式 --mysqlx_deflate_max_client_compression_level=#
    系统变量 mysqlx_deflate_max_client_compression_level
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 5
    最小值 1
    最大值 9

    服务器在 X 协议连接上允许的 Deflate 算法的最高压缩级别。范围与该算法的默认压缩级别相同。如果客户端请求的压缩级别高于此级别,则服务器使用您在此设置的级别。如果您未指定此系统变量,服务器将设置最高压缩级别为 5。

  • mysqlx_document_id_unique_prefix

    命令行格式 --mysqlx-document-id-unique-prefix=#
    系统变量 mysqlx_document_id_unique_prefix
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 0
    最小值 0
    最大值 65535

    设置服务器在将文档添加到集合时生成的文档 ID 的前 4 个字节。通过将此变量设置为每个实例的唯一值,您可以确保文档 ID 在所有实例中都是唯一的。请参见了解文档 ID

  • mysqlx_enable_hello_notice

    命令行格式 --mysqlx-enable-hello-notice[={OFF|ON}]
    系统变量 mysqlx_enable_hello_notice
    范围 全局
    动态
    SET_VAR 提示适用
    类型 布尔值
    默认值 ON

    控制发送到尝试通过 X 协议连接的经典 MySQL 协议客户端的消息。启用后,不支持 X 协议的客户端尝试连接到服务器 X 协议端口时会收到错误消息,说明他们使用的是错误的协议。

  • mysqlx_idle_worker_thread_timeout

    命令行格式 --mysqlx-idle-worker-thread-timeout=#
    系统变量 mysqlx_idle_worker_thread_timeout
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 60
    最小值 0
    最大值 3600
    单位

    空闲工作线程终止之前的秒数。

  • mysqlx_interactive_timeout

    命令行格式 --mysqlx-interactive-timeout=#
    系统变量 mysqlx_interactive_timeout
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 28800
    最小值 1
    最大值 2147483
    单位

    交互式客户端的mysqlx_wait_timeout 会话变量的默认值。(交互式客户端超时等待的秒数。)

  • mysqlx_lz4_default_compression_level

    命令行格式 --mysqlx_lz4_default_compression_level=#
    系统变量 mysqlx_lz4_default_compression_level
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 2
    最小值 0
    最大值 16

    服务器在 X 协议连接上使用 LZ4 算法的默认压缩级别。将级别指定为从 0(最低压缩工作量)到 16(最高工作量)的整数。如果客户端在功能协商期间未请求压缩级别,则使用此级别。如果您未指定此系统变量,服务器将使用级别 2 作为默认级别。有关更多信息,请参见第 22.5.5 节,“使用 X 插件进行连接压缩”

  • mysqlx_lz4_max_client_compression_level

    命令行格式 --mysqlx_lz4_max_client_compression_level=#
    系统变量 mysqlx_lz4_max_client_compression_level
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 8
    最小值 0
    最大值 16

    服务器在 X 协议连接上允许的 LZ4 算法的最高压缩级别。范围与该算法的默认压缩级别相同。如果客户端请求的压缩级别高于此级别,则服务器使用您在此设置的级别。如果您未指定此系统变量,服务器将设置最高压缩级别为 8。

  • mysqlx_max_allowed_packet

    命令行格式 --mysqlx-max-allowed-packet=#
    系统变量 mysqlx_max_allowed_packet
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 67108864
    最小值 512
    最大值 1073741824
    单位 字节

    X 插件可以接收的网络数据包的最大大小。此限制也适用于使用连接压缩的情况,因此网络数据包在消息解压缩后必须小于此大小。这是 max_allowed_packet 的 X 插件等效项;有关更多信息,请参见该变量描述。

  • mysqlx_max_connections

    命令行格式 --mysqlx-max-connections=#
    系统变量 mysqlx_max_connections
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 100
    最小值 1
    最大值 65535

    X 插件可以接受的最大并发客户端连接数。这是 max_connections 的 X 插件等效项;有关更多信息,请参见该变量描述。

    对于此变量的修改,如果新值小于当前连接数,则仅对新连接考虑新限制。

  • mysqlx_min_worker_threads

    命令行格式 --mysqlx-min-worker-threads=#
    系统变量 mysqlx_min_worker_threads
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 2
    最小值 1
    最大值 100

    X 插件用于处理客户端请求的最小工作线程数。

  • mysqlx_port

    命令行格式 --mysqlx-port=port_num
    系统变量 mysqlx_port
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 33060
    最小值 1
    最大值 65535

    X 插件监听 TCP/IP 连接的网络端口。这是 port 的 X 插件等效项;有关更多信息,请参见该变量描述。

  • mysqlx_port_open_timeout

    命令行格式 --mysqlx-port-open-timeout=#
    系统变量 mysqlx_port_open_timeout
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 0
    最小值 0
    最大值 120
    单位

    X 插件等待 TCP/IP 端口变为空闲的秒数。

  • mysqlx_read_timeout

    命令行格式 --mysqlx-read-timeout=#
    系统变量 mysqlx_read_timeout
    范围 会话
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 30
    最小值 1
    最大值 2147483
    单位

    X 插件等待阻塞读取操作完成的秒数。经过此时间后,如果读取操作不成功,X 插件将关闭连接并使用错误代码ER_IO_READ_ERROR 向客户端应用程序返回警告通知。

  • mysqlx_socket

    命令行格式 --mysqlx-socket=file_name
    系统变量 mysqlx_socket
    范围 全局
    动态
    SET_VAR 提示适用
    类型 字符串
    默认值 /tmp/mysqlx.sock

    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 编译选项更改主套接字文件的默认路径和文件名,这会影响 X 插件套接字文件的默认值,该值是通过在MYSQL_UNIX_ADDR 文件名中附加x 形成的。如果您希望在编译时为 X 插件套接字文件设置不同的默认值,请使用MYSQLX_UNIX_ADDR 编译选项。

    环境变量MYSQLX_UNIX_PORT 也可以用于在服务器启动时为 X 插件套接字文件设置默认值(请参见第 6.9 节,“环境变量”)。如果您设置此环境变量,它将覆盖已编译的MYSQLX_UNIX_ADDR 值,但会被mysqlx_socket 值覆盖。

  • mysqlx_ssl_ca

    命令行格式 --mysqlx-ssl-ca=file_name
    系统变量 mysqlx_ssl_ca
    范围 全局
    动态
    SET_VAR 提示适用
    类型 文件名
    默认值 NULL

    mysqlx_ssl_ca 系统变量类似于ssl_ca,不同之处在于它适用于 X 插件而不是 MySQL Server 主连接接口。有关配置 X 插件的加密支持的信息,请参见第 22.5.3 节,“使用 X 插件进行加密连接”

  • mysqlx_ssl_capath

    命令行格式 --mysqlx-ssl-capath=dir_name
    系统变量 mysqlx_ssl_capath
    范围 全局
    动态
    SET_VAR 提示适用
    类型 目录名
    默认值 NULL

    mysqlx_ssl_capath 系统变量类似于ssl_capath,不同之处在于它适用于 X 插件而不是 MySQL Server 主连接接口。有关配置 X 插件的加密支持的信息,请参见第 22.5.3 节,“使用 X 插件进行加密连接”

  • mysqlx_ssl_cert

    命令行格式 --mysqlx-ssl-cert=file_name
    系统变量 mysqlx_ssl_cert
    范围 全局
    动态
    SET_VAR 提示适用
    类型 文件名
    默认值 NULL

    mysqlx_ssl_cert 系统变量类似于ssl_cert,不同之处在于它适用于 X 插件而不是 MySQL Server 主连接接口。有关配置 X 插件的加密支持的信息,请参见第 22.5.3 节,“使用 X 插件进行加密连接”

  • mysqlx_ssl_cipher

    命令行格式 --mysqlx-ssl-cipher=name
    系统变量 mysqlx_ssl_cipher
    范围 全局
    动态
    SET_VAR 提示适用
    类型 字符串
    默认值 NULL

    mysqlx_ssl_cipher 系统变量类似于ssl_cipher,不同之处在于它适用于 X 插件而不是 MySQL Server 主连接接口。有关配置 X 插件的加密支持的信息,请参见第 22.5.3 节,“使用 X 插件进行加密连接”

  • mysqlx_ssl_crl

    命令行格式 --mysqlx-ssl-crl=file_name
    系统变量 mysqlx_ssl_crl
    范围 全局
    动态
    SET_VAR 提示适用
    类型 文件名
    默认值 NULL

    系统变量 mysqlx_ssl_crl 类似于 ssl_crl,不同之处在于它适用于 X 插件而不是 MySQL Server 主连接接口。有关为 X 插件配置加密支持的信息,请参见 第 22.5.3 节,“使用 X 插件加密连接”

  • mysqlx_ssl_crlpath

    命令行格式 --mysqlx-ssl-crlpath=dir_name
    系统变量 mysqlx_ssl_crlpath
    范围 全局
    动态
    SET_VAR 提示适用
    类型 目录名
    默认值 NULL

    系统变量 mysqlx_ssl_crlpath 类似于 ssl_crlpath,不同之处在于它适用于 X 插件而不是 MySQL Server 主连接接口。有关为 X 插件配置加密支持的信息,请参见 第 22.5.3 节,“使用 X 插件加密连接”

  • mysqlx_ssl_key

    命令行格式 --mysqlx-ssl-key=file_name
    系统变量 mysqlx_ssl_key
    范围 全局
    动态
    SET_VAR 提示适用
    类型 文件名
    默认值 NULL

    系统变量 mysqlx_ssl_key 类似于 ssl_key,不同之处在于它适用于 X 插件而不是 MySQL Server 主连接接口。有关为 X 插件配置加密支持的信息,请参见 第 22.5.3 节,“使用 X 插件加密连接”

  • mysqlx_wait_timeout

    命令行格式 --mysqlx-wait-timeout=#
    系统变量 mysqlx_wait_timeout
    范围 会话
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 28800
    最小值 1
    最大值 2147483
    单位

    X 插件等待连接上活动操作的秒数。如果经过此时间后读取操作未成功,X 插件将关闭连接。如果客户端是非交互式的,则会话变量的初始值将从全局 mysqlx_wait_timeout 变量复制而来。对于交互式客户端,初始值将从会话 mysqlx_interactive_timeout 复制而来。

  • mysqlx_write_timeout

    命令行格式 --mysqlx-write-timeout=#
    系统变量 mysqlx_write_timeout
    范围 会话
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 60
    最小值 1
    最大值 2147483
    单位

    X 插件等待阻塞写入操作完成的秒数。如果经过此时间后写入操作未成功,X 插件将关闭连接。

  • mysqlx_zstd_default_compression_level

    命令行格式 --mysqlx_zstd_default_compression_level=#
    系统变量 mysqlx_zstd_default_compression_level
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 3
    最小值 -131072
    最大值 22

    服务器在 X 协议连接上为 zstd 算法使用的默认压缩级别。对于 1.4.0 及更高版本的 zstd 库,您可以设置 1 到 22 之间的正值(最高压缩效率),或负值,表示逐渐降低的效率。值 0 将转换为值 1。对于早期版本的 zstd 库,您只能指定值 3。如果客户端在功能协商期间未请求压缩级别,则使用此级别。如果您未指定此系统变量,则服务器使用级别 3 作为默认值。有关更多信息,请参见 第 22.5.5 节,“使用 X 插件进行连接压缩”

  • mysqlx_zstd_max_client_compression_level

    命令行格式 --mysqlx_zstd_max_client_compression_level=#
    系统变量 mysqlx_zstd_max_client_compression_level
    范围 全局
    动态
    SET_VAR 提示适用
    类型 整数
    默认值 11
    最小值 -131072
    最大值 22

    服务器允许在 X 协议连接上为 zstd 算法使用的最大压缩级别。范围与该算法的默认压缩级别相同。如果客户端请求的压缩级别高于此级别,则服务器使用您在此处设置的级别。如果您未指定此系统变量,则服务器将最大压缩级别设置为 11。