Parameter |
Choices/Defaults |
Comments |
collation
|
|
Collation mode (sorting). This only applies to new table/databases and does not update existing ones, this is a limitation of MySQL.
|
config_file
(added in 2.0) |
Default:
~/.my.cnf
|
Specify a config file from which user and password are to be read.
|
connect_timeout
(added in 2.1) |
Default:
30
|
The connection timeout when connecting to the MySQL server.
|
encoding
|
|
Encoding mode to use, examples include utf8 or latin1_swedish_ci
|
ignore_tables
(added in 2.7) |
Default:
[]
|
A list of table names that will be ignored in the dump of the form database_name.table_name
|
login_host
|
Default:
localhost
|
Host running the database.
|
login_password
|
|
The password used to authenticate with.
|
login_port
|
Default:
3306
|
Port of the MySQL server. Requires login_host be defined as other then localhost if login_port is used.
|
login_unix_socket
|
|
The path to a Unix domain socket for local connections.
|
login_user
|
|
The username used to authenticate with.
|
name
required |
|
name of the database to add or remove
name=all May only be provided if state is dump or import .
if name=all Works like --all-databases option for mysqldump (Added in 2.0)
aliases: db
|
quick
bool
(added in 2.1) |
|
Option used for dumping large tables
|
single_transaction
bool
(added in 2.1) |
|
Execute the dump in a single transaction
|
ssl_ca
(added in 2.0) |
|
The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate as used by the server.
|
ssl_cert
(added in 2.0) |
|
The path to a client public key certificate.
|
ssl_key
(added in 2.0) |
|
The path to the client private key.
|
state
|
Choices:
present ←
- absent
- dump
- import
|
The database state
|
target
|
|
Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL files (.sql ) as well as bzip2 (.bz2 ), gzip (.gz ) and xz (Added in 2.0) compressed files are supported.
|