Partial Backup and Restore with Mariabackup
When using Mariabackup, you have the option of performing partial backups. Partial backups allow you to choose which databases or tables to backup, as long as the table or partition involved is in an InnoDB file-per-table tablespace.This page documents how to perform partial backups.
Backing up the Database Server
Just like with full backups, in order to back up the database, you need to run Mariabackup with the
--backup option to tell it to perform a backup and with the
--target-dir option to tell it where to place the backup files. The target directory must be empty or not exist.
For a partial backup, there are a few other arguments that you can provide as well:
- To tell it which databases to backup, you can provide the
- To tell it which databases to exclude from the backup, you can provide the
- To tell it to check a file for the databases to backup, you can provide the
- To tell it which tables to backup, you can use the
- To tell it which tables to exclude from the backup, you can provide the
- To tell it to check a file for specific tables to backup, you can provide the
The non-file partial backup options support regex in the database and table names.
For example, to take a backup of any database that starts with the string
app1_ and any table in those databases that start with the string
tab_, run the following command:
$ mariabackup --backup \ --target-dir=/var/mariadb/backup/ \ --databases='app1_*' --tables='tab_*' \ --user=mariabackup --password=mypassword
Mariabackup cannot currently backup a subset of partitions from a partitioned table. Backing up a partitioned table is currently an all-or-nothing selection. See MDEV-17132 about that. If you need to backup a subset of partitions, then one possibility is that instead of using Mariabackup, you can export the file-per-table tablespaces of the partitions.
The time the backup takes depends on the size of the databases or tables you're backing up. You can cancel the backup if you need to, as the backup process does not modify the database.
Mariabackup writes the backup files the target directory. If the target directory doesn't exist, then it creates it. If the target directory exists and contains files, then it raises an error and aborts.
Preparing the Backup
Just like with full backups, the data files that Mariabackup creates in the target directory are not point-in-time consistent, given that the data files are copied at different times during the backup operation. If you try to restore from these files, InnoDB notices the inconsistencies and crashes to protect you from corruption. In fact, for partial backups, the backup is not even a completely functional MariaDB data directory, so InnoDB would raise more errors than it would for full backups. This point will also be very important to keep in mind during the restore process.
Before you can restore from a backup, you first need to prepare it to make the data files consistent. You can do so with the
--prepare command option.
Partial backups rely on InnoDB's transportable tablespaces. For MariaDB to import tablespaces like these, InnoDB looks for a file with a
.cfg extension. For Mariabackup to create these files, you also need to add the
--export option during the prepare step.
For example, you might execute the following command:
$ mariabackup --prepare --export \ --target-dir=/var/mariadb/backup/
If this operation completes without error, then the backup is ready to be restored.
MariaDB until 10.2.8
In MariaDB 10.2.8 and before, Mariabackup did not support the
--export option. See MDEV-13466 about that. In these versions of MariaDB, this means that Mariabackup could not create
.cfg files for InnoDB file-per-table tablespaces during the
--prepare stage. You can still import file-per-table tablespaces without the
.cfg files in many cases, so it may still be possible in those versions to restore partial backups or to restore individual tables and partitions with just the
.ibd files. If you have a full backup and you need to create
.cfg files for InnoDB file-per-table tablespaces, then you can do so by preparing the backup as usual without the
--export option, and then restoring the backup, and then starting the server. At that point, you can use the server's built-in features to copy the transportable tablespaces.
Restoring the Backup
The restore process for partial backups is quite different than the process for full backups. A partial backup is not a completely functional data directory. The data dictionary in the InnoDB system tablespace will still contain entries for the databases and tables that were not included in the backup.
Rather than using the
--copy-back or the
--move-back, each individual InnoDB file-per-table tablespace file will have to be manually imported into the target server. The process that is used to import the file will depend on whether partitioning is involved.
Restoring Individual Non-Partitioned Tables
To restore individual non-partitioned tables from a backup, find the
.cfg files for the table in the backup, and then import them using the Importing Transportable Tablespaces for Non-partitioned Tables process.
Restoring Individual Partitions and Partitioned Tables
To restore individual partitions or partitioned tables from a backup, find the
.cfg files for the partition(s) in the backup, and then import them using the Importing Transportable Tablespaces for Partitioned Tables process.