The xtrabackup command-line options¶

Here you can find all of the command-line options for the xtrabackup binary.

Modes of operation¶

You invoke xtrabackup in one of the following modes:

--backup mode to make a backup in a target directory
--prepare mode to restore data from a backup (created in --backup mode)
--copy-back to copy data from a backup to the location that contained the original data; to move data instead of copying use the alternate --move-back mode.
--stats mode to scan the specified data files and print out index statistics.

When you intend to run xtrabackup in any of these modes, use the following syntax:

$ xtrabackup [--defaults-file=#] --backup|--prepare|--copy-back|--stats [OPTIONS]

For example, the --prepare mode is applied as follows:

$ xtrabackup --prepare --target-dir=/data/backup/mysql/

For all modes, the default options are read from the xtrabackup and mysqld configuration groups from the following files in the given order:

/etc/my.cnf
/etc/mysql/my.cnf
/usr/etc/my.cnf
~/.my.cnf.

As the first parameter to xtrabackup (in place of the --defaults-file, you may supply one of the following:

--print-defaults to have xtrabackup print the argument list and exit.
--no-defaults to forbid reading options from any file but the login file.
--defaults-file to read the default options from the given file.
--defaults-extra-file to read the specified additional file after the global files have been read.
--defaults-group-suffix to read the configuration groups with the given suffix. The effective group name is constructed by concatenating the default configuration groups (xtrabackup and mysqld) with the given suffix.
--login-path to read the given path from the login file.

InnoDB options¶

A large group of InnoDB options are generally read from the my.cnf configuration file, so xtrabackup boots up its embedded InnoDB in the same configuration as your current server. You usually do not need to specify them explicitly. These options have the same behavior in InnoDB and XtraDB. See --innodb-miscellaneous for more information.

Options¶

apply-log-only¶

Usage: --apply-log-only

This option causes only the redo stage to be performed when preparing a backup. It is very important for incremental backups.

backup¶

Usage: --backup

Make a backup and place it in --target-dir. See Create a full backup.

backup-lock-timeout¶

Usage: --backup-lock-timeout

The timeout in seconds for attempts to acquire metadata locks.

backup-lock-retry-count¶

Usage: --backup-lock-retry-count

The number of attempts to acquire metadata locks.

backup-locks¶

Usage: --backup-locks

This option controls if backup locks should be used instead of FLUSH TABLES WITH READ LOCK on the backup stage. The option has no effect when the server does not support backup locks. This option is enabled by default, disable with --no-backup-locks.

check-privileges¶

Usage: check-privileges

This option checks if Percona XtraBackup has all required privileges. If a required privilege is missing for the current operation, the operation terminates and prints an error message. If a privilege is not needed for the current operation, but is missing and may be necessary for another XtraBackup operation, the operation is not aborted, and prints a warning.

Example output

```{.text .no-copy}
xtrabackup: Error: missing required privilege LOCK TABLES on *.*
xtrabackup: Warning: missing required privilege REPLICATION CLIENT on *.*
```

close-files¶

Usage: --close-files

Do not keep files opened. When xtrabackup opens a tablespace, xtrabackup normally doesn’t close its file handle. This operation allows xtrabackup to handle the DDL operations correctly. However, if the number of tablespaces is huge and can not fit into any limit, there is an option to close file handles once they are no longer accessed. Percona XtraBackup can produce inconsistent backups with this option enabled. Use at your own risk.

compress¶

Usage: --compress

xtrabackup compresses all output data, including the transaction log and metadata files.

Version updates	Option changes
Percona XtraBackup 8.0.34-29	* The `qpress/QuickLZ` compression algorithm is no longer supported for compress operations. * The `ZSTD` compression algorithm is moved to General Availability . This version makes `ZSTD` the default compression method for the `--compress` option. * `--compress` produces `\.zst` files. You can specify `ZSTD` compression level with the `--compress-zstd-level=#` option. `--compress=lz4` produces `\*.lz4` files. You can extract the contents of these files by using `lz4` program. You can extract the contents of the files by using the `--decompress` option. To decompress backups taken by older versions of Percona XtraBackup that used a QuickLZ compression algorithm, the `--decompress` option still supports `qpress` for backward compatibility.
Percona XtraBackup 8.0.33-28 and lower versions	The `--compress` option uses either the `quicklz` , `lz4` , or `ZSTD` compression algorithm to compress all output data. The `quicklz` algorithm is chosen by default. When using `--compress=quicklz` or `--compress` , the resulting files have the qpress archive format. Every `\.qp` file produced by xtrabackup is essentially a one-file qpress archive and can be extracted and uncompressed by the `qpress` file archiver. `--compress=zstd` produces `\.zst` files. You can specify `ZSTD` compression level with the `[--compress-zstd-level=#`](#compress-zstd-level) option. `--compress=lz4` produces `\*.lz4` files. You can extract the contents of these files by using `lz4` program. You can extract the contents of the files by using the `--decompress` option.
Percona XtraBackup 8.0.30-23	Adds the Zstandard ( `ZSTD` ) compression algorithm in tech preview . The `ZSTD` algorithm is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios. To compress files using the ZSTD compression algorithm, set the `--compress` option to zstd. The `--compress=zstd` option produces `*.zst` files. You can extract the contents of these files with the `--decompress` option. Also, you can specify the ZSTD compression level with the –compress-zstd-level=#) option.

compress-chunk-size¶

Usage: --compress-chunk-size=#

Size of working buffer(s) for compression threads in bytes. The default value is 64K.

compress-threads¶

Usage: --compress-threads=# This option specifies the number of worker threads xtrabackup uses for parallel data compression. This option defaults to 1. Parallel compression (--compress-threads) can be used with --parallel.

For example, --parallel=4 --compress --compress-threads=2 creates 4 I/O threads that read and then pipe that data to 2 compression threads.

compress-zstd-level¶

Usage: --compress-zstd-level=#

This option specifies the ZSTD compression level. Compression levels provide a trade-off between the compression speed and the size of the compressed file. A lower compression level provides faster compression speed but larger file sizes. A higher compression level provides lower compression speed but smaller file sizes. For example, set level 1 if the compression speed is the most important for you. Set level 19 if the size of the compressed files is the most important.

The default value is 1. The allowed range is from 1 to 19.

Percona XtraBackup 8.0.30-22 implemented this option.

copy-back¶

Usage: --copy-back

Copy all the files in a previously made backup from the backup directory to their original locations. This option will not copy over existing files unless --force-non-empty-directories option is specified.

core-file¶

Usage: --core-file

Write core on fatal signals.

databases¶

Usage: --databases=#

This option specifies a list of databases and tables that should be backed up. The option accepts the list of the form "databasename1[.table_name1] databasename2[.table_name2] . . .".

databases-exclude¶

Usage: --databases-exclude=name

Databases are excluded based on name. This option operates the same way as --databases, but excludes the matched names from the backup.

This option has a higher priority than --databases.

databases-file¶

Usage: --databases-file=#

This option specifies the path to the file containing the list of databases and tables that should be backed up. The file can contain the list elements of the form databasename1[.table_name1], one element per line.

datadir¶

Usage: --datadir=DIRECTORY

The source directory for the backup. This directory should be the same as the datadir for your MySQL server, so it should be read from my.cnf if that exists; otherwise, you must specify it on the command line.

When combined with the --copy-back or --move-back option, --datadir refers to the destination directory.

Once connected to the server, to perform a backup, you will need READ and EXECUTE permissions at a filesystem level in the server’s datadir.

debug-sleep-before-unlock¶

Usage: --debug-sleep-before-unlock=#

This is a debug-only option used by the xtrabackup test suite.

debug-sync¶

Usage: --debug-sync=name

The debug sync point. This option is only used by the xtrabackup test suite.

decompress¶

Usage: --decompress

Decompresses all files in a backup previously made with the --compress option. The --parallel option will allow multiple files to be decrypted simultaneously. To decompress files compressed with quicklz compression algorithm, install the qpress utility. It must be accessible within the path. Percona XtraBackup does not automatically remove the compressed files. To clean up the backup directory users should use --remove-original option.

The --decompress option may be used with xbstream to decompress individual qpress files.

decompress-threads¶

Usage: --decompress-threads=#

Force xbstream to use the specified number of threads for decompressing.

decrypt¶

Usage: --decrypt=ENCRYPTION-ALGORITHM

Decrypts all files with the .xbcrypt extension in a backup previously made with --encrypt option. The --parallel option will allow multiple files to be decrypted simultaneously. Percona XtraBackup doesn’t automatically remove the encrypted files. To clean up the backup directory users should use --remove-original option.

defaults-extra-file¶

Usage: --defaults-extra-file=[MY.CNF]

Read this file after the global files are read. This option must be written as the first option on the command line.

defaults-file¶

Usage: --defaults-file=[MY.CNF]

Only read default options from the given file. Must be given as the first option on the command-line. Must be a real file; it cannot be a symbolic link.

defaults-group¶

Usage: --defaults-group=GROUP-NAMEThis option sets the group that should be read from the configuration file. This option is used by xtrabackup if you use the --defaults-group option. It is needed for mysqld_multi deployments.

defaults-group-suffix¶

Usage: --defaults-group-suffix=#

Also reads groups with concat(group, suffix).

dump-innodb-buffer-pool¶

Usage: --dump-innodb-buffer-pool

This option controls whether or not a new dump of buffer pool content should be done.

With --dump-innodb-buffer-pool, xtrabackup makes a request to the server to start the buffer pool dump (it takes some time to complete and is done in the background) at the beginning of a backup provided the status variable innodb_buffer_pool_dump_status reports that the dump has been completed.

$ xtrabackup --backup --dump-innodb-buffer-pool --target-dir=/home/user/backup

By default, this option is set to OFF.

If innodb_buffer_pool_dump_status reports that there is running dump of the buffer pool, xtrabackup waits for the dump to complete using the value of --dump-innodb-buffer-pool-timeout

The file ib_buffer_pool stores tablespace ID and page ID data to warm up the buffer pool sooner.

dump-innodb-buffer-pool-timeout¶

Usage: --dump-innodb-buffer-pool-timeout

This option contains the number of seconds that xtrabackup should monitor the value of innodb_buffer_pool_dump_status to determine if buffer pool dump has completed.

This option is used in combination with --dump-innodb-buffer-pool. By default, it is set to 10 seconds.

dump-innodb-buffer-pool-pct¶

Usage: --dump-innodb-buffer-pool-pct

This option contains the percentage of the most recently used buffer pool pages to dump.

This option is effective if --dump-innodb-buffer-pool option is set to ON. If this option contains a value, xtrabackup sets the MySQL system variable innodb_buffer_pool_dump_pct. As soon as the buffer pool dump completes or it is stopped (see --dump-innodb-buffer-pool-timeout), the value of the MySQL system variable is restored.

encrypt¶

Usage: --encrypt=ENCRYPTION_ALGORITHM

This option instructs xtrabackup to encrypt backup copies of InnoDB data files using the algorithm specified in the ENCRYPTION_ALGORITHM. Currently supported algorithms are: AES128, AES192 and AES256

encrypt-key¶

Usage: --encrypt-key=ENCRYPTION_KEY

A proper length encryption key to use. It is not recommended to use this option where there is uncontrolled access to the machine as the command line and thus the key can be viewed as part of the process info.

encrypt-key-file¶

Usage: --encrypt-key-file=ENCRYPTION_KEY_FILE

The name of a file where the raw key of the appropriate length can be read from. The file must be a simple binary (or text) file that contains exactly the key to be used.

It is passed directly to the xtrabackup child process. See the xtrabackup documentation for more details.

encrypt-threads¶

Usage: --encrypt-threads=#

This option specifies the number of worker threads that will be used for parallel encryption/decryption. See the xtrabackup documentation for more details.

encrypt-chunk-size¶

Usage: --encrypt-chunk-size=#

This option specifies the size of the internal working buffer for each encryption thread, measured in bytes. It is passed directly to the xtrabackup child process.

To adjust the chunk size for encrypted files, use --read-buffer-size and --encrypt-chunk-size.

estimate-memory¶

Usage: --estimate-memory=#

This option is in tech preview. Before using this option in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.

Implemented in Percona XtraBackup 8.0.32-26, the option lets you enable or disable the Smart memory estimation feature. The default value is OFF. Enable the feature by setting --estimate-memory=ON in the backup phase and setting the --use-free-memory-pct option in the --prepare phase. If the --estimate-memory setting is disabled, the --use-free-memory-pct setting is ignored.

An example of how to enable the Smart memory estimation feature:

$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/

$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/

export¶

Usage: --export

Create files necessary for exporting tables. See restore individual tables.

extra-lsndir¶

Usage: --extra-lsndir=DIRECTORY

(for –backup): save an extra copy of the xtrabackup_checkpoints and xtrabackup_info files in this directory.

force-non-empty-directories¶

Usage: --force-non-empty-directories

When specified, it makes --copy-back and --move-back option transfer files to non-empty directories. No existing files will be overwritten. If files that need to be copied/moved from the backup directory already exist in the destination directory, it will still fail with an error.

ftwrl-wait-timeout¶

Usage: --ftwrl-wait-timeout=SECONDS

This option specifies time in seconds that xtrabackup should wait for queries that would block FLUSH TABLES WITH READ LOCK before running it. If there are still such queries when the timeout expires, xtrabackup terminates with an error. Default is 0, in which case it does not wait for queries to complete and starts FLUSH TABLES WITH READ LOCK immediately. Where supported xtrabackup will automatically use Backup Locks as a lightweight alternative to FLUSH TABLES WITH READ LOCK to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.

ftwrl-wait-threshold¶

Usage: --ftwrl-wait-threshold=SECONDS

This option specifies the query run time threshold which is used by xtrabackup to detect long-running queries with a non-zero value of --ftwrl-wait-timeout. FLUSH TABLES WITH READ LOCK 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. Where supported xtrabackup will automatically use Backup Locks as a lightweight alternative to FLUSH TABLES WITH READ LOCK to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.

ftwrl-wait-query-type¶

Usage: --ftwrl-wait-query-type=all|update

This option specifies which types of queries are allowed to complete before xtrabackup will issue the global lock. Default is all.

galera-info¶

Usage: --galera-info

This option 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 Percona XtraDB Cluster. It has no effect when backup locks are used to create the backup.

generate-new-master-key¶

Usage: --generate-new-master-key

Generate a new master key when doing a copy-back.

generate-transition-key¶

Usage: --generate-transition-key

xtrabackup needs to access the same keyring file or vault server during prepare and copy-back but it should not depend on whether the server keys have been purged.

--generate-transition-key creates and adds to the keyring a transition key for xtrabackup to use if the master key used for encryption is not found because it has been rotated and purged.

get-server-public-key¶

Usage: --get-server-public-key

Get the server public key

help¶

Usage: --help

When run with this option or without any options xtrabackup displays information about how to run the program on the command line along with all supported options and variables with default values where appropriate.

history¶

Usage: --history=NAME

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.

host¶

Usage: --host=HOST

This option accepts a string argument that specifies the host to use when connecting to the database server with TCP/IP. It is passed to the mysql child process without alteration. See mysql –help for details.

incremental-basedir¶

Usage: --incremental-basedir=DIRECTORY

When creating an incremental backup, this is the directory containing the full backup that is the base dataset for the incremental backups.

incremental-dir¶

Usage: --incremental-dir=DIRECTORY

When preparing an incremental backup, this is the directory where the incremental backup is combined with the full backup to make a new full backup.

incremental-force-scan¶

Usage: --incremental-force-scan

When creating an incremental backup, force a full scan of the data pages in that instance.

incremental-history-name¶

Usage: --incremental-history-name=name

This option specifies the name of the backup series stored in the PERCONA_SCHEMA.xtrabackup_history history record to base an incremental backup on. xtrabackup 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) xtrabackup will return with an error. It is used with the --incremental option.

incremental-history-uuid¶

Usage: --incremental-history-uuid=name

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) xtrabackup will return with an error. It is used with the –incremental option.

