Mysql-zrm

NAME

mysql-zrm - MySQL backup and recovery tool

SYNOPSIS

mysql-zrm 
        --action <backup|restore|list|purge|parse-binlogs|check|verify-backup|extract-backup>
          [--backup-set <name>]
          [--source-directory <directory name>]
          [--replication | --noreplication]
          [--backup-name <name>]
          [--all-databases]
          [--databases <"name1 name2 ...">]
          [--destination <directory name>]
          [--database <name> [--tables <"name1 name2...">]]
          [--backup-level <0|1>]
          [--backup-mode <raw|logical>]
          [--lvm-snapshot <size>]
          [--retention-policy   <backup retention time>]
          [--compress | --no-compress ]
          [--compress-plugin <plugin>]
          [--no-encrypt | --encrypt]
          [--encrypt-plugin <plugin> [--decrypt-option <option>]
          [--bin-logs <"name1 name2 ...">]
          [--start-position <#>]
          [--stop-position <#>]
          [--offset <#>]
          [--start-datetime <name>]
          [--stop-datetime <name>]
          [--index|--noindex]
          [--till-lastfull]
          [--all-backups]
          [--copy-plugin <plugin>]
          [--pre-backup-plugin <plugin>]
          [--pre-backup-plugin-options <"option1 option2 ...">]
          [--post-backup-plugin <plugin>]
          [--post-backup-plugin-options <"option1 option2 ...">]
          [--parse-binlogs-plugin <plugin>]
          [--parse-binlogs-plugin-options <"option1 option2 ...">]
          [--options-file <filename>]
          [--mailto <mail address>]
          [--user <user>]
          [--password <password>]
          [--host <hostname>]
          [--port <portnumber>]
          [--socket <name>]
          [--mysql-binpath  <location  of MySQL commands>]
          [--mysql-binlog-path <location of MySQL binary logs>]
          [--ssl-options <"MySQL ssl options">]
          [--comment <"Note about the backup">]
          [--quiet|--no-quiet]
          [--verbose]
          [--help]

DESCRIPTION

This tool is part of Zmanda Recovery Manager for MySQL (MySQL ZRM) and is the core engine that performs backup and recovery MySQL databases. ZRM for MySQL is configured using configuration file, mysql-zrm.conf. The backups are scheduled using the ZRM for MySQL scheduler, mysql-zrm-scheduler. Users are expected to use mysql-zrm tool for database restoration, verification of backup images, and parsing incremental backups for selective recovery. Please take a look at ZRM for MySQL documentation for procedures on how to configure and use ZRM for MySQL.

mysql-zrm tool can be used to create full and incremental backups of MySQL databases as well as full, incremental and selective restores. The tool also provides a list option to provide information about the prior backups. The tool also implements retention policy for the backup images. This tool can be used to parse binary logs to find out the timestamp and/or log position of specific events. The action check can be used to verify the configuration of ZRM. The action verify-backup verifies consistency of backup images. The action extract-backup can be used to uncompress and/or decrypt the specified backup. If the specified backup is not compressed or encrypted, extract-backup will fail.

BACKUP SETS

MySQL ZRM organizes the backups in terms of backup sets. Each backup set defines the list of databases or tables within a database, how it should be backed up and the backup schedule for the data. Backup set is identified by an unique string for each MySQL ZRM instance.

Every backup run (each time mysql-zrm is executed) is associated with one backup set.

The mysql-zrm tool reads global MySQL ZRM configuration file (/etc/mysql-zrm/mysql-zrm.conf). The global configuration file can be overridden by backup set specific configuration file stored in /etc/mysql-zrm/<backup set name>/ directory. The mysql-zrm command line options will override the parameters specified in the configuration files.

The order in the which backup set parameters will be read:

1. /etc/mysql-zrm/mysql-zrm.conf
2. /etc/mysql-zrm/<backup set>/mysql-zrm.conf
3. Parameters read from --options-file command line argument
4. Options specified on the command line

BACKUP METHODS

The mysql-zrm full backups can be logical backups or raw backups. Logical backups contain SQL statements to recreate the database. Raw backups are actual copy of the database files. If backup-mode is specified as raw the tool has the ability to decide which backup mechanism to use for a particular database. If there are no transactional storage engine based tables in the specified database, then the utility will use mysqlhotcopy for backing up that database. Otherwise, it will use mysqldump for backing up the specified database. If backup-mode option is specified as logical then only mysqldump will be used for backing up specified databases and tables.

If the lvm-snapshot option is specified and if the specified database is put on an LVM volume then a snapshot of that volume is taken and the database is backed up from that snapshot. If the database is not on a lvm volume then the mysqlhotcopy or mysqldump will be used as per the logic in the last paragraph.

If the replication option is specified and if the mysql server is a slave server, then the utility will also backup all replication related files.

If the destination option is specified then the backups are stored in a sub-directory under the specified directory. Default value is "/var/lib/mysql-zrm". If the destination option is specified and does not exist, the utility will throw an error and exit.

An index file is also created in the backup directory. The index file contains the details of the backup run.

If incremental backup is specified, then the options backup-mode, lvm-snapshot, all-databases, databases, database and tables are ignored.

RECOVERY

For restores, only all-databases and databases options are supported. So if the backup contains only specific tables from a database, you need to specify mysql-zrm action as restore and the database name to restore the backed up tables. This will only restore the backed up tables. If there are other tables in the database, they will be left untouched.

OTHER ACTIONS

If the list action is specified, the tool will display the backup level, the name of the directory containing the backup and the index of the last backup of the specified backup set.

If the all-backups option is specified then the above specified data will be displayed for all of the backups that has happened till date for the given backup-set.

If the till-lastfull option is specified then the data since last full backup will be displayed.

If the source-directory option is specified then the index of that backup is displayed.

If the noindex option is specified then the level of backup and the name of the directory containing the backup will be displayed and the contents of the index file will not be displayed.

If the parse-binlogs action is specified, the utility will display the parsed output of the binary logs. This is useful to find out the log positions and/or timestamp to be used for restore operations. Either the source-directory or the bin-logs option should be specified. If the source-directory option is specified then the parsed output of the binary logs from that backup will be displayed. If bin-logs option is specified then parsed output of the binary log file specified will be displayed.

If the purge action is specified, the utility will remove all backups whose retention policies have been exceeded in the backup directory specified by the destination option.

If the verify-backup action is specified, the utility will check if the backed up data is consistent. The directory containing the backup needs to be specified using the source-directory option.

OPTIONS

--action <backup|restore|list|purge|parse-binlogs|check|verify-backup>

Specify which action to do. This option cannot be specified in the configuration file.

--backup-set <name>

Specify backup-set for the backup run. This option cannot be specified in the configuration file. The default value is BackupSet1

--source-directory <directory name>

Specify the directory containing a backup. This option is ignored if the action specified is backup. For restore action, both source-directory and bin-logs options should not be specified.

--replication | --noreplication

Specify if replication files should be backed up. The replica tion related files will be backed up only if the host is a replication slave. Default option is --noreplication

--backup-name <name>

Specifies the name of the directory in which backup should be done. This should be a unique name for each backup run. If not specified, the current timestamp will be used as the backup name.

--all-databases

Specifies that all databases should be backed up or restored. This is the default if databases or database are not specified.

--databases <"name1 name2 ...">

Specifies the specific databases to backup or restore.

--database <name> [--tables <"name1 name2 ...">]

Specifies which specific tables should be backed up. This option is only supported during the backup operation.

--destination <directory name>

Directory to which backup should be done. Default location is /var/lib/mysql-zrm/. If this option is specified and the directory must be exist and should be writable by the MySQL ZRM user.

--backup-level <0|1>

If 0 is specified, then a full backup is done. If 1 is specified, then incremental backup is done. Default is full backup.

--backup-mode <raw|logical>

If raw is specified then mysqlhotcopy is used to backup the specified database/tables if the database does not contain any tables that uses a transactional engine. Otherwise, mysqldump is used. If logical backup mode is specified then mysqldump is only used. Default value is raw.

--lvm-snapshot <size>

This specifies the size of the lvm snapshot to be used. For raw backups, each specified database is checked to see if that is on a LVM volume. If it is then a snapshot of the specified size is created and that is used to backup up the database. If not it will use either mysqlhotcopy or mysqldump based on the logic described in the backup-mode option. This option is ignored if the backup-mode is logical.

--retention-policy <backup retention time>

Backup image for this backup run will retained for the time specified as parameter. A suffix of 'D' indicates time specified in days. A suffix of 'W' indicates amount specified in weeks (number of days are computed as 7*amount). A suffix of 'M' indicates amount in months (number of days are computed as 30*amount).A suffix of 'Y' indicates amount specified in years (number of days are computed as 365*amount). For example: if --retention-policy 10M is specified, it indicates that the backup should be retained for 300 days. If no suffix is specified, the amount specified is assumed to be number of days the backup should be retained. The default value is retain backups forever.

--compress|--no-compress

Specifies if the backup images should be compressed or not. Default compression command used is gzip. Default is no compression.

--compress-plugin <plugin>

The program used for compressing backup images. The specified <plugin> is used for compression (plugin must accept -d option to uncompressing data). The full path to the <plugin> must be specified. This parameter is optional and default is gzip.

--no-encrypt| --encrypt

Specifies if the backup should be encrypted. This parameter is optional and the default is no encryption. Encryption keys are not managed by MySQL ZRM.

--encrypt-plugin <plugin> [--decrypt-option <option>]

Specifies that the backup should be encrypted using <plugin>. This must be specified if --encrypt is specified. If decrypt-option is not specified then -d option of encrypt-plugin is used for decrypting. <plugin> should specify the full path to the encryption utility. This parameter must be specified if backup encryption is enabled.

--bin-logs <"name1 name2 ...>

List of binary log files to be used for restore. The full path for each file should be specified. For restore action, both source-directory and bin-logs options should not be specified.

--start-position N

Start selective restore of all events after log position N. Log positions can be determined using parse-binlogs action.

--stop-position N

Stop selective restore of all events before log position N. Log positions can be determined using parse-binlogs action.

--offset N

Skip the first N entries of the first binary log file in bin-logs parameter.

--start-datetime <datetime>

Start selective restore from specified date and time (should be in MySQL DATETIME or TIMESTAMP format).

--stop-datetime <datetime>

Selective restore till specified date and time (should be in MySQL DATETIME or TIMESTAMP format).

--index|--noindex

Specify if the contents of the index file should be displayed during the list action.

--all-backups

Specifies that information about all available backups should be displayed.

--till-lastfull

Specifies that information till the last full backup should be displayed.

--copy-plugin <plugin>

Specifies the plugin to be used for transferring backup files to and from a remote mysql server to the machine running MySQL ZRM. This is the mechanism to use if remote incremental backup is required or to copy replication related files from a remote machine or to execute mysqlhotcopy(MySQL command) and copy the data from the remote machine or to restore data to a remote machine. The full path to the plugin must be specified. This parameter is optional.

--pre-backup-plugin <plugin>

Specifies the plugin to be called before a backup run. The full path of the plugin must be specified. This parameter is optional.

--pre-backup-plugin-options <"option1 option2 ...">

These options are passed to the pre-backup-plugin as one of the command line arguments.

--post-backup-plugin <plugin>

Specifies the plugin to be called after a backup run. The full path of the plugin must be specified. This plugin is optional.

--post-backup-plugin-options <"option1 option2 ...">

These options are passed to the post-backup-plugin as one of the command line arguments.

--parse-binlogs-plugin <plugin>

Plugin that can be used filter the output of parse-binlogs action. The full path of the plugin needs to be specified. This plugin is optional.

--parse-binlogs-plugin-options <"option1 option2 ...">

These options are passed to the parse-binlogs-plugin as one of the command line arguments.

--options-file <filename>

Specify the file containing all of the MySQL command options.

--mailto <mail address>

Address to which backup report to be sent.

--user <user>

Specify MySQL backup/restore user

--password <password>

Specify password for the MySQL user

--host <hostname>

MySQL server host name or IP name

--port <portnumber>

MySQL server port

--socket <name>

Socket file to use for communication with MySQL server

--mysql-binpath <mysql binaries directory>

Full path where mysql binaries are installed. For example: /opt/lampp/bin

--mysql-binlog-path <location of mysql binary logs>

Full path of the location of mysql binary logs. For example: /var/log/mysql

--ssl-options <"MySQL ssl options">

Any --ssl* options that MySQL supports. Please refer to Zmanda Recovery Manager documentation for SSL options details.

--comment <"Note about the backup run">

Comment or a note about the backup run. This can be used to tag backup runs and the note can retrieved using mysql-zrm-reporter(1) tool.

--quiet|--no-quiet

Specifying no-quiet will lead to the log messages also being displayed on stdout. Default is --no-quiet.

--verbose

Provide more verbose output in the log.

--help

Display help message and exit. This option cannot be specified in the options file.

EXAMPLES

mysql-zrm is used for database restoration, verification of backup images and parsing binary logs (incremental backups).

For restoring backup image dated 18 Aug 2006 (backup image can be either full or incremental backup):

mysql-zrm --action restore --source-directory /var/lib/mysql-zrm/backupset1/20060818121532

The above command will restore all databases that were backed up. If the source directory points to a full backup, it will do a full restore else it will do a incremental restore.

mysql-zrm --action restore --source-directory /var/lib/mysql-zrm/backupset1/20060818121532 \
          --databases "db1 db2 db3

The above command does a selective restore of the specified databases that were backed up.

The following command does a selective restore of all specified binary log files using a single MySQL server connection.

mysql-zrm  --action restore \
           --bin-logs /var/lib/mysql-zrm/backupset1/20060818121532/mysql-bin.[0-9]* \
                      /var/lib/mysql-zrm/backupset1/20060819121532/mysql-bin.[0-9]*

The following command parses and displays the relevant contents of all specified binary log files. This can be used to find out what position and or timestamp to use for selective restores.

 mysql-zrm  --action parse-binlogs \
            --bin-logs /var/lib/mysql-zrm/backupset1/20060818121532/mysql-bin.[0-9]* \
                       /var/lib/mysql-zrm/back-upset1/20060819121532/mysql-bin.[0-9]*

The following command verifies the backup images of the last backup run for the backup set backup.

 mysql-zrm --action verify-backup --backup-set backup

FILES

/var/lib/mysql-zrm

Directory under which all backup data is stored.

/etc/mysql-zrm/<backup set name>/mysql-zrm.conf

Configuration file read by mysql-zrm tool.

RETURN VALUES

On success, zero is returned. On error, non-zero value is returned.

SEE ALSO

mysql-zrm-scheduler(1), mysql-zrm-reporter(1), mysql-zrm.conf(5), mysqldump(1), mysqlbinlog(1), mysql(1), lvm(8), Zmanda Recovery Manager for MySQL

AUTHOR

Zmanda Inc. (http://www.zmanda.com)