6.5.8.1 Options

mysqldm accepts MySQL standard connection options and several mysqldm-specific options.

mysqldm-specific options

Table 6.17 mysqldm options

Option Name	Description
--authentication-oci-client-config-profile	Name of the OCI profile defined in the OCI config file to use
--authentication-openid-connect-client-id-token-file	Full path to the OpenID Connect Identity token file
--character-sets-dir	Directory where character sets are installed
--compress	Compress all information sent between client and server
--compression-algorithms	Permitted compression algorithms for connections to server
--debug	Write debugging log; supported only if MySQL was built with debugging support
--default-auth	Authentication plugin to use
--defaults-extra-file	Read named option file in addition to usual option files
--defaults-file	Read only named option file
--defaults-group-suffix	Option group suffix value
--delay	Number of seconds between iterations
--enable-cleartext-plugin	Enable cleartext authentication plugin
--get-server-public-key	Request RSA public key from server
--help	Display help message and exit
--host	Host on which MySQL server is located
--iterations	Number of iterations
--login-path	Read login path options from .mylogin.cnf
--no-defaults	Read no option files
--no-login-paths	Do not read login paths from the login path file
--oci-config-file	Defines an alternate location for the Oracle Cloud Infrastructure CLI configuration file.
--output-dir	Path where output is written
--password	Password to use when connecting to server
--password1	First multifactor authentication password to use when connecting to server
--password2	Second multifactor authentication password to use when connecting to server
--password3	Third multifactor authentication password to use when connecting to server
--pipe	Connect to server using named pipe (Windows only)
--plugin-authentication-kerberos-client-mode	Permit GSSAPI pluggable authentication through the MIT Kerberos library on Windows
--plugin-authentication-webauthn-client-preserve-privacy	Permit user to choose a key to be used for assertion
--plugin-authentication-webauthn-device	Specifies which libfido2 device to use. Default is 0 (first device)
--plugin-dir	Directory where plugins are installed
--port	TCP/IP port number for connection
--print-defaults	Print default options
--protocol	Transport protocol to use
--server-public-key-path	Path name to file containing RSA public key
--shared-memory-base-name	Shared-memory name for shared-memory connections (Windows only)
--socket	Unix socket file or Windows named pipe to use
--ssl-ca	File that contains list of trusted SSL Certificate Authorities
--ssl-capath	Directory that contains trusted SSL Certificate Authority certificate files
--ssl-cert	File that contains X.509 certificate
--ssl-cipher	Permissible ciphers for connection encryption
--ssl-crl	File that contains certificate revocation lists
--ssl-crlpath	Directory that contains certificate revocation-list files
--ssl-fips-mode	Whether to enable FIPS mode on client side
--ssl-key	File that contains X.509 key
--ssl-mode	Desired security state of connection to server
--ssl-session-data	File that contains SSL session data
--ssl-session-data-continue-on-failed-reuse	Whether to establish connections if session reuse fails
--tls-ciphersuites	Permissible TLSv1.3 ciphersuites for encrypted connections
--tls-sni-servername	Server name supplied by the client
--tls-version	Permissible TLS protocols for encrypted connections
--user	MySQL user name to use when connecting to server
--version	Display version information and exit
--zstd-compression-level	Compression level for connections to server that use zstd compression

• --delay=numberOfSeconds

  Command-Line Format	--delay=#
  Type	Integer
  Default Value	30

  A length of delay between diagnostic iterations, in seconds.

• --iterations=numberOfIterations

  Command-Line Format	--iterations=#
  Type	Integer
  Default Value	10

  The number of diagnostic iterations.

• --output-dir=path

  Command-Line Format	--output-dir=path
  Type	String
  Default Value	.

  The path where the diagnostics archive is generated. A temporary directory containing the generated files is also created at this location, then deleted when the diagnostics are complete and the archive generated.

mysqldm Server options

This section lists the common server options used by mysqldm.

• --help, -?

  Command-Line Format	--help

  Display a help message and exit.

• --authentication-oci-client-config-profile

  Command-Line Format	--authentication-oci-client-config-profile=profileName
  Type	String

  Specify the name of the OCI configuration profile to use. If not set, the default profile is used.

• --authentication-openid-connect-client-id-token-file

  Command-Line Format	--authentication-openid-connect-client-id-token-file

  For OpenID Connect, this sets the required Identity token to authenticate with a mapped MySQL user. It's a full filepath to the Identity token file used when connecting to the MySQL server. For additional information, see Section 8.4.1.9, “OpenID Connect Pluggable Authentication”.

• --character-sets-dir=dir_name

  Command-Line Format	--character-sets-dir=dir_name
  Type	Directory name

  The directory where character sets are installed. See Section 12.15, “Character Set Configuration”.

