MySQL Enterprise Backup User's Guide (Version 4.0.3)
These options are associated with single-file backups. You use
them in combination with the mysqlbackup
commands backup-to-image
,
image-to-backup-dir
,
backup-dir-to-image
,
copy-back-and-apply-log
,
list-image
, and
extract
. For usage examples, see
Section 4.3.1, “Making a Single-File Backup”.
--backup-image
=IMAGE
See description of the option in Section 15.4, “Backup Repository Options”
--src-entry
=PATH
Command-Line Format | --src-entry=STRING |
---|---|
Type | Path name |
Identifies a file or directory to extract from a single-file
backup. This option is used with the
extract
command. If the argument
is a directory, all its files and subdirectory contents are
extracted. No pattern matching expression is allowed for the
argument. Optionally, you can also specify the
--dst-entry
option to extract
the file or directory in a location different from its
original path name.
For example: src-entry=meta/comments.txt
extracts only one file, comments.txt
,
while src-entry=meta
extracts the entire
directory tree for the meta
subdirectory.
Default: All entries are extracted.
The option is currently not supported for the
extract
command for cloud
backups, which can only be extracted in full.
--dst-entry
=PATH
Command-Line Format | --dst-entry=PATH |
---|---|
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-entry
option. 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
meta
directory in a single-file backup
as /data/my-meta
, use a command like
the following:
mysqlbackup --src-entry=meta \ --dst-entry=/data/my-meta \ --backup-image=/var/myimage.bki extract
The specified path is a simple path name without any wildcard expansion or regular expressions.
Default: By default, original pathnames are used to create files in the local file system.
--sbt-database-name
=NAME
Command-Line Format | --sbt-database-name=NAME |
---|---|
Type | String |
Default Value | MySQL |
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 4.3.1.2, “Backing Up to Tape” for usage details.
--sbt-lib-path
=PATH
Command-Line Format | --sbt-lib-path=PATH |
---|---|
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
libobk.so
(UNIX) or
orasbt.dll
(Windows). See
Section 4.3.1.2, “Backing Up to Tape” for usage details.
--sbt-environment
=VAR
=value
,...
Command-Line Format | --sbt-environment=VAR1=value1[,VAR2=value2[,...]] SBT API provider) |
---|---|
Type | String |
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,
--sbt-environment=VAR1=val1,VAR2=val2,VAR3=val3
.
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_MEDIA_FAMILY
,
OB_DEVICE
, and
OB_RESOURCE_WAIT_TIME
. You might set such
variables with the mysqlbackup by
specifying an option such as
--sbt-environment="OB_MEDIA_FAMILY=my_mf,OB_DEVICE=my_tape"
.
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, --sbt-environment="VAR1=multiple
words,VAR2=<angle_brackets>,VAR3=2+2\=4"
.
--disable-manifest
Disable generation of
manifest files for a
backup operation, which are
backup_create.xml
and
backup_content.xml
present in the
meta
subdirectory.