incremental-lsn¶

Usage: --incremental-lsn=LSN

When creating an incremental backup, you can specify the log sequence number (LSN) instead of specifying --incremental-basedir. For databases created in 5.1 and later, specify the LSN as a single 64-bit integer.

Important

If a wrong LSN value is specified (a user error which Percona XtraBackup does not detect), the backup is unusable. Be careful!

innodb¶

Usage: --innodb=name

This option is ignored for MySQL option compatibility.

innodb-miscellaneous¶

Usage: --innodb-miscellaneous

There is a large group of InnoDB options that are normally read from the my.cnf configuration file, so that xtrabackup boots up its embedded InnoDB in the same configuration as your current server. You normally do not need to specify these explicitly. These options have the same behavior in InnoDB and XtraDB:

keyring-file-data¶

Usage: --keyring-file-data=FILENAME

The path to the keyring file. Combine this option with --xtrabackup-plugin-dir.

kill-long-queries-timeout¶

Usage: --kill-long-queries-timeout=SECONDS

This option specifies the number of seconds xtrabackup waits between starting FLUSH TABLES WITH READ LOCK and killing those queries that block it. Default is 0 seconds, which means xtrabackup will not attempt to kill any queries. In order to use this option xtrabackup user should have the PROCESS and SUPER privileges. Where supported, xtrabackup automatically uses Backup locks as a lightweight alternative to FLUSH TABLES WITH READ LOCK to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.

