OS Manuals

/usr/bin/mysqlxtest

The MySQL open source relational database

From mysql-9.4 9.4.0-r1 (os), captured 2026-11-05 by running mysqlxtest --help (exit 1). permalink

/usr/bin/mysqlxtest  Ver 9.4.0 for Linux on x86_64 (Source distribution)
Copyright (c) 2015, 2025, Oracle and/or its affiliates.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

mysqlxtest <options> [SCHEMA]
Options:
-f, --file=<file>     Reads input from file
-I, --import=<dir>    Reads macro files from dir; required by -->import
--sql=<SQL>           Use SQL as input and execute it like in -->sql block
-e=<SQL>, --execute=<SQL> Aliases for "--sql" option
-n, --no-auth         Skip authentication which is required by -->sql block (run mode)
--no-connect-attrs    Skip send session connection attributes
--plain-auth          Use PLAIN text authentication mechanism
--cached-auth         Use SHA256_MEMORY authentication mechanism
--mysql41-auth        Use MYSQL41 authentication mechanism
--using-cap-auth      Get capabilities to check which
                      authentication mechanism are supported
--mysql57-compatible  Use features that are 5.7 compatible:
                      * limit auth-mechanisms
-u, --user=<user>     Connection user
-p, --password=<pass> Connection password
-h, --host=<host>     Connection host
-P, --port=<port>     Connection port (default:33060)
--ipv=<mode>          Force internet protocol (default:4):
                      0 - allow system to resolve IPv6 and IPv4, for example
                          resolving of 'localhost' can return both '::1' and '127.0.0.1'
                      4 - allow system to resolve only IPv4, for example
                          resolving of 'localhost' is going to return '127.0.0.1'
                      6 - allow system to resolve only IPv6, for example
                          resolving of 'localhost' is going to return '::1'
-t, --timeout=<ms>    I/O timeouts in milliseconds
--close-no-sync       Do not wait for connection to be closed by server(disconnect first)
--schema=<schema>     Default schema to connect to
--uri=<uri>           Connection URI
                      URI takes precedence before options like: user, host, password, port
--socket=<file>       Connection through UNIX socket
--use-socket          Connection through UNIX socket, using default file name '/run/mysqld/mysqlx.sock'
                      --use-socket* options take precedence before options like: uri, user,
                      host, password, port
--compression-mode=<mode>  Enable/disable compression negotiation algorithm (default: "DISABLED")
                      "DISABLED" - do not negotiate compression
                      "PREFERRED" - if server doesn't support selected compression, continue without compression.
                      "REQUIRED" - if server doesn't support selected compression, fail the connection.
--compression-algorithm=<algo[,algo...]>  Try to negotiate specified compression algorithm with the server (default:"DEFLATE_STREAM,LZ4_MESSAGE,ZSTD_STREAM")
                      "" - compression not enabled
                      "DEFLATE_STREAM" - zlib compression enabled
                      "LZ4_MESSAGE" - lz4f compression enabled
                      "ZSTD_STREAM" - zstd compression enabled
--compression-combine-mixed-messages=<0/1>  If 1, server is allowed to combine different message types into a compressed message (default: 1)
--compression-max-combine-messages=<N>  If set, the server MUST not store more than N uncompressed messages into a compressed message (default: no limit)
--compression-level=<N>  If set, the server MUST compress messages with given level N; otherwise the server use default level (depend on compression algorithm)
--ssl-mode            SSL configuration (default: "")
                      "" - require encryption when at last one ssl option is set, otherwise is should be disabled.
                      "PREFERRED" - encryption is optional, client tries to set it up
                      "DISABLED" - encryption is disabled
                      "REQUIRED" - encryption is required
                      "VERIFY_CA" - verify server certificate
                      "VERIFY_IDENTITY" - verify certificate issuer
