MySQL Enterprise Backup User's Guide (Version 8.0.22)

Abstract

This is the user manual for MySQL Enterprise Backup, a commercially licensed backup utility for MySQL databases. It explains the different kinds of backup and restore that can be performed with MySQL Enterprise Backup, and describes the commands for performing them. Strategies for optimizing backup and restore operations are also discussed.

For notes detailing the changes in each release, see the MySQL Enterprise Backup 8.0 Release Notes.

For legal information, including licensing information, see the Preface and Legal Notices.

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Document generated on: 2020-10-29 (revision: 8221)


Table of Contents

Preface and Legal Notices
I Getting Started with MySQL Enterprise Backup
1 Introduction to MySQL Enterprise Backup
1.1 The mysqlbackup Client
1.2 Overview of Backup Types
1.3 Files that Are Backed Up
1.3.1 Types of Files Contained in a Backup
1.3.2 Files Backed up for InnoDB Data
1.3.3 Files Backed up for Data Stored with MyISAM and Other Storage Engines
1.3.4 Files Generated by mysqlbackup
1.4 The Backup Process
2 Installing MySQL Enterprise Backup
3 What's New in MySQL Enterprise Backup 8.0?
II Using MySQL Enterprise Backup
4 Backing Up a Database Server
4.1 Before the First Backup
4.1.1 Collect Database Information
4.1.2 Grant MySQL Privileges to Backup Administrator
4.1.3 Designate a Location for the Backup Directory
4.2 The Typical Backup / Verify / Restore Cycle
4.2.1 Backing Up an Entire MySQL Instance
4.2.2 Verifying a Backup
4.2.3 Restoring a Database
4.3 Backup Scenarios and Examples
4.3.1 Making a Single-File Backup
4.3.2 Making a Full Backup
4.3.3 Making a Differential or Incremental Backup
4.3.4 Making a Compressed Backup
4.3.5 Making a Partial Backup
4.3.6 Making an Optimistic Backup
4.3.7 Making a Back Up of In-Memory Database Data
4.3.8 Making Scheduled Backups
4.4 Making Backups with a Distributed File System (DFS) or Storage Access Network (SAN)
5 Recovering or Restoring a Database
5.1 Performing a Restore Operation
5.1.1 Restoring a Compressed Backup
5.1.2 Restoring an Encrypted Backup Image
5.1.3 Restoring an Incremental Backup
5.1.4 Table-Level Recovery (TLR)
5.1.5 Restoring Backups Created with the --use-tts Option
5.1.6 Restoring External InnoDB Tablespaces to Different Locations
5.1.7 Advanced: Preparing and Restoring a Directory Backup
5.2 Restoring a Backup from Cloud Storage to a MySQL Server
5.3 Point-in-Time Recovery
5.4 Restoring a Backup with a Database Upgrade or Downgrade
6 Working with Encrypted InnoDB Tablespaces
7 Backing up Using Redo Log Archiving
8 Using MySQL Enterprise Backup with Replication
8.1 Setting Up a New replica
8.2 Backing up and Restoring a Replica Database
8.3 Restoring a Source Database
8.4 Working with Encrypted Binary and Relay Logs
9 Using MySQL Enterprise Backup with Group Replication
10 Encryption for Backups
11 Using MySQL Enterprise Backup with Media Management Software (MMS) Products
11.1 Backing Up to Tape with Oracle Secure Backup
12 Using MySQL Enterprise Backup with Docker
13 Performance Considerations for MySQL Enterprise Backup
13.1 Optimizing Backup Performance
13.2 Optimizing Restore Performance
14 Monitoring Backups with MySQL Enterprise Monitor
15 Using MySQL Enterprise Backup with MySQL Enterprise Firewall
16 Using LDAP for Server Authentication
17 Troubleshooting for MySQL Enterprise Backup
17.1 Exit codes of MySQL Enterprise Backup
17.2 Working Around Corruption Problems
17.3 Using the MySQL Enterprise Backup Logs
17.4 Using the MySQL Enterprise Backup Manifest
III mysqlbackup Command Reference
18 mysqlbackup
19 mysqlbackup commands
19.1 Backup Operations
19.2 Update Operations
19.3 Restore Operations
19.4 Validation Operations
19.5 Other Single-File Backup Operations
19.6 Other Operations
20 mysqlbackup Command-Line Options
20.1 General Options
20.2 Connection Options
20.3 Server Repository Options
20.4 Backup Repository Options
20.5 Metadata Options
20.6 Compression Options
20.7 Incremental Backup Options
20.8 Partial Backup and Restore Options
20.9 Single-File Backup Options
20.10 Performance / Scalability / Capacity Options
20.11 Message Logging Options
20.12 Progress Report Options
20.13 Encryption Options
20.14 Options for Working with Encrypted InnoDB Tablespaces and Encrypted Binary/Relay Logs
20.15 Cloud Storage Options
20.16 Options for Special Backup Types
21 Configuration Files and Parameters
IV Appendixes
A Frequently Asked Questions for MySQL Enterprise Backup
B Limitations of MySQL Enterprise Backup
C Compatibility Information for MySQL Enterprise Backup
C.1 Supported Platforms
C.2 Cross-Platform Compatibility
C.3 Compatibility with MySQL Versions
C.4 Compatibility with Older MySQL Enterprise Backup
D Backup History Table Update
E SBT Backup History Table Update
F Backup Progress Table Update
MySQL Enterprise Backup Glossary
Index