kill-long-query-type¶

Usage: --kill-long-query-type=all|select

This option specifies which types of queries should be killed to unblock the global lock. Default is “select”.

lock-ddl¶

Usage: --lock-ddl

Issue LOCK TABLES FOR BACKUP if it is supported by server (otherwise use LOCK INSTANCE FOR BACKUP) at the beginning of the backup to block all DDL operations.

Note

Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.

As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.

lock-ddl-per-table¶

Usage: --lock-ddl-per-table

Lock DDL for each table before xtrabackup starts to copy it and until the backup is completed.

Note

The [–lock-ddl-per-table] option is deprecated. Use the [–lock-ddl] option instead.

lock-ddl-timeout¶

Usage: --lock-ddl-timeout

If LOCK TABLES FOR BACKUP or LOCK INSTANCE FOR BACKUP does not return within given timeout, abort the backup.

log¶

Usage: --log

This option is ignored for MySQL

log-bin¶

Usage: --log-bin

The base name for the log sequence.

log-bin-index¶

Usage: --log-bin-index=name

File that holds the names for binary log files.

log-copy-interval¶

Usage: --log-copy-interval=#

This option specifies the time interval between checks done by the log copying thread in milliseconds (default is 1 second).

Usage: --login-path

Read the given path from the login file.

move-back¶

