Documentation Home
MySQL Enterprise Backup 9.5 User's Guide
Related Documentation Download this Manual
PDF (US Ltr) - 1.3Mb
PDF (A4) - 1.3Mb


19.5 Other Single-File Backup Operations

Besides the commands for creating and restoring single-file backups (namely,backup-to-image andcopy-back-and-apply-log),mysqlbackup provides a number of other commands for you to work with single-file backups. They are explained below.

mysqlbackup [STD-OPTIONS]            [--backup-image=IMAGE]            [--backup-dir=PATH]            [--src-entry=PATH] [--dst-entry=PATH]            [--uncompress]            [MESSAGE-LOGGING-OPTIONS]            [PROGRESS-REPORT-OPTIONS]            [ENCRYPTION-OPTIONS]            [CLOUD-STORAGE-OPTIONS]            image-to-backup-dirmysqlbackup [STD-OPTIONS]            [--backup-dir=PATH] [--backup-image=IMAGE]            [MESSAGE-LOGGING-OPTIONS]            [PROGRESS-REPORT-OPTIONS]            [ENCRYPTION-OPTIONS]            [CLOUD-STORAGE-OPTIONS]            backup-dir-to-imagemysqlbackup [STD-OPTIONS]            [--backup-image=IMAGE]            [MESSAGE-LOGGING-OPTIONS]            [ENCRYPTION-OPTIONS]            [CLOUD-STORAGE-OPTIONS]            list-imagemysqlbackup [STD-OPTIONS]            [--backup-image=IMAGE]            [--backup-dir=PATH]            [--src-entry=PATH] [--dst-entry=PATH]            [--uncompress]            [MESSAGE-LOGGING-OPTIONS]            [PROGRESS-REPORT-OPTIONS]            [ENCRYPTION-OPTIONS]            [CLOUD-STORAGE-OPTIONS]            extract

  • image-to-backup-dir

    It is an alias for theextract command; see the description below forextract.

    Note

    image-to-backup-dir only creates araw backup directory, which is NOT ready to be restored by thecopy-back command. To become aprepared backup, the backup directory has to go through anapply-log operation, executed either by a stand-aloneapply-log command or as a part of acopy-back-and-apply-log command.

  • backup-dir-to-image

    Packs an existing backup directory into a single file. The value for the--backup-image parameter should either be“-”(stands for standard output) or an absolute path outside of thebackup-dir directory. Specify a--backup-image value of- (standard output) to stream an existing backup directory structure to a tape device or a command that transfers the backup to another server. For usage examples, seeSection 4.3.1, “Making a Single-File Backup”.

  • list-image

    Display the contents of a single-file backup. Lists all files and directories in the image. For usage examples, seeSection 4.3.1, “Making a Single-File Backup”.

    Note

    Thelist-image operation can be performed on a cloud backup only if the cloud proxy supports HTTP range headers.

  • extract

    Unpacks individual files or directories from a single-file backup. It is useful for troubleshooting, or for restorations that do not require the full set of backup data. The resulting file or directory goes into the current directory, or into thebackup directory, if specified with--backup-dir; in either case, the destination directory must be empty. For usage examples, seeSection 4.3.1, “Making a Single-File Backup”.

    The--src-entry=string option can be used for selective extraction of files or directories whose path names in the image contain thestring specified with the option.

    Notes

    • Some items are always extracted from the backup; see the descriptions of--src-entry for details.

    • The option is currently not supported for the extraction of cloud backups, which can only be extracted in full.

    Tip

    If you want to extract only from specific directories (for example,datadir/meta), add a slash at the end of the option value (--src-entry=meta/); otherwise, any file or directory in the backup that contains the value in its pathname (including, for example,datadir/pets/metabolism.ibd) will also be extracted.

    The--dst-entry=path option, along with--src-entry=path option, can be used to extract files or directories into user-specified locations; see the description for the option for details.

    Use the--uncompress option to extract files from a compressed single-file backup (the--uncompress option is not requiredwhen the--src-entry is used).

    The default destination for the extract is the current working directory. All the files with relative pathnames in the image are extracted to pathnames relative to the destination directory. If the image contains some entries with absolute pathnames, those entries are extracted to the same absolute pathnames on the local system even if the--backup-dir option is specified. The--dst-entry option must be used to relocate an absolute pathname; seeExample 4.12, “Dealing with Absolute Path Names”.

    Important

    Even with all files extracted from the backup image,extract only creates araw backup directory, which is NOT ready to be restored by thecopy-back command. To become aprepared backup, the backup directory has to go through anapply-log operation, executed either by a stand-aloneapply-log command or as a part of acopy-back-and-apply-log command.