• --compress, -C

  Command-Line Format	--compress[={OFF|ON}]
  Type	Boolean
  Default Value	OFF

  Compress all information sent between the client and the server if possible. See Section 6.2.8, “Connection Compression Control”.

  This option is deprecated. Expect it to be removed in a future version of MySQL. See Configuring Legacy Connection Compression.

• --compression-algorithms=value

  Command-Line Format	--compression-algorithms=value
  Type	Set
  Default Value	uncompressed
  Valid Values	zlib zstd uncompressed

  The permitted compression algorithms for connections to the server. The available algorithms are the same as for the protocol_compression_algorithms system variable. The default value is uncompressed.

  For more information, see Section 6.2.8, “Connection Compression Control”.

• --debug[=debug_options], -# [debug_options]

  Command-Line Format	--debug[=debug_options]
  Type	String
  Default Value	d:t:o,/tmp/mysql.trace

  Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o,/tmp/mysql.trace.

  This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option.

• --default-auth=plugin

  Command-Line Format	--default-auth=plugin
  Type	String

  A hint about which client-side authentication plugin to use. See Section 8.2.17, “Pluggable Authentication”.

• --defaults-extra-file=file_name

  Command-Line Format	--defaults-extra-file=file_name
  Type	File name

  Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory.

  For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --defaults-file=file_name

  Command-Line Format	--defaults-file=file_name
  Type	File name

  Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory.

  Exception: Even with --defaults-file, client programs read .mylogin.cnf.

  For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --defaults-group-suffix=str

  Command-Line Format	--defaults-group-suffix=str
  Type	String

  Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysql normally reads the [client] and [mysql] groups. If this option is given as --defaults-group-suffix=_other, mysql also reads the [client_other] and [mysql_other] groups.

  For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --enable-cleartext-plugin

  Command-Line Format	--enable-cleartext-plugin
  Type	Boolean
  Default Value	FALSE

  Enable the mysql_clear_password cleartext authentication plugin. (See Section 8.4.1.3, “Client-Side Cleartext Pluggable Authentication”.)

• --get-server-public-key

  Command-Line Format	--get-server-public-key
  Type	Boolean

  Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with the caching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

  If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key.

  For information about the caching_sha2_password plugin, see Section 8.4.1.1, “Caching SHA-2 Pluggable Authentication”.

• --host=host_name, -h host_name

  Command-Line Format	--host=host_name
  Type	String
  Default Value	localhost

  Connect to the MySQL server on the given host.

• --login-path=name

  Command-Line Format	--login-path=name
  Type	String

  Read options from the named login path in the .mylogin.cnf login path file. A “login path” is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use the mysql_config_editor utility. See Section 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.

  For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --no-login-paths

  Command-Line Format	--no-login-paths

  Skips reading options from the login path file.

  See --login-path for related information.

  For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --no-defaults

  Command-Line Format	--no-defaults

  Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read.

  The exception is that the .mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when --no-defaults is used. To create .mylogin.cnf, use the mysql_config_editor utility. See Section 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.

  For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --oci-config-file=PATH

  Command-Line Format	--oci-config-file
  Type	String
  Default Value

  Alternate path to the Oracle Cloud Infrastructure CLI configuration file. Specify the location of the configuration file. If your existing default profile is the correct one, you do not need to specify this option. However, if you have an existing configuration file, with multiple profiles or a different default from the tenancy of the user you want to connect with, specify this option.

• --password[=password], -p[password]

  Command-Line Format	--password[=password]
  Type	String

  The password of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqldm prompts for one. If given, there must be no space between --password= or -p and the password following it. If no password option is specified, the default is to send no password.

  Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 8.1.2.1, “End-User Guidelines for Password Security”.

• --password1[=pass_val]

  The password for multifactor authentication factor 1 of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqldm prompts for one. If given, there must be no space between --password1= and the password following it. If no password option is specified, the default is to send no password.

  Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 8.1.2.1, “End-User Guidelines for Password Security”.

  --password1 and --password are synonymous.

• --password2[=pass_val]

  The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details.

• --password3[=pass_val]

  The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details.

• --pipe, -W

  Command-Line Format	--pipe
  Type	String

  On Windows, connect to the server using a named pipe. This option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable.

• --plugin-authentication-kerberos-client-mode=value

  Command-Line Format	--plugin-authentication-kerberos-client-mode
  Type	String
  Default Value	SSPI
  Valid Values	GSSAPI SSPI

  On Windows, the authentication_kerberos_client authentication plugin supports this plugin option. It provides two possible values that the client user can set at runtime: SSPI and GSSAPI.

  The default value for the client-side plugin option uses Security Support Provider Interface (SSPI), which is capable of acquiring credentials from the Windows in-memory cache. Alternatively, the client user can select a mode that supports Generic Security Service Application Program Interface (GSSAPI) through the MIT Kerberos library on Windows. GSSAPI is capable of acquiring cached credentials previously generated by using the kinit command.

  For more information, see Commands for Windows Clients in GSSAPI Mode.