Usage: --move-back

Move all the files in a previously made backup from the backup directory to their original locations. As this option removes backup files, it must be used with caution.

no-backup-locks¶

Usage: --no-backup-locks

Explicity disables the --backup-locks option which is enabled by default.

no-defaults¶

Usage: --no-defaults

The default options are only read from the login file.

no-lock¶

Usage: --no-lock

Disables 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. Where supported xtrabackup will automatically use Backup locks as a lightweight alternative to FLUSH TABLES WITH READ LOCK to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables. If you are considering to use this because your backups are failing to acquire the lock, this could be because of incoming replication events are preventing the lock from succeeding. Please try using --safe-slave-backup to momentarily stop the replication replica thread, this may help the backup to succeed and you do not need to use this option.

no-server-version-check¶

Usage: --no-server-version-check

Implemented in Percona XtraBackup 8.0.21.

The --no-server-version-check option disables the server version check.

The default behavior runs a check that compares the source system version to the Percona XtraBackup version. If the source system version is higher than the XtraBackup version, the backup is aborted with a message.

Adding the option overrides this check, and the backup proceeds, but there may be issues with the backup.

See Server Version and Backup Version Comparison for more information.

no-version-check¶

Usage: --no-version-check

This option disables the version check. If you do not pass this option, the automatic version check is enabled implicitly when xtrabackup runs in the --backup mode. To disable the version check, you should pass explicitly the --no-version-check option when invoking xtrabackup.

