5.1 mysqlbackup Command-Line Options

5.1.1 Subcommands
5.1.2 Standard Options
5.1.3 Connection Options
5.1.4 Server Repository Options
5.1.5 Backup Repository Options
5.1.6 Metadata Options
5.1.7 Compression Options
5.1.8 Incremental Backup Options
5.1.9 Partial Backup Options
5.1.10 Single-File Backup Options
5.1.11 Performance / Scalability / Capacity Options
5.1.12 Message Logging Options
5.1.13 Progress Report Options
5.1.14 Encryption Options
5.1.15 Cloud Storage Options
5.1.16 Options for Special Backup Types

The following sections describe the different modes of operation for mysqlbackup, and explain in details the applicable options for each of the modes of operation and for different situations.

The table below list all the command options for mysqlbackup. Use the hotlinks at the option names to jump to the detailed descriptions for the options.

Note

The command options can also be specified in configuration files; see explanations in Section 5.2, “Configuration Files and Parameters”. The mysqlbackup command follows MySQL standard practice for handling duplicate options, whether specified in a configuration file, on the command line, or both. Options are processed first from configuration files, then from the command line. If an option is specified more than once, the last instance takes precedence.

Table 5.1 List of All Options

FormatDescriptionIntroduced
--backup-dirThe directory to store the backup data. 
--backup-imageSpecifies the path name of the backup image. 
--backup_innodb_checksum_algorithmThe name of the checksum algorithm used for validating InnoDB tablespaces. 
--backup_innodb_data_file_pathSpecifies Innodb system tablespace files' path and size in backup. 
--backup_innodb_data_home_dirBackup base directory for all InnoDB data files in the system tablespace. 
--backup_innodb_log_file_sizeThe size in bytes of each InnoDB backup log file. 
--backup_innodb_log_files_in_groupNumber of InnoDB log files in backup. 
--backup_innodb_log_group_home_dirBackup directory for InnoDB log files. 
--backup_innodb_page_sizeThe page size for all InnoDB tablespaces in a MySQL instance. 
--backup_innodb_undo_directoryThe relative or absolute directory path where InnoDB creates separate tablespaces for the undo logs. 
--backup_innodb_undo_logsNumber of rollback segments in the system tablespace that InnoDB uses within a transaction. 
--backup_innodb_undo_tablespacesThe number of tablespace files that the undo logs are divided between when a non-zero innodb_undo_logs setting is used. 
--character-sets-dirDirectory for character set files. 
--cloud-access-key-idAWS access key ID for logging onto Amazon S3.3.10.2
--cloud-aws-regionRegion for Amazon Web Services that mysqlbackup access for S3.3.10.2
--cloud-bucketThe storage bucket on Amazon S3 for the backup image.3.10.2
--cloud-object-keyThe Amazon S3 object key for the backup image.3.10.2
--cloud-proxyProxy address and port number for overriding the environment's default proxy settings for accessing cloud service.3.10.2
--cloud-secret-access-keyAWS secret access key.3.10.2
--cloud-serviceCloud service for data backup or restoration.3.10.2
--cloud-tracePrint trace information for cloud operations.3.10.2
--commentsSpecifies comments string. 
--comments-fileSpecifies path to comments file. 
--compressCreate backup in compressed format. 
--compress-levelSpecifies the level of compression. 
--compress-methodSpecifies the compression algorithm. 
--connect-if-onlineUse connection only if available. 
--connect_timeoutConnection timeout in seconds. 
--databases[Legacy] Specifies the list of non-InnoDB tables to back up. 
--databases-list-file[Legacy] Specifies the pathname of a file that lists the non-InnoDB tables to be backed up. 
--datadirPath to mysql server data directory. 
--debugPrint debug information. 
--decryptDecrypt backup image written in an MEB Secure File. 
--default-character-setSet the default character set. 
--defaults-extra-fileRead this file after the global files are read. 
--defaults-fileOnly read default options from the given file. 
--defaults-group-suffixAlso read option groups with the usual names and a suffix of str. 
--disable-manifestDisable generation of manifest files for a backup operation. 
--dst-entryUsed with single-file backups to extract a single file or directory to a user-specified path. 
--encryptEncrypt backup image and write it in an MEB Secure File. 
--exclude-tablesExclude in backup tables whose names match the regular expression REGEXP.3.10.0
--exec-when-lockedExecute the specified utility when all tables are locked near the end of the execution. 
--forceForce overwriting of data, log, or image files, depending on the operation. 
--helpDisplay help. 
--hostHost name to connect. 
--include[Legacy] Backup only those per-table innodb data files which match the regular expression REGEXP. 
--include-tablesInclude in backup tables which match the regular expression REGEXP.3.10.0
--incrementalSpecifies that the associated backup or backup-to-image operation is incremental. 
--incremental-backup-dirSpecifies the location under which to store data from an incremental backup. 
--incremental-baseThe specification of base backup for --incremental option. 
--incremental-with-redo-log-onlySpecifies the incremental backup of InnoDB tables to be based on copying redo log to the backup, without including any InnoDB datafiles in the backup. 
--innodb_checksum_algorithmThe name of the checksum algorithm used for validating InnoDB tablespaces. 
--innodb_data_file_pathSpecifies InnoDB system tablespace files' path and size. 
--innodb_data_home_dirSpecifies base directory for all InnoDB data files in the shared system tablespace. 
--innodb_log_file_sizeThe size in bytes of each InnoDB log file in the log group. 
--innodb_log_files_in_groupThe number of InnoDB log files. 
--innodb_log_group_home_dirThe directory path to InnoDB log files. 
--innodb_page_sizeThe page size for all InnoDB tablespaces in a MySQL instance. 
--keyThe symmetric key used for encryption and decryption. 
--key-fileThe pathname of a file that contains the symmetric key used for encryption and decryption.3.10.0
--limit-memoryThe memory in MB available for the MEB operation. 
--login-pathRead options from the named login path in the .mylogin.cnf login file. 
--messages-logdirSpecifies the path name of an existing directory for storing the message log. 
--no-connectionDo not connect to server. 
--no-defaultsDo not read default options from any given file. 
--no-history-loggingDisable history logging even if connection is available. 
--no-lockingDisable locking of tables even if connection is available. 
--number-of-buffersSpecifies the exact number of memory buffers to be used for the backup operation. 
--on-disk-fullSpecifies the behavior when a backup process encounters a disk-full condition. 
--only-innodbBack up only InnoDB data and log files. 
--only-innodb-with-frm[Legacy] Back up only InnoDB data, log files, and the .frm files associated with the InnoDB tables. 
--only-known-file-typesIncludes only files of a list of known types in the backup. 
--page-reread-countMaximum number of page re-reads. 
--page-reread-timeWait time before a page re-read. 
--passwordConnection password. 
--pipealias for –protocol=pipe. 
--portTCP portnumber to connect to. 
--print-defaultsPrint a list of option values supplied by defaults files and exit. 
--process-threadsSpecifies the number of process-threads for the backup operation. 
--progress-intervalInterval between progress reports in seconds. 
--protocolConnection protocol. 
--read-threadsSpecifies the number of read-threads for the backup operation. 
--sbt-database-nameUsed as a hint to the Media Management Software (MMS) for the selection of media and policies for tape backup. 
--sbt-environmentComma separated list of environment variable assignments to be given to the SBT library. 
--sbt-lib-pathPath name of the SBT library used by software that manages tape backups. 
--secure-authRefuse client connecting to server if it uses old (pre-4.1.1) protocol. 
--shared-memory-base-nameIt designates the shared-memory name used by a Windows server to permit clients to connect using shared memory (Windows only). 
--show-progressInstructs mysqlbackup to periodically output short progress reports known as progress indicators on its operation. 
--skip-messages-logdirDisable logging to teelog file. 
--skip-unused-pagesSkip unused pages in tablespaces when backing up InnoDB tables. 
--slave-infoCapture information needed to set up an identical slave server. 
--sleepTime to sleep in milliseconds after copying each 1MB of data. 
--socketSocket file to use to connect. 
--src-entryIdentifies a file or directory to extract from a single-file backup. 
--sslEnable SSL for connection (automatically enabled with other --ssl- flags). 
--ssl-caCA file in PEM format (implies –ssl). 
--ssl-capathCA directory (check OpenSSL docs,implies --ssl). 
--ssl-certX509 cert in PEM format (implies --ssl). 
--ssl-cipherSSL cipher to use (implies --ssl). 
--ssl-keyX509 key in PEM format (implies --ssl). 
--ssl-verify-server-certVerify server's "Common Name" in its cert against hostname used when connecting. 
--start-lsnSpecifies the highest LSN value included in a previous backup. 
--suspend-at-endPauses the mysqlbackup command when the backup procedure is close to ending. 
--traceTrace level of messages by mysqlbackup. 
--uncompressUncompress the compressed backup before applying log. 
--use-ttsEnable selective backup of InnoDB tables using transportable tablespaces (TTS). 
--userDatabase user name to connect. 
--verbosePrint more verbose information. 
--versionDisplay version information. 
--with-timestampCreate a subdirectory underneath the backup directory with a name formed from the timestamp of the backup operation. 
--write-threadsSpecifies the number of write-threads for the backup operation.