These options are associated with single-file backups. You use
them in combination with the mysqlbackup
extract. For usage examples, see
Section 4.3.1, “Making a Single-File Backup”.
See description of the option in Section 16.4, “Backup Repository Options”
Type Path name
Identifies files or directories whose pathnames contain the STRING to be extracted from a single-file backup. This option is used with the
extractcommand. Optionally, you can also specify the
--dst-entryoption to extract a file or directory to a location different from its original path name.
src-entry=d1/f2extracts only one file,
src-entry=d1/extracts the entire directory tree for the
d1folder (notice the slash (
/) at the end of the argument, without which all files or folders containing the string
d1in their pathnames will be extracted).
Default: All entries are extracted.Notes
The following items are always extracted from the backup, irrespective of the value of
--src-entry(and the locations of their extraction are unaffected by the
datadirfolder (which only contains items matched by the
metafolder, which contains the file
backup_variables.txt, a log file for the extract operation, and also items matched by the
The option is currently not supported for the
extractcommand for cloud backups, which can only be extracted in full.
Type Path name
Used with single-file backups to extract a single file or directory to a user-specified path. Use of this option requires specifying the
--src-entryoption. This option specifies the destination path for the entry selected from the backup image by
--src-entry. The entry could point to a single file or single directory. For example, to retrieve the comments file from a backup image and store it as
/tmp/my-comments.txt, use a command like the following:
mysqlbackup --src-entry=meta/comments.txt \ --dst-entry=/tmp/my-comments.txt \ --backup-image=/var/myimage.bki extract
Similarly, to extract all the contents of the
datadir/pets/directory in a single-file backup as
/pets-extracted/, use a command like the following:
mysqlbackup --src-entry=datadir/pets/ \ --dst-entry=/pets-extracted/ \ --backup-image=/var/myimage.bki extract
The specified path is a simple path name without any wildcard expansion or regular expressions.
In case the argument for
--src-entrymatches multiple files or folders, they are all extracted into a folder whose pathname, relative to the destination folder, is given by the argument of
--dst-entry(unless the argument specifies an absolute path).
Default: Original pathnames are used to create files under the destination folder.
Type String Default Value
For tape backups, this option can be used as a hint to the Media Management Software (MMS) for the selection of media and policies. This name has nothing to do with MySQL database names. It is a term used by the MMS. See Section 18.104.22.168, “Backing Up to Tape” for usage details.
Type File name
Path name of the SBT library used by the software that manages tape backups. If this is not specified, operating system-specific search methods are used to locate
orasbt.dll(Windows). See Section 22.214.171.124, “Backing Up to Tape” for usage details.
--sbt-environment=VAR1=value1[,VAR2=value2[,...]] SBT API provider)
Passes product-specific environment variables to Oracle Secure Backup or another SBT-compliant backup management product, as an alternative to setting and unsetting environment variables before and after each mysqlbackup invocation.
The parameter to this option is a comma-separated list of key-value pairs, using syntax similar to that of the RMAN tool for the Oracle Database. For example,
Consult the documentation for your backup management product to see which of its features can be controlled through environment variables. For example, the Oracle Secure Backup product defines environment variables such as
OB_RESOURCE_WAIT_TIME. You might set such variables with the mysqlbackup by specifying an option such as
If the argument string contains any whitespace or special characters recognized by the command shell, enclose the entire argument string in quotation marks. To escape an equal sign or comma, use the
\character. For example,
Disable generation of manifest files for a backup operation, which are
backup_content.xmlpresent in the