When the automatic version check is enabled, xtrabackup performs a version check against the server on the backup stage after creating a server connection. xtrabackup sends the following information to the server:

MySQL flavor and version
Operating system name
Percona Toolkit version
Perl version

Each piece of information has a unique identifier. This is a MD5 hash value that Percona Toolkit uses to obtain statistics about how it is used. This is a random UUID; no client information is either collected or stored.

open-files-limit¶

Usage: --open-files-limit=#

The maximum number of file descriptors to reserve with setrlimit().

parallel¶

Usage: --parallel=#

This option specifies the number of threads to use to copy multiple data files concurrently when creating a backup. The default value is 1 (i.e., no concurrent transfer). In Percona XtraBackup 2.3.10 and newer, this option can be used with the --copy-back option to copy the user data files in parallel (redo logs and system tablespaces are copied in the main thread).

password¶

Usage: --password=PASSWORD

This option specifies the password to use when connecting to the database. It accepts a string argument. See mysql –help for details.

plugin-load¶

Usage: --plugin-load

List of plugins to load.

port¶

Usage: --port=PORT

This option accepts a string argument that specifies the port to use when connecting to the database server with TCP/IP. It is passed to the mysql child process without alteration. See mysql –help for details.

prepare¶

Usage: --prepare

Makes xtrabackup perform a recovery on a backup created with --backup, so that it is ready to use. See preparing a backup.