List of Examples

4.1 Single-File Backup to Absolute Path
4.2 Single-File Backup to Relative Path
4.3 Single-File Backup to Standard Output
4.4 Convert Existing Backup Directory to Single Image
4.5 Extract Existing Image to Backup Directory
4.6 List Single-File Backup Contents
4.7 Validate a Single-File Backup
4.8 Extract Single-File Backup into Current Directory
4.9 Extract Single-File Backup into a Backup Directory
4.10 Selective Extract of Single File
4.11 Selective Extract of Single Directory
4.12 Dealing with Absolute Path Names
4.13 Single-File Backup to a Remote Host
4.14 Single-file Backup to a Remote MySQL Server
4.15 Stream a Backup Directory to a Remote MySQL Server
4.16 Creating a Cloud Backup on Oracle Cloud Infrastructure Object Storage
4.17 Creating a Cloud Incremental Backup on Oracle Cloud Infrastructure
4.18 Creating a Cloud Backup on an OpenStack Object Storage
4.19 Creating a Cloud Backup in an Amazon S3 Bucket
4.20 Creating a Cloud Incremental Backup in an Amazon S3 Bucket
4.21 Making an Uncompressed Partial Backup of InnoDB Tables
4.22 Making a Compressed Partial Backup
4.23 Optimistic Backup Using the Option optimistic-time=YYMMDDHHMMSS
4.24 Optimistic Backup Using the Option optimistic-time=now
4.25 Optimistic Backup Using the optimistic-busy-tables Option
4.26 Optimistic and Partial Backup Using both the optimistic-busy-tables and optimistic-time Options
5.1 Restoring a Database
5.2 Restoring a Compressed Backup
5.3 Restoring a Compressed Directory Backup
5.4 Restoring a Compressed and Prepared Directory Backup
5.5 Restoring an Encrypted Backup Image
5.6 Restoring an Incremental Backup Image
5.7 Restoring A Selected Table from an Image Backup
5.8 Restoring Selected Tables in a Schema from an Image Backup
5.9 Restoring and Renaming a Table from a TTS Backup
5.10 Restoring a Backup Directory using copy-back-and-apply-log
5.11 Applying the Log to a Backup
5.12 Applying the Log to a Compressed Backup
5.13 Restoring a Single-file Backup from an Oracle Cloud Infrastructure (OCI) Object Storage to a MySQL Server
5.14 Restoring a Cloud Incremental Backup from an Oracle Cloud Infrastructure (OCI) Object Storage to a MySQL Server
5.15 Restoring a Single-file Backup from an OpenStack Object Storage to a MySQL Server
5.16 Restoring a Single-file Backup from Amazon S3 to a MySQL Server
11.1 Sample mysqlbackup Commands Using MySQL Enterprise Backup with Oracle Secure Backup
16.1 Backup Using Simple LDAP Authentication
16.2 TTS Restore Using Simple LDAP Authentication
16.3 Backup Using SALS-based LDAP Authentication
16.4 TTS Restore Using SALS-based Authentication
19.1 Apply Log to Full Backup
21.1 Sample backup-my.cnf file