/usr/bin/mysqlxtest Ver 9.7.2-2 for Linux on x86_64 (Source distribution)
Copyright (c) 2009-2026 Percona LLC and/or its affiliates
Copyright (c) 2015, 2026, 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,-x, --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
--import-env Import all environment variables as mysqlxtest variables, prefixing each variable name with a dollar sign ('$')
--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 (45)
| Option | Description | Source |
|---|
-f, -x, --file file | Reads input from file | help |
-I, --import dir | Reads macro files from dir; | help |
--sql SQL | Use SQL as input and execute it like in -->sql block | help |
-n, --no-auth | Skip authentication which is required by -->sql block (run mode) | help |
--no-connect-attrs | Skip send session connection attributes | help |
--plain-auth | Use PLAIN text authentication mechanism | help |
--cached-auth | Use SHA256_MEMORY authentication mechanism | help |
--mysql41-auth | Use MYSQL41 authentication mechanism | help |
--using-cap-auth | Get capabilities to check which authentication mechanism are supported | help |
--mysql57-compatible | Use features that are 5.7 compatible: * limit auth-mechanisms | help |
-u, --user user | Connection user | help |
-h, --host host | Connection host | help |
-P, --port port | Connection port (default:33060) | help |
--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… | help |
-t, --timeout ms | I/O timeouts in milliseconds | help |
--close-no-sync | Do not wait for connection to be closed by server(disconnect first) | help |
--schema schema | Default schema to connect to | help |
--uri uri | Connection URI URI takes precedence before options like: user, host, password, port | help |
--socket file | Connection through UNIX socket | help |
--use-socket | Connection through UNIX socket, using default file name '/run/mysqld/mysqlx.sock' | help |
--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… | help |
--compression-algorithm 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… | help |
--compression-combine-mixed-messages 0/1 | If 1, server is allowed to combine different message types into a compressed message (default: 1) | help |
--compression-max-combine-messages N | If set, the server MUST not store more than N uncompressed messages into a compressed message (default: no limit) | help |
--compression-level N | If set, the server MUST compress messages with given level N; | help |
--ssl-mode | SSL configuration (default: "") "" - require encryption when at last one ssl option is set, otherwise is should be disabled. | help |
--ssl-key | X509 key in PEM format | help |
--ssl-ca | CA file in PEM format | help |
--ssl-ca_path | CA directory | help |
--ssl-cert | X509 cert in PEM format | help |
--ssl-cipher | SSL cipher to use | help |
--tls-version | TLS version to use | help |
--ssl-fips-mode | Fips mode to use | help |
--client-interactive | Connect in interactive mode | help |
--quiet | Don't print out messages sent | help |
--fatal-errors 0|1 | Mysqlxtest is started with ignoring or stopping on fatal error (default: 1) | help |
-B, --bindump | Dump binary representation of messages sent, in format suitable for | help |
--trace-protocol | Enable X Protocol tracing | help |
--history-protocol 0|1|true|false | Enable/disable X Protocol message tracing into history buffer, which is printed at test failure | help |
--import-env | Import all environment variables as mysqlxtest variables, prefixing each variable name with a dollar sign ('$') | help |
--verbose | Enable extra verbose messages | help |
--daemon | Work as a daemon (unix only) | help |
--help | Show command line help | help |
--help-commands | Show help for input commands | help |
-V, --version | Show version of mysqlxtest | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.