# mariadb-dump
The `mariadb-dump` client is a backup program originally written by Igor Romanenko.
{% hint style="info" %}
Previously, the client used to be called `mysqldump`, and can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows. From MariaDB 11.0, the symlink `mysqldump` is deprecated and removed from the `mariadb` Docker Official Image.
{% endhint %}
`mariadb-dump` generates a command at the beginning of the dump to enable [sandbox mode](https://mariadb.com/docs/server/mariadb-client/mariadb-command-line-client#sandbox). This command cannot be interpreted by earlier versions of the `mariadb` command-line client or by the MySQL command-line client `mysql` – an error is thrown if used against client versions that do not support it. This does not affect other methods of importing the data.
`mariadb-dump` is used to dump a database or a collection of databases for backup, or transferring data to another database server (not necessarily MariaDB or MySQL). The dump contains SQL statements to create databases, tables, table data, and more. It can also be used to generate files in CSV, XML, or other formats that use delimiters.
{% hint style="info" %}
If you are doing a backup on the server and all your tables are [MyISAM](https://mariadb.com/docs/server/server-usage/storage-engines/myisam-storage-engine) tables, consider using [mariadb-hotcopy](https://mariadb.com/docs/server/clients-and-utilities/backup-restore-and-import-clients/mariadb-hotcopy) instead, because it can accomplish faster backups and faster restores.
{% endhint %}
`mariadb-dump` dumps trigger along with tables, as these are part of the table definition. However, [stored procedures](https://mariadb.com/docs/server/server-usage/stored-routines/stored-procedures), [views](https://mariadb.com/docs/server/server-usage/views), and [events](https://mariadb.com/docs/server/server-usage/triggers-events/event-scheduler/events) are not dumped, and need extra parameters to be recreated explicitly (for example, `--routines` and `--events`). [Procedures](https://mariadb.com/docs/server/server-usage/stored-routines/stored-procedures) and [functions](https://mariadb.com/docs/server/server-usage/stored-routines/stored-functions) are also part of the system tables (for example, [mysql.proc](https://mariadb.com/docs/server/reference/system-tables/the-mysql-database-tables/mysql-proc-table)).
`mariadb-dump` supports the [enhancements for START TRANSACTION WITH CONSISTENT SNAPSHOT](https://mariadb.com/docs/server/ha-and-performance/standard-replication/enhancements-for-start-transaction-with-consistent-snapshot#mariadb-dump).
## Performance
`mariadb-dump` doesn't consume much CPU – by default, it uses a single thread. This method is good for a heavily loaded server.
Disk input/output per second (IOPS) can, however, increase for multiple reasons. When backing up on the same device as the database, this produces unnecessary random IOPS. The dump is done sequentially, on a per-table basis, causing a full table scan and many buffer page misses on tables that are not fully cached in memory.
{% hint style="warning" %}
It's recommended that you back up from a network location to remove disk IOPS on the database server, but it is vital to use a separate network card to keep network bandwidth available for regular traffic.
{% endhint %}
Although `mariadb-dump` by default preserves your resources for regular spindle disks and low-core hardware, this doesn't mean that concurrent dumps cannot benefit from hardware architecture like SAN, flash storage, or low write workload. The backup time would benefit from a tool such as MyDumper.
## Usage
There are four general ways to invoke `mariadb-dump`:
```bash
shell> mariadb-dump [options] db_name [tbl_name ...]
shell> mariadb-dump [options] --databases db_name ...
shell> mariadb-dump [options] --all-databases
shell> mariadb-dump [options] --system=[option_list]
```
If you do not name any tables after specifying `db_name`, or if you use the `--databases` or `--all-databases` option, entire databases are dumped.
`mariadb-dump` does not dump the `INFORMATION_SCHEMA` (or `PERFORMANCE_SCHEMA`, if enabled) database by default. MariaDB dumps the `INFORMATION_SCHEMA` if you name it explicitly on the command line, although you must also use the `--skip-lock-tables` option.
To see a list of the options your version of `mariadb-dump` supports, execute `mariadb-dump --help`.
## Row by Row vs. Buffering
`mariadb-dump` can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it. Buffering in memory can be a problem if you are dumping large tables. To dump tables row by row, use the `--quick` option (or `--opt`, which enables `--quick`). The `--opt` option (and hence `--quick`) is enabled by default, so to enable memory buffering, use `--skip-quick`.
## mysql.transaction\_registry\_table
`mariadb-dump` includes logic to cater for the [mysql.transaction\_registry table](https://mariadb.com/docs/server/reference/system-tables/the-mysql-database-tables/mysql-transaction_registry-table).
## Old Versions of MySQL
If you are using a recent version of `mariadb-dump` to generate a dump to be reloaded into a very old MySQL server, you should *not* use the `--opt` or `--extended-insert` option. Use `--skip-opt` instead.
## Options
`mariadb-dump` supports the following options:
### Scope
#### --all
Deprecated. Use --create-options instead.
#### -A, --all-databases
Dump all the databases. This is the same as `--databases` with all databases selected.
#### -Y, --all-tablespaces
Dump all the tablespaces.
#### -y, --no-tablespaces
Do not dump any tablespace information.
### Other Options
#### --add-drop-database
Add a [DROP DATABASE](https://mariadb.com/docs/server/reference/sql-statements/data-definition/drop/drop-database) before each create. Typically used in conjunction with the `--all-databases` or `--databases` option, because no [CREATE DATABASE](https://mariadb.com/docs/server/reference/sql-statements/data-definition/create/create-database) statements are written, unless one of those options is specified.
#### --add-drop-table
Add a [DROP TABLE](https://mariadb.com/docs/server/server-usage/tables/drop-table) before each create.
#### --add-drop-trigger
Add a [DROP TRIGGER](https://mariadb.com/docs/server/reference/sql-statements/data-definition/drop/drop-trigger) statement before each [CREATE TRIGGER](https://mariadb.com/docs/server/server-usage/triggers-events/triggers/create-trigger).
#### --add-locks
Add locks around [INSERT](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/insert) statements, which results in faster inserts when the dump file is reloaded. Use --skip-add-locks to disable.
#### --allow-keywords
Allow creation of column names that are keywords. This works by prefixing each column name with the table name.
#### --apply-slave-statements
Adds [STOP SLAVE](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/stop-replica) prior to [CHANGE MASTER](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/change-master-to) and [START SLAVE](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/start-replica) to the bottom of the dump.
#### --as-of=name
As of the given timestamp, dump the [system versioned table(s)](https://mariadb.com/docs/server/reference/sql-structure/temporal-tables/system-versioned-tables). Note that table structures are always dumped regardless of the date/time specified; only the data is filtered by the timestamp. The `--tz-utc` setting is used to understand the timestamp argument; for important interaction details, see [--tz-utc](#tz-utc). This option is available from MariaDB 10.7.
If no data is available for the specified timestamp (for example, a date before any records were entered), only the table structure (CREATE, TABLE statement) will be dumped.
For example:
```
CREATE TABLE t1 (a INT) WITH SYSTEM VERSIONING;
INSERT t1 (a) VALUES (1),(2),(3);
DELETE FROM t1 WHERE a=1;
```
Dump result:
```
./bin/mysqldump -uroot -S./socket.sock --compact --as-of="1990-01-01 00:01" test t1
```
This dumps the table structure but not the data (since no records existed at that time). See [MDEV-26943](https://jira.mariadb.org/browse/MDEV-26943) for more information regarding the interaction with `--tz-utc`.
Note: When `--tz-utc` is enabled (which is the default), the timestamp value supplied to `--as-of` is interpreted in UTC. Remember that the effective filter time can differ if you are passing a local time. See [--tz-utc](#tz-utc) and [--skip-tz-utc](#skip-tz-utc).
#### --character-sets-dir=name
Directory for [character set](https://mariadb.com/docs/server/reference/data-types/string-data-types/character-sets) files.
#### -i, --comments
Write additional information in the dump file, such as program version, server version, and host. Disable with `--skip-comments`.
#### --compact
Give less verbose output (useful for debugging). Disables structure comments and header/footer constructs. Enables the `--skip-add-drop-table`, `--skip-add-locks`, `--skip-comment`s, `--skip-disable-keys`, and `--skip-set-charset` options.
#### --compatible=name
Change the dump to be compatible with a given mode. By default, tables are dumped in a format optimized for MariaDB and MySQL. Legal modes are: ansi, `mysql323`, `mysql40`, `postgresql`, `oracle`, `mssql`, `db2`, `maxdb`, `no_key_options`, `no_table_options`, and `no_field_options`. You can use several modes, separated by commas. This option does not guarantee compatibility with other servers. It only enables those SQL mode values that are available for making dump output more compatible. For example, `--compatible=oracle` does not map data types to Oracle types or use Oracle comment syntax.
#### -c, --complete-insert
Use complete [INSERT](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/insert) statements that include column names.
#### -C, --compress
Use compression in the server/client protocol. Both client and server must support compression for this to work.
#### --copy-s3-tables
By default, [S3](https://mariadb.com/docs/server/server-usage/storage-engines/s3-storage-engine) tables are ignored. With this option set, the result file will contain a `CREATE` statement for a similar [Aria](https://mariadb.com/docs/server/server-usage/storage-engines/aria) table, followed by the table data and ending with an ` ALTER TABLE`` `` `*`table`*` `` ``ENGINE=S3 `.
#### -a, --create-options
Include all MariaDB and/or MySQL-specific create options in `CREATE TABLE` statements. Use `--skip-create-options` to disable.
#### -B, --databases
Dump several databases. Normally, `mariadb-dump` treats the first name argument on the command line as a database name and the following names as table names. With this option, it treats all name arguments as database names. [CREATE DATABASE](https://mariadb.com/docs/server/reference/sql-statements/data-definition/create/create-database) and [USE](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/use-database) statements are included in the output before each new database.
#### -#, --debug\[=#]
If using a debug version of MariaDB, write a debugging log. A typical `debug_options` string is `d:t:o,file_name`. The default value is `d:t:o,/tmp/mysqldump.trace`. If using a non-debug version, `mariadb-dump` will catch this and exit.
#### --debug-check
Check memory and open file usage at exit.
#### --debug-info
Print some debug info at exit.
#### --default-auth=*name*
Default authentication client-side plugin to use.
#### --default-character-set=*name*
Set the default [character set](https://mariadb.com/docs/server/reference/data-types/string-data-types/character-sets) to *name*. If no character set is specified, `mariadb-dump` uses utf8mb4.
#### --defaults-extra-file=*name*
Read the file *name* after the global files are read. Must be given as the first argument.
#### --defaults-file=*name*
Only read default options from the given file *name*. Must be given as the first argument.
#### --defaults-group-suffix=*str*
Also read groups with a suffix of *str*. For example, since `mariadb-dump` normally reads the `[client]` and `[mariadb-dump]` (or `[mysqldump]`) groups, `--defaults-group-suffix=`*`x`* would cause it to also read the groups `[mariadb-dump_`*`x`*`]` (or `[mysqldump_`*`x`*`]`) and `[client_`*`x`*`]`.
#### --delayed-insert
Insert rows with [INSERT DELAYED](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/insert-delayed) instead of [INSERT](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/insert).
#### --delete-master-logs
On a primary replication server, delete the binary logs by sending a [PURGE BINARY LOGS](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/purge-binary-logs) statement to the server after performing the dump operation. This option automatically enables `--master-data=2`.
#### --dir
Parallel dump of multiple databases. Works just like `--tab`, with regard to output (sql file for table definition and tab-separated for data, same options, for example, `--parallel`). It also allows the `--databases` and `--all-databases` options. When `--dir` is used, it creates the directory structure in the output directory pointed to by `--dir`. For every database to be dumped, there is a directory with the database name. All options that `--tab` supports are also supported by `--dir`, in particular `--parallel`. This option is available from MariaDB 11.5.
#### -K, --disable-keys
'` /*!40000 ALTER TABLE`` `` `*`tb_name`*` ``DISABLE KEYS`` `*`/;` and `'/`*` !40000 ALTER TABLE`` `` `*`tb_name`*` `` ``ENABLE KEYS */; ` are written to the output. This makes loading the dump file faster because the indexes are created after all rows are inserted. This option is effective only for non-unique indexes of MyISAM tables. Disable with `--skip-disable-keys`.
#### --dump-date
If the `--comments` option and this option are given, `mariadb-dump` produces a comment at the end of the dump of the following form: ` -- Dump completed on`` `` `*`date`*. However, the date causes dump files taken at different times to appear to be different, even if the data are otherwise identical. `--dump-date` and `--skip-dump-date` control whether the date is added to the comment. The default is `--dump-date` (include the date in the comment). `--skip-dump-date` suppresses date printing.
#### -H, --dump-history
Dump tables with [history](https://mariadb.com/docs/server/reference/sql-structure/temporal-tables/system-versioned-tables). This option is available from MariaDB 10.11. Until this option was introduced, `mariadb-dump` could not read historical rows from versioned tables, and so historical data would not be backed up.
#### --dump-slave\[=value]
Used for producing a dump file from a replica server that can be used to set up another replica server with the same primary. Causes the [binary log](https://mariadb.com/docs/server/server-management/server-monitoring-logs/binary-log) position and filename of the primary to be appended to the dumped data output. Setting the value to `1` (the default) prints it as a [CHANGE MASTER](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/change-master-to) command in the dumped data output; if set to `2`, that command is prefixed with a comment symbol. This option will turn on `--lock-all-tables`, unless `--single-transaction` is specified, too (in which case a global read lock is only taken a short time at the beginning of the dump. Make sure to read about `--single-transaction` below). In all cases, any action on logs happens at the exact moment of the dump. This option automatically turns off `--lock-tables`.
{% tabs %}
{% tab title="Current" %}
This option pauses any running SQL threads during the dump.
{% endtab %}
{% tab title="< 10.11" %}
This option stops any running SQL threads before the dump, and restarts **all stopped IO and SQL** threads after completion.
{% endtab %}
{% endtabs %}
#### -E, --events
Include [Event Scheduler events](https://mariadb.com/docs/server/server-usage/triggers-events/event-scheduler) for the dumped databases in the output.
#### -e, --extended-insert
Use multiple-row [INSERT](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/insert) syntax that includes several value lists. This results in a smaller dump file and speeds up inserts when the file is reloaded. Defaults to `ON`; use `--skip-extended-insert` to disable.
#### --fields-terminated-by=*string*
Fields in the output file are terminated by the given *string*. Used with the `--tab` option and has the same meaning as the corresponding `FIELDS` clause for [LOAD DATA INFILE](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/load-data-into-tables-or-index/load-data-infile).
#### --fields-enclosed-by=*character*
Fields in the output file are enclosed by the given *character*. Used with the `--tab` option and has the same meaning as the corresponding `FIELDS` clause for [LOAD DATA INFILE](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/load-data-into-tables-or-index/load-data-infile).
#### --fields-optionally-enclosed-by=*character*
Fields in the output file are optionally enclosed by the given *character*. Used with the `--tab` option and has the same meaning as the corresponding `FIELDS` clause for [LOAD DATA INFILE](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/load-data-into-tables-or-index/load-data-infile).
#### --fields-escaped-by=*character*
Fields in the output file are escaped by the given *character*. Used with the --tab option and has the same meaning as the corresponding `FIELDS` clause for [LOAD DATA INFILE](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/load-data-into-tables-or-index/load-data-infile).
#### --first-slave
Removed in MariaDB 5.5. Use `--lock-all-tables` instead.
#### -F, --flush-logs
Flush the MariaDB server log files before starting the dump. This option requires the [RELOAD privilege](https://mariadb.com/docs/server/reference/sql-statements/account-management-sql-statements/grant#reload). If you use this option in combination with the `--databases=` or `--all-databases` option, the logs are flushed for each database dumped. The exception is when using `--lock-all-tables` or `--master-data`: In this case, the logs are flushed only once, corresponding to the moment all tables are locked. If you want your dump and the log flush to happen at the same exact moment, you should use `--flush-logs` together with either `--lock-all-tables` or `--master-data`.
#### --flush-privileges
Send a [FLUSH PRIVILEGES](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/flush-commands/flush) statement to the server after dumping the [mysql database](https://mariadb.com/docs/server/reference/system-tables/the-mysql-database-tables). This option should be used any time the dump contains the mysql database and any other database that depends on the data in the mysql database for proper restoration.
#### -f, --force
Continue even if an SQL error occurs during a table dump. One use for this option is to cause mariadb-dump to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped. Without `--force` in this example, mariadb-dump exits with an error message. With `--force`, mariadb-dump prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing.
#### --gtid
Used together with `--master-data` and `--dump-slave` to more conveniently set up a new [GTID](https://mariadb.com/docs/server/ha-and-performance/standard-replication/gtid) replica. It causes those options to output SQL statements that configure the replica to use the [global transaction ID](https://mariadb.com/docs/server/ha-and-performance/standard-replication/gtid) to connect to the primary instead of old-style filename/offset positions. The old-style positions are still included in comments when --gtid is used; likewise, the GTID position is included in comments even if `--gtid` is not used.
#### -?, --help
Display a help message and exit.
#### --hex-blob
Dump binary strings in hexadecimal format (for example, ´abc´ becomes 0x616263). The affected data types are [BINARY](https://mariadb.com/docs/server/reference/data-types/string-data-types/binary), [VARBINARY](https://mariadb.com/docs/server/reference/data-types/string-data-types/varbinary), the [BLOB](https://mariadb.com/docs/server/reference/data-types/string-data-types/blob) types, and [BIT](https://mariadb.com/docs/server/reference/data-types/numeric-data-types/bit).
#### -h name, --host=*host*
Connect to and dump data from the MariaDB or MySQL server on the given *host*. The default host is `localhost`.
#### --ignore-database=*database*
Do not dump the specified *database*. To specify more than one database to ignore, use the directive multiple times, once for each database. Only takes effect when used together with `--all-databases` or `-A`.
#### --ignore-table=*table*
Do not dump the specified *table*. To specify more than one table to ignore, use the directive multiple times, once for each table. Each table must be specified with both database and table names, for example, `--ignore-table=`*`database.table`*. This option can also be used to ignore views.
#### --ignore-table-data=*table*
Do not dump the specified *table* data (only the structure). To specify more than one table to ignore, use the directive multiple times, once for each table. Each table must be specified with both the database and table names. See also `--no-data`.
#### --include-master-host-port
Add the `MASTER_HOST` and `MASTER_PORT` options for the [CHANGE MASTER TO](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/change-master-to) statement when using the `--dump-slave` option for a replica dump.
#### --insert-ignore
Insert rows with `INSERT IGNORE` instead of `INSERT`.
#### --lines-terminated-by=*string*
Lines in the output file are terminated by the given *string*. This option is used with the `--tab` option and has the same meaning as the corresponding `LINES` clause for [LOAD DATA INFILE](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/load-data-into-tables-or-index/load-data-infile).
#### -x, --lock-all-tables
Lock all tables across all databases. This is achieved by acquiring a global read lock for the duration of the whole dump by executing [FLUSH TABLES WITH READ LOCK](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/flush-commands/flush). This option automatically turns off\
`--single-transaction` and `--lock-tables`.
#### -l, --lock-tables
For each dumped database, lock all tables to be dumped before dumping them. The tables are locked with `READ LOCAL` to allow concurrent inserts in the case of [MyISAM](https://mariadb.com/docs/server/server-usage/storage-engines/myisam-storage-engine) tables. For transactional tables such as [InnoDB](https://mariadb.com/docs/server/server-usage/storage-engines/innodb), `--single-transaction` is a much better option than `--lock-tables` because it does not need to lock the tables at all. Because `--lock-tables` locks tables for each database separately, this option does not guarantee that the tables in the dump file are logically consistent between databases. Tables in different databases may be dumped in completely different states. Use `--skip-lock-tables` to disable.
#### -L, --wildcards
{% hint style="info" %}
This option is available from MariaDB 12.1.
{% endhint %}
Usage of wildcards in the table or database name. Without the [--databases](#b-databases) option, wildcards are only recognized in table names.
#### --log-error=*file*
Log warnings and errors by appending them to the named *file*. The default is no logging.
#### --log-queries
When restoring the dump, if logging is turned on, the server logs queries to the general and [slow query log](https://mariadb.com/docs/server/server-management/server-monitoring-logs/slow-query-log). Defaults to `ON`; use `--skip-log-queries` to disable.
#### --master-data\[=#]
Causes the [binary log](https://mariadb.com/docs/server/server-management/server-monitoring-logs/binary-log) position and filename to be appended to the output, useful for dumping a primary replication server to produce a dump file that can be used to set up another server as a replica of the primary. These are the primary server coordinates from which the replica should start replicating after you load the dump file into the replica.
If the option is set to `1` (the default), print it as a [CHANGE MASTER](https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/change-master-to) command; if set to `2`, that command is prefixed with a comment symbol. This `--master-data` option turns `--lock-all-tables` on, unless `--single-transaction` is specified, too. In all cases, any action on logs will happen at the exact moment of the dump. This option automatically turns `--lock-tables` off. In all cases, any action on logs happens at the exact moment of the dump. It is also possible to set up a replica by dumping an existing replica of the primary. To do this, use the following procedure on the existing replica:
{% stepper %}
{% step %}
Stop the SQL thread of the replica and get its current status.
```sql
STOP SLAVE SQL_THREAD;
SHOW REPLICA STATUS;
```
{% endstep %}
{% step %}
From the output of the `SHOW REPLICA STATUS` statement, the binary log coordinates of the primary server from which the new replica should start replicating are the values of the `Relay_Master_Log_File` and `Exec_Master_Log_Pos` fields. Denote those values as `file_name` and `file_pos`.
{% endstep %}
{% step %}
Dump the replica server.
```bash
mariadb-dump --master-data=2 --all-databases > dumpfile
```
{% endstep %}
{% step %}
Restart the replica.
```sql
START REPLICA;
```
{% endstep %}
{% step %}
On the new replica, load the dump file.
```
mariadb < dumpfile
```
{% endstep %}
{% step %}
On the new replica, set the replication coordinates to those of the primary server obtained earlier.
```sql
CHANGE MASTER TO
MASTER_LOG_FILE = ´file_name´,
MASTER_LOG_POS = file_pos;
```
The `CHANGE MASTER TO` statement might also need other parameters, such as `MASTER_HOST` to point the replica to the correct primary server host. Add any such parameters as necessary.
{% endstep %}
{% endstepper %}
#### --max-allowed-packet=\#
The maximum packet length to send to or receive from the server. The maximum is 1GB.
#### --max-statement-time=\#
Sets the maximum time any statement can run before being timed out by the server. Default value is `0` (no limit).
#### --net-buffer-length=\#
The initial buffer size for client/server TCP/IP and socket communication. This can be used to limit the size of rows in the dump. When creating multiple-row `INSERT` statements (as with the `--extended-insert` or `--opt` option), `mariadb-dump` creates rows up to `net_buffer_length` length.
#### --no-autocommit
Enclose the [INSERT](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/insert) statements for each dumped table within [SET autocommit = 0](https://mariadb.com/docs/server/server-management/variables-and-modes/server-system-variables#autocommit) and [COMMIT](https://mariadb.com/docs/server/reference/sql-statements/transactions/commit) statements. `ON` by default from MariaDB 11.8 to allow faster data loading by InnoDB, writing only one undo log for the whole operation.
#### -n, --no-create-db
This option suppresses the [CREATE DATABASE ... IF EXISTS](https://mariadb.com/docs/server/reference/sql-statements/data-definition/create/create-database) statement that normally is output for each dumped database if `--all-databases` or `--databases` is given.
#### -t, --no-create-info
Do not write [CREATE TABLE](https://mariadb.com/docs/server/server-usage/tables/create-table) statements, which re-create each dumped table.
#### -d, --no-data
Do not write any table row information (that is, do not dump table contents). This is useful if you want to dump only the [CREATE TABLE](https://mariadb.com/docs/server/server-usage/tables/create-table) statement for the table (for example, to create an empty copy of the table by loading the dump file). See also `--ignore-table-data`.
#### --no-data-med
Do not dump rows for engines that manage external data (for instance, [MRG\_MyISAM](https://mariadb.com/docs/server/server-usage/storage-engines/merge), MRG\_ISAM, [CONNECT](https://mariadb.com/docs/server/server-usage/storage-engines/connect), [OQGRAPH](https://mariadb.com/docs/server/server-usage/storage-engines/oqgraph-storage-engine/oqgraph-overview), [Spider](https://mariadb.com/docs/server/server-usage/storage-engines/spider), VP, [Federated](https://mariadb.com/docs/server/server-usage/storage-engines/federatedx-storage-engine)). This option is enabled by default. If you want to dump data for these engines, you need to set `--no-data-med=0`.
#### --no-defaults
Don't read default options from any option file. Must be given as the first argument.
#### -N, --no-set-names
Suppress the `SET NAMES` statement. This has the same effect as `--skip-set-charset`.
#### --opt
This option is shorthand. It is the same as specifying `--add-drop-table`, `--add-locks`, `--create-options`, `--quick`, `--extended-insert`, `--lock-tables`, `--set-charset`, and `--disable-keys`. Enabled by default, disable with `--skip-opt`. It should give you a fast dump operation and produce a dump file that can be reloaded into a MariaDB server quickly. The `--opt` option is enabled by default. Use `--skip-opt` to disable it. See the discussion at the beginning of this section for information about selectively enabling or disabling a subset of the options affected by `--opt`.
#### --order-by-primary
Sorts each table's rows by primary key, or first unique key, if such a key exists. This is useful when dumping a [MyISAM](https://mariadb.com/docs/server/server-usage/storage-engines/myisam-storage-engine) table to be loaded into an [InnoDB](https://mariadb.com/docs/server/server-usage/storage-engines/innodb) table, but it will make the dump itself take considerably longer.
#### --order-by-size
Dump each table according to its size, smallest first. Useful when using `--single-transaction` on tables which get truncated/altered often. The assumption here is that smaller tables get truncated more often, and by dumping those first, this reduces the chance that a `--single-transaction` dump will fail with 'Table definition has changed, please retry transaction'. This option is available from MariaDB 10.9.1.
#### -j, --parallel=\#
Number of dump table jobs executed in parallel (only for use with the `--tab` option). Testing indicates that performance can be increased (dump time decreased) up to 4 times on smaller-sized dumps, when the database fits into memory. There is a point at which the disk becomes the bottleneck, after which adding more parallel jobs does not bring better performance. From MariaDB 11.4.1.
#### -p\[*password*], --password=*password*
The *password* to use when connecting to the server. If you use the short option form (`-p`), you cannot have a space between the option and the password. If you omit the password value following the `--password` or `-p` option on the command line, `mariadb-dump` prompts for one. Specifying a password on the command line should be considered insecure. You can use an option file to avoid giving the password on the command line.
#### -W, --pipe
On Windows, connect to the server via a named pipe. This option applies only if the server supports named-pipe connections.
#### --plugin-dir
Directory for client-side plugins.
#### -P *port*, --port=*port*
The TCP/IP *port number* to use for the connection.
#### --print-defaults
Print the program argument list and exit. Must be given as the first argument.
#### --protocol=name
The connection protocol to use for connecting to the server (`TCP`, `SOCKET`, `PIPE`, `MEMORY`). It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want.
#### -q, --quick
This option is useful for dumping large tables. It forces `mariadb-dump` to retrieve rows for a table from the server, a row at a time, and to then dump the results directly to stdout rather than retrieving the entire row set and buffering it in memory before writing it out. Defaults to `ON`, use `--skip-quick` to disable.
#### -Q, --quote-names
Quote identifiers (such as database, table, and column names) within backtick (`` ` ``) characters. If the `ANSI_QUOTES` SQL mode is enabled, identifiers are quoted with (`"`) characters. This option is enabled by default. It can be disabled with `--skip-quote-names`, but this option should be given after any option such as `--compatible` that may enable `--quote-names`.
#### --replace
Use [REPLACE INTO](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/changing-deleting-data/replace) statements instead of [INSERT INTO](https://mariadb.com/docs/server/reference/sql-statements/data-manipulation/inserting-loading-data/insert) statements.
#### -r, --result-file=*file*
Direct output to a given *file*. This option should be used on Windows to prevent newline (`\n`) characters from being converted to `\r\n` carriage return/newline sequences. The result file is created and its previous contents overwritten, even if an error occurs while generating the dump.
#### -R, --routines
Include stored routines ([procedures](https://mariadb.com/docs/server/server-usage/stored-routines/stored-procedures) and [functions](https://mariadb.com/docs/server/server-usage/stored-routines/stored-functions)) for the dumped databases in the output. Use of this option requires the SELECT privilege for the [mysql.proc](https://mariadb.com/docs/server/reference/system-tables/the-mysql-database-tables/mysql-proc-table) table. The output generated using --routines contains [CREATE PROCEDURE](https://mariadb.com/docs/server/server-usage/stored-routines/stored-procedures/create-procedure) and [CREATE FUNCTION](https://mariadb.com/docs/server/reference/sql-statements/data-definition/create/create-function) statements to re-create the routines. However, these statements do not include attributes such as the routine creation and modification timestamps. This means that when the routines are reloaded, they are created with the timestamps equal to the reload time. If you require routines to be re-created with their original timestamp attributes, do not use `--routines`. Instead, dump and reload the contents of the [mysql.proc](https://mariadb.com/docs/server/reference/system-tables/the-mysql-database-tables/mysql-proc-table) table directly, using a MariaDB account, which has appropriate privileges for the mysql database.
#### --set-charset
Add `'SET NAMES default_character_set'` to the output in order to set the [character set](https://mariadb.com/docs/server/reference/data-types/string-data-types/character-sets). Enabled by default; suppress with `--skip-set-charset`.
#### -O, --set-variable=*variable*
Change the value of a *variable*. This option is deprecated; you can set variables directly with `--`*`variable-name`*`=`*`value`*.
#### --shared-memory-base-name
Shared-memory name to use for Windows connections using shared memory to a local server (started with the `--shared-memory` option). Case-sensitive. Defaults to `MYSQL`.
#### --single-transaction
This option sends a [START TRANSACTION](https://mariadb.com/docs/server/reference/sql-statements/transactions/start-transaction) SQL statement to the server before dumping data. It is useful only with transactional tables such as [InnoDB](https://mariadb.com/docs/server/server-usage/storage-engines/innodb), because then it dumps the consistent state of the database at the time when `BEGIN` was issued, without blocking any applications. When using this option, you should keep in mind that only InnoDB tables are dumped in a consistent state. The single-transaction feature depends not only on the engine being transactional and capable of `REPEATABLE-READ`, but also on `START TRANSACTION WITH CONSISTENT SNAPSHOT`. The dump is not guaranteed to be consistent for other storage engines. For example, any [TokuDB](https://mariadb.com/docs/server/server-usage/storage-engines/legacy-storage-engines/tokudb), [MyISAM](https://mariadb.com/docs/server/server-usage/storage-engines/myisam-storage-engine), or [MEMORY](https://mariadb.com/docs/server/server-usage/storage-engines/memory-storage-engine) tables dumped while using this option may still change state. While a `--single-transaction` dump is in process, to ensure a valid dump file (correct table contents and binary log coordinates), no other connection should use the following statements: [ALTER TABLE](https://mariadb.com/docs/server/reference/sql-statements/data-definition/alter/alter-table), [CREATE TABLE](https://mariadb.com/docs/server/server-usage/tables/create-table), [DROP TABLE](https://mariadb.com/docs/server/server-usage/tables/drop-table), [RENAME TABLE](https://mariadb.com/docs/server/reference/sql-statements/data-definition/rename-table), or [TRUNCATE TABLE](https://mariadb.com/docs/server/reference/sql-statements/table-statements/truncate-table). A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the `SELECT` (performed by mariadb-dump to retrieve the table contents) to obtain incorrect contents or fail. The `--single-transaction` option and the `--lock-tables` option are mutually exclusive, because [LOCK TABLES](https://mariadb.com/docs/server/reference/sql-statements/transactions/lock-tables) causes any pending transactions to be committed implicitly. So, this option automatically turns off `--lock-tables`. To dump large tables, you should combine the `--single-transaction` option with `--quick`.
#### --skip-add-locks
Disable the `--add-locks` option.
#### --skip-comments
Disable the `--comments` option.
#### --skip-disable-keys
Disable the `--disable-keys` option.
#### --skip-extended-insert
Disable the `--extended-insert` option.
#### --skip-opt
Disable the `--opt` option (disables `--add-drop-table`, `--add-locks`, `--create-options`, `--quick`, `--extended-insert`, `--lock-tables`, `--set-charset`, and `--disable-keys`).
#### --skip-quick
Disable the `--quick` option.
#### --skip-quote-name
Disable the `--quote-names` option.
#### --skip-set-charset
Disable the `--set-charset` option.
#### --skip-triggers
Disable the `--triggers` option.
#### --skip-tz-utc
Disables the `--tz-utc` option. When `--skip-tz-utc` is specified, the `--tz-utc` behavior is disabled. `mariadb-dump` will not set its connection time zone to UTC before the dump, and will not add `SET TIME_ZONE='+00:00'` to the top of the dump file. [TIMESTAMP](https://mariadb.com/docs/server/reference/data-types/date-and-time-data-types/timestamp) values will therefore be dumped in the local time zone of the server. When the dump is reloaded on a server in a different time zone or during daylight saving time transitions, remember that this may result in different timestamp values. See [--tz-utc](#tz-utc).
#### -S name, --socket={*socket|named-pipe}*
For connections to localhost, the Unix *socket file* to use, or, on Windows, the name of the *named pipe* to use.
#### --ssl
Enables [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). TLS is also enabled even without setting this option when certain other TLS options are set. The `--ssl` option does not enable [verifying the server certificate](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption/secure-connections-overview#server-certificate-verification) by default. In order to verify the server certificate, the user must specify the `--ssl-verify-server-cert` option.
#### --ssl-ca=*pem-file*
Defines a path to a *PEM file* that should contain one or more X509 certificates for trusted Certificate Authorities (CAs) to use for [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). This option requires that you use the absolute path, not a relative path. See [Secure Connections Overview: Certificate Authorities (CAs)](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption/secure-connections-overview#certificate-authorities-cas) for more information. This option implies the `--ssl` option.
#### --ssl-capath=*pem-directory*
Defines a *path to a directory that contains one or more PEM files* that should each contain one X509 certificate for a trusted Certificate Authority (CA) to use for [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the [openssl rehash](https://www.openssl.org/docs/man1.1.1/man1/rehash.html) command. See [Secure Connections Overview: Certificate Authorities (CAs)](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption/secure-connections-overview#certificate-authorities-cas) for more information. This option is only supported if the client was built with OpenSSL or yaSSL. If the client was built with GnuTLS or Schannel, then this option is not supported. See [TLS and Cryptography Libraries Used by MariaDB](https://mariadb.com/docs/server/security/encryption/tls-and-cryptography-libraries-used-by-mariadb) for more information about which libraries are used on which platforms. This option implies the `--ssl` option.
#### --ssl-cert=*certificate-file*
Defines a path to the *X509 certificate file* to use for [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). This option requires that you use the absolute path, not a relative path. This option implies the `--ssl` option.
#### --ssl-cipher=*cipher-list*
*List of permitted ciphers* or cipher suites to use for [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). This option implies the `--ssl` option.
#### --ssl-crl=*pem-file*
Defines a *path to a PEM file* that should contain one or more revoked X509 certificates to use for [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). This option requires that you use the absolute path, not a relative path. See [Secure Connections Overview: Certificate Revocation Lists (CRLs)](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption/secure-connections-overview#certificate-revocation-lists-crls) for more information. This option is only supported if the client was built with OpenSSL or Schannel. If the client was built with yaSSL or GnuTLS, then this option is not supported. See [TLS and Cryptography Libraries Used by MariaDB](https://mariadb.com/docs/server/security/encryption/tls-and-cryptography-libraries-used-by-mariadb) for more information about which libraries are used on which platforms.
#### --ssl-crlpath=*pem-directory*
Defines a *path to a directory that contains one or more PEM files* that should each contain one revoked X509 certificate to use for [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the [openssl rehash](https://www.openssl.org/docs/man1.1.1/man1/rehash.html) command. See [Secure Connections Overview: Certificate Revocation Lists (CRLs)](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption/secure-connections-overview#certificate-revocation-lists-crls) for more information. This option is only supported if the client was built with OpenSSL. If the client was built with yaSSL, GnuTLS, or Schannel, then this option is not supported. See [TLS and Cryptography Libraries Used by MariaDB](https://mariadb.com/docs/server/security/encryption/tls-and-cryptography-libraries-used-by-mariadb) for more information about which libraries are used on which platforms.
#### --ssl-key=*private-key*
Defines a *path to a private key file* to use for [TLS](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption). This option requires that you use the absolute path, not a relative path. This option implies the `--ssl` option.
#### --ssl-verify-server-cert
Enables [server certificate verification](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption/secure-connections-overview#server-certificate-verification). This option is disabled by default.
#### --system=*option*\[,*option*]]
Dump the database's system tables in a logical form. With this option, the [mysql database](https://mariadb.com/docs/server/reference/system-tables/the-mysql-database-tables) tables are dumped as [CREATE USER](https://mariadb.com/docs/server/reference/sql-statements/account-management-sql-statements/create-user), [CREATE SERVER](https://mariadb.com/docs/server/reference/sql-statements/data-definition/create/create-server), and other forms of logical portable SQL statements. The option values here are from the set of `all`, `users`, `plugins`, `udfs`, `servers`, `stats`, and `timezones`.
#### -T, --tab=*name*
Produce tab-separated text-format data files. With this option, for each dumped table, `mariadb-dump` creates a `tbl_name.sql` file containing the `CREATE TABLE` statement that creates the table, and a `tbl_name.txt` file containing the table's data. The option value is the directory in which to write the files. Note: This option can only be used when `mariadb-dump` is run on the same machine as the `mariadbd` server. You must have the `FILE` privilege, and the server must have permission to write files in the directory that you specify. By default, the `.txt` data files are formatted using tab characters between column values and a newline at the end of each line. The format can be specified explicitly using the `--fields-`*`xxx`* and `--lines-terminated-by` options. Column values are converted to the character set specified by the `--default-character-set` option.
#### --tables
This option overrides the `--databases` (`-B`) option. `mariadb-dump` regards all name arguments following the option as table names.
#### --tls-version=*protocol*
This option accepts a *comma-separated list of TLS protocol versions*. A TLS protocol version will only be enabled if it is present in this list. All other TLS protocol versions will not be permitted. See [Secure Connections Overview: TLS Protocol Versions](https://mariadb.com/docs/server/security/encryption/data-in-transit-encryption/secure-connections-overview#tls-protocol-versions) for more information.
#### --triggers
Include [triggers](https://mariadb.com/docs/server/server-usage/triggers-events/triggers) for each dumped table in the output. This option is enabled by default; disable it with `--skip-triggers`.
#### --tz-utc
This option enables [TIMESTAMP](https://mariadb.com/docs/server/reference/data-types/date-and-time-data-types/timestamp) columns to be dumped and reloaded between servers in different time zones. `mariadb-dump` sets its connection time zone to UTC before starting the dump and adds `SET TIME_ZONE=´+00:00´` to the top of the dump file. Without this option, `TIMESTAMP` columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change if the servers are in different time zones. This option also protects against changes due to daylight saving time. The time zone setting affects how timestamp arguments (like those in `--as-of`) are interpreted.
`--tz-utc` is enabled by default. To disable it, use `--skip-tz-utc`.
Note the interaction of this option with `--as-of` when dumping versioned data.
#### -u *username*, --user=*username*
The MariaDB *user name* to use when connecting to the server.
#### -v, --verbose
Verbose mode. Print more information about what the program is doing during various stages.
#### -V, --version
Output version information and exit.
#### -w *condition*, --where=*condition*
Dump only rows selected by the given *`WHERE` condition*. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter. Example:\
`--where="user = ´jimf´" -w"userid > 1" -w"userid < 1"` .
#### -L, --wildcards
Usage of wildcards in the table/database name. Without the `--databases` option, wildcards can be used only in tables names. From [MariaDB 12.1](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/release-notes-mariadb-12.1-rolling-releases/changes-and-improvements-in-mariadb-12.1).
#### -X, --xml
Dump a database as well-formed XML.
### Group Options
Some `mariadb-dump` options are shorthand for groups of other options:
* Use of `--opt` is the same as specifying`--add-drop-table`, `--add-locks`, `--create-options`, `--disable-keys`, `--extended-insert`, `--lock-tables`, `--quick`, and `--set-charset`. All of the\
options that `--opt` stands for are also on by default because `--opt` is on by default.
* Use of `--compact` is the same as specifying `--skip-add-drop-table`, `--skip-add-locks`, `--skip-comments`, `--skip-disable-keys`, and `--skip-set-charset` options.
To reverse the effect of a group option, use its `--skip-xxx` form (`--skip-opt` or `--skip-compact`). It\
is also possible to select only part of the effect of a group option by following it with options that enable or disable specific features. Here are some examples:
* To select the effect of `--opt` except for some features, use the `--skip` option for each feature. To disable extended inserts and memory buffering, use `--opt--skip-extended-insert` `--skip-quick`.\
(Actually, `--skip-extended-insert--skip-quick` is sufficient because`--opt` is on by default.)
* To reverse `--opt` for all features except index disabling and table locking, use `--skip-opt--disable-keys` `--lock-tables`.
When you selectively enable or disable the effect of a group option, the order is important because options are processed first to last. For example, `--disable-keys` `--lock-tables--skip-opt` would not have the intended effect; it is the same as `--skip-opt` by itself.
### Special Characters in Option Values
Some options, like `--lines-terminated-by`, accept a string. The string can be quoted, if necessary. For example, on Unix systems, this is the option to enclose fields within double quotes:
```
--fields-enclosed-by='"'
```
An alternative is to specify the hexadecimal value of a character. For example, the following syntax works on any platform:
```
--fields-enclosed-by=0x22
```
## Option Files
In addition to reading options from the command line, `mariadb-dump` can also read options from [option files](https://mariadb.com/docs/server/server-management/install-and-upgrade-mariadb/configuring-mariadb/configuring-mariadb-with-option-files). If an unknown option is provided to `mariadb-dump` in an option file, then it is ignored.
The following options relate to how MariaDB command-line tools handle option files. They must be given as the first argument on the command line:
| Option | Description |
| ------------------------- | ----------------------------------------------------------------------------------- |
| --print-defaults | Print the program argument list and exit. |
| --no-defaults | Don't read default options from any option file. |
| --defaults-file=# | Only read default options from the given file #. |
| --defaults-extra-file=# | Read this file after the global files are read. |
| --defaults-group-suffix=# | In addition to the default option groups, also read option groups with this suffix. |
`mariadb-dump` is linked with [MariaDB Connector/C](https://app.gitbook.com/s/CjGYMsT2MVP4nd3IyW2L/connectors-quickstart-guides/mariadb-connector-c-guide). However, MariaDB Connector/C does not handle the parsing of option files for this client. That is performed by the server's option file parsing code. See [MDEV-19035](https://jira.mariadb.org/browse/MDEV-19035) for more information.
#### Option Groups
`mariadb-dump` reads options from the following [option groups](https://mariadb.com/docs/server/server-management/install-and-upgrade-mariadb/configuring-mariadb/configuring-mariadb-with-option-files#option-groups) from the [option files](https://mariadb.com/docs/server/server-management/install-and-upgrade-mariadb/configuring-mariadb/configuring-mariadb-with-option-files):
| Group | Description |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| \[mysqldump] | Options read by mariadb-dump, which includes both MariaDB Server and MySQL Server. |
| \[mariadb-dump] | Options read by `mariadb-dump`. |
| \[client] | Options read by all MariaDB and MySQL client programs, which include both MariaDB and MySQL clients. For example, mysqldump. |
| \[client-server] | Options read by all MariaDB [client programs](https://mariadb.com/docs/server/clients-and-utilities) and the MariaDB Server. This is useful for options like socket and port, which are common between the server and the clients. |
| \[client-mariadb] | Options read by all MariaDB client programs. |
## NULL, ´NULL´, and Empty Values in XML
For a column named `column_name`, the `NULL` value, an empty string, and the string value `´NULL´` are distinguished from one another in the output generated by this option as follows.
| Value | XML Representation |
| ----------------------- | --------------------------------------------- |
| `NULL` (unknown value) | `` |
| `''` (empty string) | `` |
| `'NULL'` (string value) | `NULL` |
The output from the mariadb client when run using the `--xml` option also follows the preceding rules.
XML output from mariadb-dump includes the XML namespace, as shown here:
```xml
shell> mariadb-dump --xml -u root world City
1
Kabul
AFG
Kabol
1780000
...
4079
Rafah
PSE
Rafah
92020
```
## Restoring Dumps
To restore a backup created with `mariadb-dump`, use the \[mariadb client]\(../mariadb-client/mariadb-command line-client.md) to import the dump:
```bash
mariadb db_name < backup-file.sql
```
## Variables
You can also set the following variables (`--variable-name=value`) and boolean options `{FALSE|TRUE}` by using:
| Name | Default Values |
| ----------------------------- | --------------------------------------------- |
| all | TRUE |
| all-databases | FALSE |
| all-tablespaces | FALSE |
| no-tablespaces | FALSE |
| add-drop-database | FALSE |
| add-drop-table | TRUE |
| add-drop-trigger | FALSE |
| add-locks | TRUE |
| allow-keywords | FALSE |
| apply-slave-statements | FALSE |
| as-of | (No default value) |
| character-sets-dir | (No default value) |
| comments | TRUE |
| compatible | (No default value) |
| compact | FALSE |
| complete-insert | FALSE |
| compress | FALSE |
| copy-s3-tables | FALSE |
| create-options | TRUE |
| databases | FALSE |
| debug-check | FALSE |
| debug-info | FALSE |
| default-character-set | utf8mb4 |
| delayed-insert | FALSE |
| delete-master-logs | FALSE |
| disable-keys | TRUE |
| events | FALSE |
| extended-insert | TRUE |
| fields-terminated-by | (No default value) |
| fields-enclosed-by | (No default value) |
| fields-optionally-enclosed-by | (No default value) |
| fields-escaped-by | (No default value) |
| flush-logs | FALSE |
| flush-privileges | FALSE |
| force | FALSE |
| hex-blob | FALSE |
| host | (No default value) |
| include-master-host-port | FALSE |
| insert-ignore | FALSE |
| lines-terminated-by | (No default value) |
| lock-all-tables | FALSE |
| lock-tables | TRUE |
| log-error | (No default value) |
| log-queries | TRUE |
| master-data | 0 |
| max\_allowed\_packet | 16777216 |
| net-buffer-length | 1046528 |
| no-autocommit | TRUE (> MariaDB 11.7), FALSE (< MariaDB 11.8) |
| no-create-db | FALSE |
| no-create-info | FALSE |
| no-data | FALSE |
| no-data-med | TRUE |
| order-by-primary | FALSE |
| port | 0 |
| quick | TRUE |
| quote-names | TRUE |
| replace | FALSE |
| routines | FALSE |
| set-charset | TRUE |
| single-transaction | FALSE |
| dump-date | TRUE |
| socket | No default value) |
| ssl | FALSE |
| ssl-ca | (No default value) |
| ssl-capath | (No default value) |
| ssl-cert | (No default value) |
| ssl-cipher | (No default value) |
| ssl-key | (No default value) |
| ssl-verify-server-cert | FALSE |
| system | (No default value) |
| tab | (No default value) |
| triggers | TRUE |
| tz-utc | TRUE |
| user | (No default value) |
| verbose | FALSE |
| where | (No default value) |
| plugin-dir | (No default value) |
| default-auth | (No default value) |
## Examples
A common use of `mariadb-dump` is making a backup of an entire database:
```bash
shell> mariadb-dump db_name > backup-file.sql
```
You can load the dump file back into the server like this:
```bash
shell> mariadb db_name < backup-file.sql
```
Or like this:
```bash
shell> mariadb -e "source /path-to-backup/backup-file.sql" db_name
```
`mariadb-dump` is also very useful for populating databases by copying data from one MariaDB server to another:
```bash
shell> mariadb-dump --opt db_name | mariadb --host=remote_host -C db_name
```
It is possible to dump several databases with one command:
```bash
shell> mariadb-dump --databases db_name1 [db_name2 ...] > my_databases.sql
```
To dump all databases, use the `--all-databases` option:
```bash
shell> mariadb-dump --all-databases > all_databases.sql
```
For InnoDB tables, `mariadb-dump` provides a way of making an online backup:
```bash
shell> mariadb-dump --all-databases --single-transaction all_databases.sql
```
This backup acquires a global read lock on all tables (using`FLUSH TABLES WITH READ LOCK`) at the beginning of the dump. As soon as this lock has been acquired, the binary log coordinates are read, and the lock is released. If long updating statements are running when the `FLUSH` statement is issued, the MariaDB server may get stalled until those statements finish. After that, the dump becomes lock-free and does not disturb reads and writes on the tables. If the update statements that the MariaDB server receives are short (in terms of execution time), the initial lock period should not be noticeable, even with many updates.
For point-in-time recovery (also known as “roll-forward,” when you need to restore an old backup and replay the changes that happened since that backup), it is often useful to rotate the [binary log](https://mariadb.com/docs/server/server-management/server-monitoring-logs/binary-log) or at least know the binary log coordinates to which the dump corresponds:
```bash
shell> mariadb-dump --all-databases --master-data=2 > all_databases.sql
```
Or:
```bash
shell> mariadb-dump --all-databases --flush-logs --master-data=2 > all_databases.sql
```
The `--master-data` and `--single-transaction` options can be used simultaneously, which provides a convenient way to make an online backup suitable for use prior to point-in-time recovery if tables are\
stored that use the InnoDB storage engine.
## See Also
* [mariadb-backup](https://mariadb.com/docs/server/server-usage/backup-and-restore/mariadb-backup)
* [MariaDB point-in-time recovery](https://www.youtube.com/watch?v=ezHmnNmmcDo) (video)
* [MariaDB Enterprise Backup](https://mariadb.com/docs/server/server-usage/backup-and-restore/mariadb-enterprise-backup)
* [Upgrading to a newer major version of MariaDB](https://www.youtube.com/watch?v=1kLIXN2DoEo) (video)
* [MariaDB dump file compatibility change](https://app.gitbook.com/s/3VYeeVGUV4AMqrA3zwy7/high-availability/state-snapshot-transfers-ssts-in-galera-cluster/manual-sst-of-galera-cluster-node-with-mariadb-backup) (blog, 2024)
*This page is licensed: CC BY-SA / Gnu FDL*
{% @marketo/form formId="4316" %}