Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 37.7Mb
PDF (A4) - 37.7Mb
PDF (RPM) - 33.8Mb
HTML Download (TGZ) - 8.4Mb
HTML Download (Zip) - 8.4Mb
HTML Download (RPM) - 7.3Mb
Man Pages (TGZ) - 130.0Kb
Man Pages (Zip) - 185.6Kb
Info (Gzip) - 3.3Mb
Info (Zip) - 3.3Mb


MySQL 8.0 Reference Manual  /  ...  /  X Plugin System Variables and Options

Pre-General Availability Draft: 2018-02-16

20.7.3.2 X Plugin System Variables and Options

The following command options configure X Plugin:

  • --mysqlx-bind-address[=value]

    Command-Line Format--mysqlx-bind-address=#
    System VariableNamemysqlx_bind_address
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypestring
    Default*

    Specifies the network address which X Plugin uses for connections. The equivalent of bind_address for X Plugin.

    By default X Plugin listens for connections on a single IPv4 TCP/IP network socket. Use this option to configure where X Plugin listens for connections, such as binding to an IPv6 address, all IPv4 and IPv6 addresses or a default IPv6 address with a fallback IPv4 address.

    X Plugin treats different types of addresses as follows:

    • If the address is *, X Plugin accepts TCP/IP connections on all server host IPv6 and IPv4 interfaces if the server host supports IPv6, or accepts TCP/IP connections on all IPv4 addresses otherwise. Use this address to permit both IPv4 and IPv6 connections on all server interfaces. This value is the default.

    • If the address is 0.0.0.0, X Plugin accepts TCP/IP connections on all server host IPv4 interfaces. This value is the default.

    • If the address is ::, X Plugin accepts TCP/IP connections on all server host IPv4 and IPv6 interfaces.

    • If the address is *, X Plugin accepts TCP/IP connections on all server host IPv6 and IPv4 interfaces if the server host supports IPv6, or accepts TCP/IP connections on all IPv4 addresses otherwise. Use this address to permit both IPv4 and IPv6 connections for X Plugin.

    • If the address is an IPv4-mapped address, X Plugin accepts TCP/IP connections for that address, in either IPv4 or IPv6 format. For example, if X Plugin is bound to ::ffff:127.0.0.1, a client such as MySQL Shell can connect using --host=127.0.0.1 or --host=::ffff:127.0.0.1.

    • If the address is a regular IPv4 or IPv6 address (such as 127.0.0.1 or ::1), X Plugin accepts TCP/IP connections only for that IPv4 or IPv6 address.

  • --mysqlx-connect-timeout[=value]

    Command-Line Format--mysqlx-connect-timeout=#
    System VariableNamemysqlx_connect_timeout
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default30
    Minimum1
    Maximum1000000000

    Number of seconds X Plugin waits for the first packet to be received from newly connected clients. The X Plugin equivalent of connect_timeout.

  • --mysqlx-idle-worker-thread-timeout[=value]

    Command-Line Format--mysqlx-idle-worker-thread-timeout=#
    System VariableNamemysqlx_idle_worker_thread_timeout
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default60
    Minimum0
    Maximum3600

    Time in seconds after which an idle worker thread is terminated.

  • --mysqlx-interactive-timeout=value]

    Introduced8.0.4
    Command-Line Format--mysqlx-interactive-timeout=#
    System VariableNamemysqlx_interactive_timeout
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default28800
    Minimum1
    Maximum2147483

    Default value of the mysqlx_wait_timeout session variable for interactive clients.

  • --mysqlx-max-allowed-packet[=value]

    Command-Line Format--mysqlx-max-allowed-packet=#
    System VariableNamemysqlx_max_allowed_packet
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default1048576
    Minimum512
    Maximum1073741824

    Maxmum size of a network packet that X Plugin can process.

  • --mysqlx-max-connections[=value]

    Command-Line Format--mysqlx-max-connections=#
    System VariableNamemysqlx_max_connections
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default100
    Minimum1
    Maximum65535

    Maximum number of concurrent client connections the X Plugin can accept. This option is dynamically changeable. When modifying this variable, if the new value is smaller than the current number of connections, the new limit is only taken into account for new connections.

  • --mysqlx-min-worker-threads[=value]

    Command-Line Format--mysqlx-min-worker-threads=value
    System VariableNamemysqlx_min_worker_threads
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default2
    Minimum1
    Maximum100

    The minimum number of worker threads the X Plugin uses for handling client requests.

  • --mysqlx-port[=value]

    Command-Line Format--mysqlx-port=#
    System VariableNamemysqlx_port
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default33060
    Minimum1
    Maximum65535

    Specifies the port where the X Plugin listens for connections. The equivalent of port for X Plugin.

  • --mysqlx-port-open-timeout[=value]

    Command-Line Format--mysqlx-port-open-timeout=#
    System VariableNamemysqlx_port_open_timeout
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default0
    Minimum1
    Maximum120

    The amount of time in seconds which X Plugin waits for a TCP/IP port to become free. This option is not dynamically changeable.

  • --mysqlx-read-timeout[=value]

    Introduced8.0.4
    Command-Line Format--mysqlx-read-timeout=#
    System VariableNamemysqlx_port_read_timeout
    ScopeSession
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default28800
    Minimum30
    Maximum2147483

    Number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, the connection is aborted.

  • --mysqlx-socket[=value]

    Command-Line Format--mysqlx-socket=file_name
    System VariableNamemysqlx_socket
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypestring
    Default/tmp/mysqlx.sock

    The path to a Unix socket file which X Plugin uses for connections. Only used by MySQL Server when running on Unix operating systems. Clients can then use this socket to connect to MySQL Server using the X Plugin.

    The value of mysqlx_socket depends on the value of socket. By default socket is /tmp/mysql.sock and therefore mysqlx_socket is /tmp/mysqlx.sock. If socket is set to /sockets/mysql.sock and mysqlx_socket has not been manually configured, then mysqlx_socket is set to /sockets/mysqlx.sock. In other words the path and filename of socket is used and an x is appended to the filename, this enables you to conveniently store the sockets used by MySQL server at a single path. To define separate paths or unique filenames for the MySQL and X Plugin sockets, configure both the socket and the mysqlx_socket system variables. For example in a configuration file:

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

    Alternatively, X Plugin can be configured at compile time to use a specific socket with the MYSQLX_UNIX_ADDR option. If the X Plugin MYSQLX_UNIX_ADDR compile option is not set, the value is based on the MYSQL_UNIX_ADDR and adds an x to the file name, for example resulting in /tmp/mysqlx.sock.

  • --mysqlx-ssl[=value]

    Command-Line Format--mysqlx-ssl=#
    System VariableNamemysqlx_ssl
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger

    The equivalent of ssl for X Plugin, see that variable for more information.

  • --mysqlx-ssl-ca[=value]

    Command-Line Format--mysqlx-ssl-ca=file-name
    System VariableNamemysqlx_ssl_ca
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypefile name

    The equivalent of ssl_ca for X Plugin, see that variable for more information.

  • --mysqlx-ssl-capath[=value]

    Command-Line Format--mysqlx-ssl-capath=dir_name
    System VariableNamemysqlx_ssl_capath
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypedirectory name

    The equivalent of ssl_capath for X Plugin, see that variable for more information.

  • --mysqlx-ssl-cert[=value]

    Command-Line Format--mysqlx-ssl-cert=name
    System VariableNamemysqlx_ssl_cert
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypefile name

    The equivalent of ssl_cert for X Plugin, see that variable for more information.

  • --mysqlx-ssl-cipher[=value]

    Command-Line Format--mysqlx-ssl-cipher=name
    Permitted ValuesTypestring

    The equivalent of ssl_cipher for X Plugin, see that variable for more information.

  • --mysqlx-ssl-crl[=value]

    Command-Line Format--mysqlx-ssl-crl=file_name
    System VariableNamemysqlx_ssl_crl
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypefile name

    The equivalent of ssl_crl for X Plugin, see that variable for more information.

  • --mysqlx-ssl-crlpath[=value]

    Command-Line Format--mysqlx-ssl-crlpath=directory_name
    System VariableNamemysqlx_ssl_crlpath
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypedirectory name

    The equivalent of ssl_crlpath for X Plugin, see that variable for more information.

  • --mysqlx-ssl-key[=value]

    Command-Line Format--mysqlx-ssl-key=file-name
    System VariableNamemysqlx_ssl_key
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypefile name

    The equivalent of ssl_key for X Plugin, see that variable for more information.

  • --mysqlx-wait-timeout[=value]

    Introduced8.0.4
    Command-Line Format--mysqlx-wait-timeout=value
    System VariableNamemysqlx_wait_timeout
    ScopeSession
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default28800
    Minimum1
    Maximum2147483

    Number of seconds that X Plugin waits for activity on a connection. After this time, if the read-operation is not successful, the connection is aborted. If the client is non-interactive, the initial value of the session variable is copied from the global mysqlx_wait_timeout variable. For interactive clients, the initial value is copied from the session mysqlx_interactive_timeout.

  • --mysqlx-write-timeout[=value]

    Introduced8.0.4
    Command-Line Format--mysqlx-write-timeout=value
    System VariableNamemysqlx_write_timeout
    ScopeSession
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default60
    Minimum1
    Maximum2147483

    Number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, the connection is aborted.

