18.2 Connection Options

When mysqlbackup creates a backup, it sends SQL commands to MySQL server using a database connection. The general connection details are the same as described in Connecting to the MySQL Server Using Command Options in the MySQL Reference Manual.

As part of the mysqlbackup invocation, specify the appropriate --user, --password, --port, and/or --socket options that are necessary to connect to the MySQL server.

You can specify the following connection-specific options in the [mysqlbackup] or [client] sections of a MySQL configuration file, or through mysqlbackup command-line options. mysqlbackup reads your default configuration files and then the my.cnf file specified on the command line.

Notes
  • mysqlbackup reads only --user, --password, --port, and --socket options from the [client] group, and ignores any other connection options.

  • If you do not provide a value for the --password, the command prompts for one from the keyboard.

  • The --host option is allowed in the configuration file for compatibility, but currently it has no effect. mysqlbackup always connects to the local server's IP address.

  • If none of the algorithms specified by --compression-algorithms are permitted by the server, connection to the server will not be established.

Options Common to mysqld
======================== 
--login-path=name
--port=port-num
--protocol={tcp|socket|pipe|memory}
--pipe [ alias for --protocol=pipe ] 
--user=name [ short option: -u ] 
--host=hostname
--socket=name
--shared-memory-base-name=value [Windows only] 
--character-sets-dir=PATH
--default-character-set=VALUE
--password[=value] [ short option: -p ] 
--connect-timeout
--ssl-mode=mode
--ssl-key=file_name
--ssl-cert=file_name
--ssl-ca=file_name
--ssl-capath=directory_name
--ssl-cipher=cipher_list
--ssl-fips-mode={OFF|ON|STRICT}
--tls-version= protocol_list
--compression-algorithms=name # For release 8.0.18 and later
--zstd-compression-level=number # For release 8.0.18 and later

Most other connection parameters used by the mysql command are recognized, but silently ignored. Unknown connection parameters cause mysqlbackup to stop.