print-defaults¶

Usage: --print-defaults

Print the program argument list and exit. Must be given as the first option on the command-line.

print-param¶

Usage: --print-param

Makes xtrabackup print out parameters that can be used for copying the data files back to their original locations to restore them.

read-buffer-size¶

Usage: --read-buffer-size

Sets the read buffer size. The given value is scaled up to page size. The default size is 10MB. Use this option to increase the xbcloud/xbstream chunk size from the default size. To adjust the chunk size for encrypted files, use --read-buffer-size and --encrypt-chunk-size.

redo-log-arch-dir¶

Usage: --redo-log-arch-dir=name

This option sets the redo log archive directory if this directory is not already set on the server. To use this option, you must run Percona XtraBackup as the owner of mysqld. Additionally, the user must have at least one of the following privileges: SUPER or SYSTEM_VARIABLES_ADMIN.

Implemented in Percona XtraBackup 8.0.34-29.

register-redo-log-consumer¶

Usage: --register-redo-log-consumer

The --register-redo-log-consumer parameter is disabled by default. When enabled, this parameter lets Percona XtraBackup register as a redo log consumer at the start of the backup. The server does not remove a redo log that Percona XtraBackup (the consumer) has not yet copied. The consumer reads the redo log and manually advances the log sequence number (LSN). The server blocks the writes during the process. Based on the redo log consumption, the server determines when it can purge the log.

Implemented in Percona XtraBackup 8.0.30-23.

remove-original¶

Usage: --remove-original

Implemented in Percona XtraBackup 2.4.6, this option when specified will remove .qp, .xbcrypt and .qp.xbcrypt files after decryption and decompression.

rocksdb-datadir¶

Usage: --rocksdb-datadir

RocksDB data directory

rocksdb-wal-dir¶

Usage: --rocksdb-wal-dir

RocksDB WAL directory.

rocksdb-checkpoint-max-age¶

Usage: --rocksdb-checkpoint-max-age

The checkpoint cannot be older than this number of seconds when the backup completes.

rocksdb-checkpoint-max-count¶

Usage: --rocksdb-checkpoint-max-count

Complete the backup even if the checkpoint age requirement has not been met after this number of checkpoints.

rollback-prepared-trx¶

Usage: --rollback-prepared-trx

Force rollback prepared InnoDB transactions.

rsync¶

Usage: --rsync

Uses the rsync utility to optimize local file transfers. When this option is specified, xtrabackup uses rsync to copy all non-InnoDB files instead of spawning a separate cp for each file, which can be much faster for servers with a large number of databases or tables. This option cannot be used together with --stream.

safe-slave-backup¶

Usage: --safe-slave-backup

When specified, xtrabackup will stop the replica SQL thread just before running FLUSH TABLES WITH READ LOCK 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 replication SQL thread will be restarted when the backup finishes. This option is implemented in order to deal with replicating temporary tables and isn’t necessary with Row-Based-Replication.

Note

Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.

As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.

safe-slave-backup-timeout¶