• --plugin-authentication-webauthn-client-preserve-privacy={OFF|ON}

  Command-Line Format	--plugin-authentication-webauthn-client-preserve-privacy
  Type	Boolean
  Default Value	OFF

  Determines how assertions are sent to server in case there is more than one discoverable credential stored for a given RP ID (a unique name given to the relying-party server, which is the MySQL server). If the FIDO2 device contains multiple resident keys for a given RP ID, this option allows the user to choose a key to be used for assertion. It provides two possible values that the client user can set. The default value is OFF. If set to OFF, the challenge is signed by all credentials available for a given RP ID and all signatures are sent to server. If set to ON, the user is prompted to choose the credential to be used for signature.

  Note

  This option has no effect if the device does not support the resident-key feature.

  For more information, see Section 8.4.1.11, “WebAuthn Pluggable Authentication”.

• --plugin-authentication-webauthn-device=#

  Command-Line Format	--plugin-authentication-webauthn-device
  Type	Integer
  Default Value	0

  Determiens which device to use for libfido authentication. The default is the first device (0).

  Note

  Specifying a nonexistent device raises an error.

  For more information, see Section 8.4.1.11, “WebAuthn Pluggable Authentication”.

• --plugin-dir=dir_name

  Command-Line Format	--plugin-dir=dir_name
  Type	Directory name

  The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authentication plugin but mysqldm does not find it. See Section 8.2.17, “Pluggable Authentication”.

• --port=port_num, -P port_num

  Command-Line Format	--port=port_num
  Type	Numeric
  Default Value	3306

  For TCP/IP connections, the port number to use.

• --print-defaults

  Command-Line Format	--print-defaults

  Print the program name and all options that it gets from option files.

  For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --protocol={TCP|SOCKET|PIPE|MEMORY}

  Command-Line Format	--protocol=type
  Type	String
  Default Value	[see text]
  Valid Values	TCP SOCKET PIPE MEMORY

  The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 6.2.7, “Connection Transport Protocols”.

• --server-public-key-path=file_name

  Command-Line Format	--server-public-key-path=file_name
  Type	File name

  The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with the sha256_password or caching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

  If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key.

  For sha256_password, this option applies only if MySQL was built using OpenSSL.

  For information about the sha256_password and caching_sha2_password plugins, see Section 8.4.1.2, “SHA-256 Pluggable Authentication”, and Section 8.4.1.1, “Caching SHA-2 Pluggable Authentication”.

• --shared-memory-base-name=name

  Command-Line Format	--shared-memory-base-name=name
  Platform Specific	Windows

  On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value is MYSQL. The shared-memory name is case-sensitive.

  This option applies only if the server was started with the shared_memory system variable enabled to support shared-memory connections.

• --socket=path, -S path

  Command-Line Format	--socket={file_name|pipe_name}
  Type	String

  For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.

  On Windows, this option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable.

• --ssl*

  Options that begin with --ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See Command Options for Encrypted Connections.

• --ssl-fips-mode={OFF|ON|STRICT}

  Command-Line Format	--ssl-fips-mode={OFF|ON|STRICT}
  Type	Enumeration
  Default Value	OFF
  Valid Values	OFF ON STRICT

  Controls whether to enable FIPS mode on the client side. The --ssl-fips-mode option differs from other --ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 8.8, “FIPS Support”.

  These --ssl-fips-mode values are permitted:

  • OFF: Disable FIPS mode.

  • ON: Enable FIPS mode.

  • STRICT: Enable “strict” FIPS mode.

  Note

  If the OpenSSL FIPS Object Module is not available, the only permitted value for --ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes the client to produce a warning at startup and to operate in non-FIPS mode.

  This option is deprecated. Expect it to be removed in a future version of MySQL.

• --tls-ciphersuites=ciphersuite_list

  Command-Line Format	--tls-ciphersuites=ciphersuite_list
  Type	String

  The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

• --tls-sni-servername=server_name

  Command-Line Format	--tls-sni-servername=server_name
  Type	String

  When specified, the name is passed to the libmysqlclient C API library using the MYSQL_OPT_TLS_SNI_SERVERNAME option of mysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check the Tls_sni_server_name status variable.

  Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only.

• --tls-version=protocol_list

  Command-Line Format	--tls-version=protocol_list
  Type	String
  Default Value	TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 (OpenSSL 1.1.1 or higher) TLSv1,TLSv1.1,TLSv1.2 (otherwise)

  The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

• --user=user_name, -u user_name

  Command-Line Format	--user=user_name
  Type	String

  The user name of the MySQL account to use for connecting to the server.

• --version, -V

  Command-Line Format	--version

  Display version information and exit.

• --zstd-compression-level=level

  Command-Line Format	--zstd-compression-level=#
  Type	Integer

  The compression level to use for connections to the server that use the zstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The default zstd compression level is 3. The compression level setting has no effect on connections that do not use zstd compression.

  For more information, see Section 6.2.8, “Connection Compression Control”.