Mysql-zrm-reporter

From wiki.zmanda.com
Revision as of 23:24, 31 August 2006 by Paddy (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

NAME

mysql-zrm-reporter - MySQL backup reporting tool.

SYNOPSIS

mysql-zrm-reporter --fields <name1,name2,name3 ....>
                   [--directory <dir> ] 
                   [--key <name=value>]
                   [--help]

DESCRIPTION

This tool is part of Zmanda Recovery Manager for MySQL (MySQL ZRM). This tool can be used to display various information regarding MySQL database backups created using mysql-zrm(1) tool.

BACKUP INFORMATION

The list of information available for each backup run:

backup-set
Name of the Backup Set
backup-date
Date and time stamp of Backup
mysql-version
MySQL server version
backup-directory
The location of backup directory
backup-level
Backup level (full or incremental)
raw-databases
List of databases that have raw backups
backup-time
Time taken to do the backup
backup-size
Size of backup
next-binlog
Next binary log file name
last-backup
Location of the last backup for this backup set
backup-status
Status of the backup run. The values can be "Backup Failed", "Backup done with errors", "Backup succeeded".
raw-tables(snapshot)
List of tables backed up using LVM snapshots
raw-tables
List of tables backed up using mysqlhotcopy
logical-databases
List of databases backed up using mysqldump(1)
logical-tables
List of tables belonging to "logical-databases" backed up using mysqldump(1)
replication
Names of replication files that were backed up
slave-load-files
Names of SQL_LOAD* files that were backed up

OPTIONS

--directory <dir>
Specify the backup root directory, default value is /var/lib/mysql-zrm
--fields <name1,name2,name3...>
Specify list of backup parameters to display. List of field names are described in BACKUP INFORMATION section.
--key <name=value>
The tool will display the MySQL backup parameters where the key matches value.
--help
Display help message and exit.

EXAMPLES

Following command displays backup date, location of backups, backup set name:

# mysql-zrm-reporter --directory /var/lib/mysql-zrm/backup --fields backup-date,backup-directory,backup-set

Following command displays size of backup, backup set name, and date of backup:

# mysql-zrm-reporter --directory /var/lib/mysql-zrm/backup --fields backup-date,backup-set,backup-size

Following command searches all index files for "config1" backup-set name and displays size of backup, backup set name and date of backup

# mysql-zrm-reporter --directory /var/lib/mysql-zrm/backup --fields backup-date,backup-set,backup-size \
  --key backup-set=config1

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(1), mysql-zrm-scheduler(1), mysql(1)

AUTHOR

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