Usage: --safe-slave-backup-timeout=SECONDS

How many seconds --safe-slave-backup should wait for Slave_open_temp_tables to become zero. Defaults to 300 seconds.

secure-auth¶

Usage: --secure-auth

Refuse client connecting to server if it uses old (pre-4.1.1) protocol. (Enabled by default; use –skip-secure-auth to disable.)

server-id¶

Usage: --server-id=#

The server instance being backed up.

server-public-key-path¶

Usage: --server-public-key-path

The file path to the server public RSA key in the PEM format.

skip-tables-compatibility-check¶

Usage: --skip-tables-compatibility-check

See --tables-compatibility-check.

slave-info¶

Usage: --slave-info

This option is useful when backing up a replication replica server. It prints the binary log position of the source server. It also writes the binary log coordinates to the xtrabackup_slave_info file as a CHANGE MASTER command. A new replica for this source can be set up by starting a replica server on this backup and issuing a CHANGE MASTER command with the binary log position saved in the xtrabackup_slave_info file.

socket¶

Usage: --socket

This option accepts a string argument that specifies the socket to use when connecting to the local database server with a UNIX domain socket. It is passed to the mysql child process without alteration. See mysql –help for details.

ssl¶

Usage: --ssl

Enable secure connection.

ssl-ca¶

Usage: --ssl-ca

Path of the file which contains list of trusted SSL CAs.

ssl-capath¶

Usage: --ssl-capath

Directory path that contains trusted SSL CA certificates in PEM format.

ssl-cert¶

Usage: --ssl-cert

Path of the file which contains X509 certificate in PEM format.

ssl-cipher¶

Usage: --ssl-cipher

List of permitted ciphers to use for connection encryption.

ssl-crl¶

Usage: --ssl-crl

Path of the file that contains certificate revocation lists. MySQL server documentation.

ssl-crlpath¶

Usage: --ssl-crlpath

Path of directory that contains certificate revocation list files.

ssl-fips-mode¶

Usage: --ssl-fips-mode

SSL FIPS mode (applies only for OpenSSL); permitted values are: OFF, ON, STRICT.

ssl-key¶

Usage: --ssl-key

Path of file that contains X509 key in PEM format.

ssl-mode¶

Usage: --ssl-mode

Security state of connection to server.

ssl-verify-server-cert¶

Usage: --ssl-verify-server-cert

Verify server certificate Common Name value against host name used when connecting to server.

stats¶

Usage: --stats

Causes xtrabackup to scan the specified data files and print out index statistics.

stream¶

Usage: --stream=FORMAT

Stream all backup files to the standard output in the specified format. Currently, this option only supports the xbstream format.

strict¶

Usage: --strict

If this option is specified, xtrabackup fails with an error when invalid parameters are passed.

tables¶

Usage: --tables=name

A regular expression against which the full tablename, in databasename.tablename format, is matched. If the name matches, the table is backed up. See partial backups.

tables-compatibility-check¶

Usage: --tables-compatibility-check

Enables the engine compatibility warning. The default value is ON. To disable the engine compatibility warning use --skip-tables-compatibility-check.

tables-exclude¶

Usage: --tables-exclude=name

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.

tables-file¶

Usage: --tables-file=name

A file containing one table name per line, in databasename.tablename format. The backup will be limited to the specified tables.

target-dir¶

Usage: --target-dir=DIRECTORY

This option specifies the destination directory for the backup. If the directory does not exist, xtrabackup creates it. If the directory does exist and is empty, xtrabackup will succeed. xtrabackup will not overwrite existing files, however; it will fail with operating system error 17, file exists.

If this option is a relative path, it is interpreted as being relative to the current working directory from which xtrabackup is executed.

In order to perform a backup, you need READ, WRITE, and EXECUTE permissions at a filesystem level for the directory that you supply as the value of --target-dir.

innodb-temp-tablespaces-dir¶

Usage: --innodb-temp-tablespaces-dir=DIRECTORY

Directory where temp tablespace files live, this path can be absolute.

throttle¶

Usage: --throttle=#

This option limits the number of chunks copied per second. The chunk size is 10 MB.

To limit the bandwidth to 10 MB/s, set the option to 1.