--ssl-key             X509 key in PEM format
--ssl-ca              CA file in PEM format
--ssl-ca_path         CA directory
--ssl-cert            X509 cert in PEM format
--ssl-cipher          SSL cipher to use
--tls-version         TLS version to use
--ssl-fips-mode       Fips mode to use
--connect-expired-password Allow expired password
--client-interactive  Connect in interactive mode
--quiet               Don't print out messages sent
-vVARIABLE_NAME=VALUE Set variable VARIABLE_NAME from command line
--fatal-errors=<0|1>  Mysqlxtest is started with ignoring or stopping on fatal error (default: 1)
--expect-error=<error_code> Default connection must fail with specified code (default: OFF)
-B, --bindump         Dump binary representation of messages sent, in format suitable for
--trace-protocol      Enable X Protocol tracing
--history-protocol=<0|1|true|false>
                      Enable/disable X Protocol message tracing into
                      history buffer, which is printed at test failure
--verbose             Enable extra verbose messages
--daemon              Work as a daemon (unix only)
--help                Show command line help
--help-commands       Show help for input commands
-V, --version         Show version of mysqlxtest

Only one option that changes run mode is allowed.
Options (44)
OptionDescriptionSource
-f, --file fileReads input from filehelp
-I, --import dirReads macro files from dir;help
--sql SQLUse SQL as input and execute it like in -->sql blockhelp
-n, --no-authSkip authentication which is required by -->sql block (run mode)help
--no-connect-attrsSkip send session connection attributeshelp
--plain-authUse PLAIN text authentication mechanismhelp
--cached-authUse SHA256_MEMORY authentication mechanismhelp
--mysql41-authUse MYSQL41 authentication mechanismhelp
--using-cap-authGet capabilities to check which authentication mechanism are supportedhelp
--mysql57-compatibleUse features that are 5.7 compatible: * limit auth-mechanismshelp
-u, --user userConnection userhelp
-h, --host hostConnection hosthelp
-P, --port portConnection port (default:33060)help
--ipv modeForce internet protocol (default:4): 0 - allow system to resolve IPv6 and IPv4, for example resolving of 'localhost' can return both '::1' and '127.0.0.1' 4 - allow system to resolve only IPv4, for…help
-t, --timeout msI/O timeouts in millisecondshelp
--close-no-syncDo not wait for connection to be closed by server(disconnect first)help
--schema schemaDefault schema to connect tohelp
--uri uriConnection URI URI takes precedence before options like: user, host, password, porthelp
--socket fileConnection through UNIX sockethelp
--use-socketConnection through UNIX socket, using default file name '/run/mysqld/mysqlx.sock'help
--compression-mode modeEnable/disable compression negotiation algorithm (default: "DISABLED") "DISABLED" - do not negotiate compression "PREFERRED" - if server doesn't support selected compression, continue without…help
--compression-algorithm algoTry to negotiate specified compression algorithm with the server (default:"DEFLATE_STREAM,LZ4_MESSAGE,ZSTD_STREAM") "" - compression not enabled "DEFLATE_STREAM" - zlib compression enabled…help
--compression-combine-mixed-messages 0/1If 1, server is allowed to combine different message types into a compressed message (default: 1)help
--compression-max-combine-messages NIf set, the server MUST not store more than N uncompressed messages into a compressed message (default: no limit)help
--compression-level NIf set, the server MUST compress messages with given level N;help
--ssl-modeSSL configuration (default: "") "" - require encryption when at last one ssl option is set, otherwise is should be disabled.help
--ssl-keyX509 key in PEM formathelp
--ssl-caCA file in PEM formathelp
--ssl-ca_pathCA directoryhelp
--ssl-certX509 cert in PEM formathelp
--ssl-cipherSSL cipher to usehelp
--tls-versionTLS version to usehelp
--ssl-fips-modeFips mode to usehelp
--client-interactiveConnect in interactive modehelp
--quietDon't print out messages senthelp
--fatal-errors 0|1Mysqlxtest is started with ignoring or stopping on fatal error (default: 1)help
-B, --bindumpDump binary representation of messages sent, in format suitable forhelp
--trace-protocolEnable X Protocol tracinghelp
--history-protocol 0|1|true|falseEnable/disable X Protocol message tracing into history buffer, which is printed at test failurehelp
--verboseEnable extra verbose messageshelp
--daemonWork as a daemon (unix only)help
--helpShow command line helphelp
--help-commandsShow help for input commandshelp
-V, --versionShow version of mysqlxtesthelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.