Options for mariadb-backup & mariabackup in MariaDB Enterprise Server 10.5
mariadb-backup utility is the newer name for
mariabackup, though you can still run it using either name.
take backup to target-dir
This option controls how MariaDB Backup should retrieve server's binary log coordinates corresponding to the backup. Possible values are OFF, ON, LOCKLESS and AUTO. However, LOCKLESS is not safe to use with MariaDB Server. See the documentation for more information.
Check database user privileges fro the backup user (Defaults to on; use --skip-check-privileges to disable.)
do not keep files opened. Use at your own risk.
Compress individual backup files using the specified compression algorithm. Currently the only supported algorithm is 'quicklz'. It is also the default algorithm, i.e., the one used when --compress is used without an argument.
Size of working buffer(s) for compression threads in bytes. The default value is 64K.
Number of threads for parallel data compression. The default value is 1.
Copy all the files in a previously made backup from the backup directory to their original locations.
Write core on fatal signals
filtering by list of databases.
Excluding databases based on name, Operates the same way as --databases, but matched names are excluded from backup. Note that this option has a higher priority than --databases.
filtering by list of databases in the file.
Path to the database root.
Decompresses all files with the .qp extension in a backup previously made with the --compress option.
Read this file after the global files are read.
Only read default options from the given file #.
defaults group in config file (default "mysqld").
Additionally read default groups with # appended as a suffix.
In --backup, assume that nonzero key_version implies that the page is encrypted. Use --backup --skip-encrypted-backup to allow copying unencrypted that were originally created before MySQL 5.1.48. (Defaults to on; use --skip-encrypted-backup to disable.)
create files to import to another database when prepare.
Enable extended validation for Innodb data pages during backup phase. Will slow down backup considerably, in case encryption is used. May fail if tables are created during the backup.
(for --backup): save an extra copy of the xtrabackup_checkpoints file in this directory.
This option, when specified, makes --copy-back or --move-back transfer files to non-empty directories. Note that no existing files will be overwritten. If --copy-back or --move-back has to copy a file from the backup directory which already exists in the destination directory, it will still fail with an error.
This option specifies which types of queries are allowed to complete before innobackupex will issue the global lock. Default is all.. One of: ALL, UPDATE, SELECT
This option specifies the query run time threshold which is used by innobackupex to detect long-running queries with a non-zero value of --ftwrl-wait-timeout. FTWRL is not started until such long-running queries exist. This option has no effect if --ftwrl-wait-timeout is 0. Default value is 60 seconds.
This option specifies time in seconds that innobackupex should wait for queries that would block FTWRL before running it. If there are still such queries when the timeout expires, innobackupex terminates with an error. Default is 0, in which case innobackupex does not wait for queries to complete and starts FTWRL immediately.
This options creates the xtrabackup_galera_info file which contains the local node state at the time of the backup. Option should be used when performing the backup of MariaDB Galera Cluster. Has no effect when backup locks are used to create the backup.
Display this help and exit.
This option enables the tracking of backup history in the PERCONA_SCHEMA.xtrabackup_history table. An optional history series name may be specified that will be placed with the history record for the current backup being taken.
This option specifies the host to use when connecting to the database server with TCP/IP. The option accepts a string argument. See mysql --help for details.
(for --backup): copy only .ibd pages newer than backup at specified directory.
(for --prepare): apply .delta files and logfile in the specified directory.
Perform a full-scan incremental backup even in the presence of changed page bitmap data
This option specifies the name of the backup series stored in the PERCONA_SCHEMA.xtrabackup_history history record to base an incremental backup on. MariaDB Backup will search the history table looking for the most recent (highest innodb_to_lsn), successful backup in the series and take the to_lsn value to use as the starting lsn for the incremental backup. This will be mutually exclusive with --incremental-history-uuid, --incremental-basedir and --incremental-lsn. If no valid lsn can be found (no series by that name, no successful backups by that name) MariaDB Backup will return with an error. It is used with the --incremental option.
This option specifies the UUID of the specific history record stored in the PERCONA_SCHEMA.xtrabackup_history to base an incremental backup on. --incremental-history-name, --incremental-basedir and --incremental-lsn. If no valid lsn can be found (no success record with that uuid) MariaDB Backup will return with an error. It is used with the --incremental option.
(for --backup): copy only .ibd pages newer than specified LSN 'high:low'. ##ATTENTION##: If a wrong LSN value is specified, it is impossible to diagnose this, causing the backup to be unusable. Be careful!
Ignored option for MySQL option compatibility
Enable InnoDB adaptive hash index (disabled by default).
Data file autoextend increment in megabytes
Ignored for mysqld option compatibility
The algorithm InnoDB uses for page checksumming. [CRC32, STRICT_CRC32, INNODB, STRICT_INNODB, NONE, STRICT_NONE]. One of: crc32, strict_crc32, innodb, strict_innodb, none, strict_none, full_crc32, strict_full_crc32
Compression level used for zlib compression.
Path to individual files and their sizes.
The common part for InnoDB table spaces.
Enable InnoDB doublewrite buffer during --prepare.
Number of file I/O threads in InnoDB.
Stores each InnoDB table to an .ibd file in the database dir.
With which method to flush data.. One of: fsync, O_DSYNC, littlesync, nosync, O_DIRECT, O_DIRECT_NO_FSYNC
(for --prepare): Crash recovery mode (ignores page corruption; for emergencies only).
Number of IOPs the server can do. Tunes the background IO rate
The size of the buffer which InnoDB uses to write log to the log files on disk.
Ignored for mysqld option compatibility
Ignored for mysqld option compatibility
Path to InnoDB log files.
Percentage of dirty pages allowed in bufferpool.
The universal page size of the database.
Number of background read I/O threads in InnoDB.
Directory where undo tablespace files live, this path can be absolute.
Number of undo tablespaces to use.
Use native AIO if supported on this platform. (Defaults to on; use --skip-innodb-use-native-aio to disable.)
Number of background write I/O threads in InnoDB.
This option specifies the number of seconds innobackupex waits between starting FLUSH TABLES WITH READ LOCK and killing those queries that block it. Default is 0 seconds, which means innobackupex will not attempt to kill any queries.
This option specifies which types of queries should be killed to unblock the global lock. Default is "all".. One of: ALL, UPDATE, SELECT
This option tells MariaDB Backup to obtain a read metadata lock for each table, which can prevent concurrent DDL from occurring during the backup. Before the backup starts, MariaDB Backup acquires a metadata lock for each individual table on the system. The metadata locks are released when the backup completes.
Ignored option for MySQL option compatibility
Base name for the log sequence
time interval between checks done by log copying thread in milliseconds (default is 1 second).
Continue backup if innodb corrupted pages are found. The pages are logged in innodb_corrupted_pages and backup is finished with error. --prepare will try to fix corrupted pages. If innodb_corrupted_pages exists after --prepare in base backup directory, backup still contains corrupted pages and can not be considered as consistent.
Move all the files in a previously made backup from the backup directory to the actual datadir location. Use with caution, as it removes backup files.
All arguments that follow this argument are considered as server options, and if some of them are not supported by mariabackup, they will be ignored.
Don't read default options from any option file.
Use this option to disable table lock with "FLUSH TABLES WITH READ LOCK". Use it only if ALL your tables are InnoDB and you DO NOT CARE about the binary log position of the backup. This option shouldn't be used if there are any DDL statements being executed or if any updates are happening on non-InnoDB tables (this includes the system MyISAM tables in the mysql database), otherwise it could lead to an inconsistent backup. If you are considering to use --no-lock because your backups are failing to acquire the lock, this could be because of incoming replication events preventing the lock from succeeding. Please try using --safe-slave-backup to momentarily stop the replication slave thread, this may help the backup to succeed and you then don't need to resort to using this option.
This option disables the version check which is enabled by the --version-check option.
the maximum number of file descriptors to reserve with setrlimit().
Number of threads to use for parallel datafiles transfer. The default value is 1.
This option specifies the password to use when connecting to the database. It accepts a string argument. See mysql --help for details.
Server plugin directory. Used to load encryption plugin during 'prepare' phase.Has no effect in the 'backup' phase (plugin directory during backup is the same as server's)
This option specifies the port to use when connecting to the database server with TCP/IP. The option accepts a string argument. See mysql --help for details.
prepare a backup for starting mysql server on the backup.
Print the program argument list and exit.
print parameter of mysqld needed for copyback.
The protocol to use for connection (tcp, socket, pipe, memory).
Remove .qp files after decompression.
Backup rocksdb data, if rocksdb plugin is installed.Used only with --backup option. Can be useful for partial backups, to exclude all rocksdb data (Defaults to on; use --skip-rocksdb-backup to disable.)
RocksDB data directory.This option is only used with --copy-back or --move-back option
Stop slave SQL thread and wait to start backup until Slave_open_temp_tables in "SHOW STATUS" is zero. If there are no open temporary tables, the backup will take place, otherwise the SQL thread will be started and stopped until there are no open temporary tables. The backup will fail if Slave_open_temp_tables does not become zero after --safe-slave-backup-timeout seconds. The slave SQL thread will be restarted when the backup finishes.
How many seconds --safe-slave-backup should wait for Slave_open_temp_tables to become zero. (default 300)
Refuse client connecting to server if it uses old (pre-4.1.1) protocol. (Defaults to on; use --skip-secure-auth to disable.)
This option is useful when backing up a replication slave server. It prints the binary log position and name of the master server. It also writes this information to the "xtrabackup_slave_info" file as a "CHANGE MASTER" command. A new slave for this master can be set up by starting a slave server on this backup and issuing a "CHANGE MASTER" command with the binary log position saved in the "xtrabackup_slave_info" file.
This option specifies the socket to use when connecting to the local database server with a UNIX domain socket. The option accepts a string argument. See mysql --help for details.
Enable SSL for connection (automatically enabled with other flags).
CA file in PEM format (check OpenSSL docs, implies --ssl).
CA directory (check OpenSSL docs, implies --ssl).
X509 cert in PEM format (implies --ssl).
SSL cipher to use (implies --ssl).
Certificate revocation list (implies --ssl).
Certificate revocation list path (implies --ssl).
X509 key in PEM format (implies --ssl).
Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default.
Stream all backup files to the standard output in the specified format.Supported format is 'mbstream' or 'xbstream'.
filtering by regexp for table names.
filtering by regexp for table names. Operates the same way as --tables, but matched names are excluded from backup. Note that this option has a higher priority than --tables.
filtering by list of the exact database.table name in the file.
limit count of IO operations (pairs of read&write) per second to IOS values (for '--backup')
TLS protocol version for secure connection.
Path for temporary files. Several paths may be specified, separated by a colon (:), in this case they are used in a round-robin fashion.
The value is used in place of innodb_buffer_pool_size. This option is only relevant when the --prepare option is specified.
This option specifies the MySQL username used when connecting to the server, if that's not the current user. The option accepts a string argument. See mysql --help for details.
display verbose output
This option tells MariaDB Backup to print version information and then quit.
The following Command-line Options are not present in MariaDB Enterprise Server 10.5.15-10 but are present in one or more older 10.5 ES versions. Click on an item to see its details, including when it was removed.
This is a debug-only option used by the MariaDB Backup test suite.
Debug sync point. This is only used by the MariaDB Backup test suite.