13.1 Standard Options

The standard options are options of a general nature, or options that are not classified under any other specific option group.

Here is a list of the standard options:

  • The following standard options also exist for the mysql command. Full descriptions for these options can be found in the MySQL reference manual, accessible through, e.g., Server Option and Variable Reference. These options must be specified ahead of any other mysqlbackup options, including the rest of the standard options:

    --print-defaults             Print the program argument list and exit.
    --no-defaults                Don't read default options from any option file.
    --defaults-file=PATH         Only read default options from the given file. It has to be the first option to be specified, if used. 
    --defaults-extra-file=PATH   Read this file after the global files are read.
    --defaults-group-suffix=str  Also read option groups with the usual names and a suffix of str.  
  • The following options are also common between mysqlbackup and mysql, and full descriptions for them can be found in the MySQL reference manual, accessible through, e.g., Server Option and Variable Reference. However, mysqlbackup does not accept any short forms for these options as mysql does (for example, you must use --help instead of -h for mysqlbackup):

    --help      Display help. 
    --version   Display version information
    --verbose   Print more verbose information. 
    --debug     Print debug information.
  • More standard options are available for mysqlbackup:

    --force       Force overwriting of data, log, or image files, depending on the operation.
    --trace=level Trace level of messages by mysqlbackup.

    --force: By default, some of the operations halt rather than overwrite any user data or log files when told to write to existing files. --force allows the following:

    • Overwriting of InnoDB data and log files during the apply-log and apply-incremental-backup operations.

    • When restoring a TTS backup, changing temporarily the value of innodb_file_format on the server, in order to allow restores of per-table InnoDB data files regardless of their format.

    • Replacing of an image file during an backup-to-image or backup-dir-to-image operation.

    • Overwriting data in a non-empty target directory with backup data during a copy-back operation performed on a full backup (the use of copy-back-and-apply-log is not recommended in this case)

    • Restoring a partial image backup created with MySQL Enterprise Backup 3.11 or earlier; the --force option is required, due to a known issue (Bug# 20485910).

    • Restoring a backup onto a server where the directory pointed to by the .bl file in the backup (a copy of the .isl file from the backed-up server) already contains .ibd data files.

    For all other operations, the --force option is rejected with an error message.


    Command-Line Format--trace=LEVEL
    Permitted ValuesTypeenumeration
    Valid Values0

    Trace level of mysqlbackup messages. The permissible levels, in the order of increasing fineness, are:

    • 0 - INFO (information, warnings, errors)

    • 1 - FINE (verbose option is enabled)

    • 2 - FINER (debug option is enabled)

    • 3 - FINEST (includes all low level outputs)

Download this Manual
PDF (US Ltr) - 1.1Mb
PDF (A4) - 1.1Mb
EPUB - 241.5Kb
HTML Download (TGZ) - 189.4Kb
HTML Download (Zip) - 218.7Kb
User Comments
Sign Up Login You must be logged in to post a comment.