When X Plugin is running the following system variables are available.

  • mysqlx_bind_address

    Command-Line Format--mysqlx-bind-address=value
    System VariableNamemysqlx_bind_address
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypestring
    Default*

    The network address which X Plugin uses for connections. The equivalent of bind_address for X Plugin, see that variable for more information. This variable is not dynamic and can only be configured at start up.

  • mysqlx_connect_timeout

    Command-Line Format--mysqlx-connect-timeout=value
    System VariableNamemysqlx_connect_timeout
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default30
    Minimum1
    Maximum1000000000

    Number of seconds X Plugin waits for the first packet to be received from newly connected clients. The equivalent of connect_timeout for X Plugin.

  • mysqlx_idle_worker_thread_timeout

    Command-Line Format--mysqlx-idle-worker-thread-timeout=value
    System VariableNamemysqlx_idle_worker_thread_timeout
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default60
    Minimum0
    Maximum3600

    Number of seconds after which an idle worker thread is terminated.

  • mysqlx_interactive_timeout

    Introduced8.0.4
    Command-Line Format--mysqlx-interactive-timeout=value
    System VariableNamemysqlx_interactive_timeout
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default28800
    Minimum1
    Maximum2147483

    Default value of the mysqlx_wait_timeout session variable for interactive clients.

  • mysqlx_max_allowed_packet

    Command-Line Format--mysqlx-max-allowed-packet=value
    System VariableNamemysqlx_max_allowed_packet
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default1048576
    Minimum512
    Maximum1073741824

    Maximum size of a network packet that can be received by X Plugin. The X Plugin equivalent of max_allowed_packet.

  • mysqlx_min_worker_threads

    Command-Line Format--mysqlx-min-worker-threads=value
    System VariableNamemysqlx_min_worker_threads
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default2
    Minimum1
    Maximum100

    Minimum number of worker threads the X Plugin uses for handling client requests.

  • mysqlx_max_connections

    Command-Line Format--mysqlx-max-connections=value
    System VariableNamemysqlx_max_connections
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default100
    Minimum1
    Maximum65535

    Maximum number of concurrent client connections X Plugin can accept. The X Plugin equivalent of max_connections.

  • mysqlx_port

    Command-Line Format--mysqlx-port=value
    System VariableNamemysqlx_port
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default33060
    Minimum1
    Maximum65535

    The network port which X Plugin uses for connections. The X Plugin equivalent of port. This option is not dynamically changeable.

  • mysqlx_port_open_timeout

    Command-Line Format--mysqlx-port-open-timeout=value
    System VariableNamemysqlx_port_open_timeout
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default0
    Minimum0
    Maximum100

    The amount of time in seconds which X Plugin waits for a TCP/IP port to become free. This option is not dynamically changeable.

  • mysqlx_read_timeout

    Introduced8.0.4
    Command-Line Format--mysqlx-read-timeout=value
    System VariableNamemysqlx_read_timeout
    ScopeSession
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default28800
    Minimum30
    Maximum2147483

    Number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, the connection is aborted.

  • mysqlx_socket

    Command-Line Format--mysqlx-socket=file_name
    System VariableNamemysqlx_socket
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    Permitted ValuesTypestring
    Default/tmp/mysqlx.sock

    The socket where X Plugin listens for connections.

  • mysqlx_wait_timeout

    Introduced8.0.4
    Command-Line Format--mysqlx-wait-timeout=value
    System VariableNamemysqlx_wait_timeout
    ScopeSession
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default28800
    Minimum1
    Maximum2147483

    Number of seconds that X Plugin waits for activity on a connection. After this time, if the read-operation is not successful, the connection is aborted. If the client is non-interactive, the initial value of the session variable is copied from the global mysqlx_wait_timeout variable. For interactive clients, the initial value is copied from the session mysqlx_interactive_timeout.

  • mysqlx_write_timeout

    Introduced8.0.4
    Command-Line Format--mysqlx-write-timeout=value
    System VariableNamemysqlx_write_timeout
    ScopeSession
    DynamicYes
    SET_VAR Hint AppliesNo
    Permitted ValuesTypeinteger
    Default28800
    Minimum1
    Maximum2147483

    Number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, the connection is aborted.


User Comments
Sign Up Login You must be logged in to post a comment.