Documentation Home
MySQL 5.7 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 35.1Mb
PDF (A4) - 35.2Mb
Man Pages (TGZ) - 256.4Kb
Man Pages (Zip) - 361.2Kb
Info (Gzip) - 3.4Mb
Info (Zip) - 3.4Mb
Excerpts from this Manual

MySQL 5.7 Reference Manual  / ...  / Using MySQL as a Document Store  / X Plugin  / X Plugin Options and Variables  /  X Plugin Options and System Variables

19.4.2.2 X Plugin Options and System Variables

To control activation of X Plugin, use this option:

If X Plugin is enabled, it exposes several system variables that permit control over its operation:

  • mysqlx_bind_address

    Command-Line Format--mysqlx-bind-address=addr
    Introduced5.7.17
    System Variablemysqlx_bind_address
    ScopeGlobal
    DynamicNo
    TypeString
    Default Value*

    The network address on which X Plugin listens for TCP/IP connections. This variable is not dynamic and can be configured only at startup. This is the X Plugin equivalent of thebind_address system variable; see that variable description for more information.

    mysqlx_bind_address accepts a single address value, which may specify a single non-wildcard IP address or host name, or one of the wildcard address formats that permit listening on multiple network interfaces (*,0.0.0.0, or::).

    An IP address can be specified as an IPv4 or IPv6 address. If the value is a host name, X Plugin resolves the name to an IP address and binds to that address. If a host name resolves to multiple IP addresses, X Plugin uses the first IPv4 address if there are any, or the first IPv6 address otherwise.

    X Plugin treats different types of addresses as follows:

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

    • If the address is0.0.0.0, X Plugin accepts TCP/IP connections on all server host IPv4 interfaces.

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

    • 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 as127.0.0.1 or::1), X Plugin accepts TCP/IP connections only for that IPv4 or IPv6 address.

    If binding to the address fails, X Plugin produces an error and the server does not load it.

  • mysqlx_connect_timeout

    Command-Line Format--mysqlx-connect-timeout=#
    Introduced5.7.12
    System Variablemysqlx_connect_timeout
    ScopeGlobal
    DynamicYes
    TypeInteger
    Default Value30
    Minimum Value1
    Maximum Value1000000000
    Unitseconds

    The number of seconds X Plugin waits for the first packet to be received from newly connected clients. This is the X Plugin equivalent ofconnect_timeout; see that variable description for more information.

  • mysqlx_idle_worker_thread_timeout

    Command-Line Format--mysqlx-idle-worker-thread-timeout=#
    Introduced5.7.12
    System Variablemysqlx_idle_worker_thread_timeout
    ScopeGlobal
    DynamicYes
    TypeInteger
    Default Value60
    Minimum Value0
    Maximum Value3600
    Unitseconds

    The number of seconds after which idle worker threads are terminated.

  • mysqlx_max_allowed_packet

    Command-Line Format--mysqlx-max-allowed-packet=#
    Introduced5.7.12
    System Variablemysqlx_max_allowed_packet
    ScopeGlobal
    DynamicYes
    TypeInteger
    Default Value67108864
    Minimum Value512
    Maximum Value1073741824
    Unitbytes

    The maximum size of network packets that can be received by X Plugin. This is the X Plugin equivalent ofmax_allowed_packet; see that variable description for more information.

  • mysqlx_max_connections

    Command-Line Format--mysqlx-max-connections=#
    Introduced5.7.12
    System Variablemysqlx_max_connections
    ScopeGlobal
    DynamicYes
    TypeInteger
    Default Value100
    Minimum Value1
    Maximum Value65535

    The maximum number of concurrent client connections X Plugin can accept. This is the X Plugin equivalent ofmax_connections; see that variable description for more information.

    For modifications to this variable, if the new value is smaller than the current number of connections, the new limit is taken into account only for new connections.

  • mysqlx_min_worker_threads

    Command-Line Format--mysqlx-min-worker-threads=#
    Introduced5.7.12
    System Variablemysqlx_min_worker_threads
    ScopeGlobal
    DynamicYes
    TypeInteger
    Default Value2
    Minimum Value1
    Maximum Value100

    The minimum number of worker threads used by X Plugin for handling client requests.

  • mysqlx_port

    Command-Line Format--mysqlx-port=port_num
    Introduced5.7.12
    System Variablemysqlx_port
    ScopeGlobal
    DynamicNo
    TypeInteger
    Default Value33060
    Minimum Value1
    Maximum Value65535

    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent ofport; see that variable description for more information.

  • mysqlx_port_open_timeout

    Command-Line Format--mysqlx-port-open-timeout=#
    Introduced5.7.17
    System Variablemysqlx_port_open_timeout
    ScopeGlobal
    DynamicNo
    TypeInteger
    Default Value0
    Minimum Value0
    Maximum Value120
    Unitseconds

    The number of seconds X Plugin waits for a TCP/IP port to become free.

  • mysqlx_socket

    Command-Line Format--mysqlx-socket=file_name
    Introduced5.7.15
    System Variablemysqlx_socket
    ScopeGlobal
    DynamicNo
    TypeString
    Default Value/tmp/mysqlx.sock

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

    The defaultmysqlx_socket path and file name is based on the default path and file name for the main socket file for MySQL Server, with the addition of anx appended to the file name. The default path and file name for the main socket file is/tmp/mysql.sock, therefore the default path and file name for the X Plugin socket file is/tmp/mysqlx.sock.

    If you specify an alternative path and file name for the main socket file at server startup using thesocket system variable, this does not affect the default for the X Plugin socket file. In this situation, if you want to store both sockets at a single path, you must set themysqlx_socket system variable as well. For example in a configuration file:

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

    If you change the default path and file name for the main socket file at compile time using theMYSQL_UNIX_ADDR compile option, this does affect the default for the X Plugin socket file, which is formed by appending anx to theMYSQL_UNIX_ADDR file name. If you want to set a different default for the X Plugin socket file at compile time, use theMYSQLX_UNIX_ADDR compile option.

    TheMYSQLX_UNIX_PORT environment variable can also be used to set a default for the X Plugin socket file at server startup (seeSection 4.9, “Environment Variables”). If you set this environment variable, it overrides the compiledMYSQLX_UNIX_ADDR value, but is overridden by themysqlx_socket value.

  • mysqlx_ssl_ca

    Command-Line Format--mysqlx-ssl-ca=file_name
    Introduced5.7.12
    System Variablemysqlx_ssl_ca
    ScopeGlobal
    DynamicNo
    TypeFile name
    Default ValueNULL

    Themysqlx_ssl_ca system variable is likessl_ca, except that it applies to X Plugin rather than the MySQL Server main connection interface. For information about configuring encryption support for X Plugin, seeSection 19.4.1, “Using Encrypted Connections with X Plugin”.

  • mysqlx_ssl_capath

    Command-Line Format--mysqlx-ssl-capath=dir_name
    Introduced5.7.12
    System Variablemysqlx_ssl_capath
    ScopeGlobal
    DynamicNo
    TypeDirectory name
    Default ValueNULL

    Themysqlx_ssl_capath system variable is likessl_capath, except that it applies to X Plugin rather than the MySQL Server main connection interface. For information about configuring encryption support for X Plugin, seeSection 19.4.1, “Using Encrypted Connections with X Plugin”.

  • mysqlx_ssl_cert

    Command-Line Format--mysqlx-ssl-cert=file_name
    Introduced5.7.12
    System Variablemysqlx_ssl_cert
    ScopeGlobal
    DynamicNo
    TypeFile name
    Default ValueNULL

    Themysqlx_ssl_cert system variable is likessl_cert, except that it applies to X Plugin rather than the MySQL Server main connection interface. For information about configuring encryption support for X Plugin, seeSection 19.4.1, “Using Encrypted Connections with X Plugin”.

  • mysqlx_ssl_cipher

    Command-Line Format--mysqlx-ssl-cipher=name
    Introduced5.7.12
    System Variablemysqlx_ssl_cipher
    ScopeGlobal
    DynamicNo
    TypeString
    Default ValueNULL

    Themysqlx_ssl_cipher system variable is likessl_cipher, except that it applies to X Plugin rather than the MySQL Server main connection interface. For information about configuring encryption support for X Plugin, seeSection 19.4.1, “Using Encrypted Connections with X Plugin”.

  • mysqlx_ssl_crl

    Command-Line Format--mysqlx-ssl-crl=file_name
    Introduced5.7.12
    System Variablemysqlx_ssl_crl
    ScopeGlobal
    DynamicNo
    TypeFile name
    Default ValueNULL

    Themysqlx_ssl_crl system variable is likessl_crl, except that it applies to X Plugin rather than the MySQL Server main connection interface. For information about configuring encryption support for X Plugin, seeSection 19.4.1, “Using Encrypted Connections with X Plugin”.

  • mysqlx_ssl_crlpath

    Command-Line Format--mysqlx-ssl-crlpath=dir_name
    Introduced5.7.12
    System Variablemysqlx_ssl_crlpath
    ScopeGlobal
    DynamicNo
    TypeDirectory name
    Default ValueNULL

    Themysqlx_ssl_crlpath system variable is likessl_crlpath, except that it applies to X Plugin rather than the MySQL Server main connection interface. For information about configuring encryption support for X Plugin, seeSection 19.4.1, “Using Encrypted Connections with X Plugin”.

  • mysqlx_ssl_key

    Command-Line Format--mysqlx-ssl-key=file_name
    Introduced5.7.12
    System Variablemysqlx_ssl_key
    ScopeGlobal
    DynamicNo
    TypeFile name
    Default ValueNULL

    Themysqlx_ssl_key system variable is likessl_key, except that it applies to X Plugin rather than the MySQL Server main connection interface. For information about configuring encryption support for X Plugin, seeSection 19.4.1, “Using Encrypted Connections with X Plugin”.