tls-ciphersuites¶

Usage: --tls-ciphersuites

TLS v1.3 cipher to use.

tls-version¶

Usage: --tls-version

TLS version to use, permitted values are: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3.

tmpdir¶

Usage: --tmpdir=name

Specify the directory that will be used to store temporary files during the backup

transition-key¶

Usage: --transition-key=name

This option is used to enable processing the backup without accessing the keyring vault server. In this case, xtrabackup derives the AES encryption key from the specified passphrase and uses it to encrypt tablespace keys of tablespaces being backed up.

If --transition-key does not have any value, xtrabackup will ask for it. The same passphrase should be specified for the --prepare command.

use-free-memory-pct¶

Usage: --use-free-memory-pct

The --use-free-memory-pct is a tech preview option. Before using this option in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.

Implemented in Percona XtraBackup 8.0.30-23, this option lets you configure the Smart memory estimation feature. The option controls the amount of free memory that can be used to --prepare a backup. The default value is 0 (zero) which defines the option as disabled. For example, if you set --use-free-memory-pct=50, then 50% of the free memory is used to prepare a backup. The maximum allowed value is 100.

This option works, only if --estimate-memory option is enabled. If the --estimate-memory option is disabled, the --use-free-memory-pct setting is ignored.

An example of how to enable the Smart memory estimation feature:

$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/

$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/

use-memory¶

Usage: --use-memory

This option affects how much memory is allocated and is similar to innodb_buffer_pool_size. This option is only relevant in the --prepare phase or when analyzing statistics with --stats. The default value is 100MB. The recommended value is between 1GB to 2GB. Multiple values are supported if you provide the unit (for example, 1MB, 1M, 1GB, 1G).

user¶

Usage: --user=USERNAME

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.

version¶

Usage: --version

This option prints xtrabackup version and exits.

xtrabackup-plugin-dir¶

Usage: --xtrabackup-plugin-dir=DIRNAME

The absolute path to the directory that contains the keyring plugin.

Need help?¶

Dive into our active community forum, where you can connect with fellow database enthusiasts, share experiences, and learn from experts.

For those seeking in-depth guidance and tailored solutions, our team of Percona Database Experts is ready to assist you.

Add a question in the Community Forum Work with a Percona Expert

Last update: 2024-09-05

The xtrabackup command-line options¶

Modes of operation¶

InnoDB options¶

Options¶

apply-log-only¶

backup¶

backup-lock-timeout¶

backup-lock-retry-count¶

backup-locks¶

check-privileges¶

close-files¶

compress¶

compress-chunk-size¶

compress-threads¶

compress-zstd-level¶

copy-back¶

core-file¶

databases¶

databases-exclude¶

databases-file¶

datadir¶

debug-sleep-before-unlock¶

debug-sync¶

decompress¶

decompress-threads¶

decrypt¶

defaults-extra-file¶

defaults-file¶

defaults-group¶

defaults-group-suffix¶

dump-innodb-buffer-pool¶

dump-innodb-buffer-pool-timeout¶

dump-innodb-buffer-pool-pct¶

encrypt¶

encrypt-key¶

encrypt-key-file¶

encrypt-threads¶

encrypt-chunk-size¶

estimate-memory¶

export¶

extra-lsndir¶

force-non-empty-directories¶

ftwrl-wait-timeout¶

ftwrl-wait-threshold¶

ftwrl-wait-query-type¶

galera-info¶

generate-new-master-key¶

generate-transition-key¶

get-server-public-key¶

help¶

history¶

host¶

incremental-basedir¶

incremental-dir¶

incremental-force-scan¶

incremental-history-name¶

incremental-history-uuid¶

incremental-lsn¶

innodb¶

innodb-miscellaneous¶

keyring-file-data¶

kill-long-queries-timeout¶

kill-long-query-type¶

lock-ddl¶

lock-ddl-per-table¶

lock-ddl-timeout¶

log¶

log-bin¶

log-bin-index¶

log-copy-interval¶

login-path¶

move-back¶

no-backup-locks¶

no-defaults¶

no-lock¶

no-server-version-check¶

no-version-check¶

open-files-limit¶

parallel¶

password¶