mysql-zrm man page

mysql-zrm(1)                                                      mysql-zrm(1)

NNAAMMEE
      mmyyssqqll--zzrrmm - Backup and recovery utility for ZRM for MySQL

SSYYNNOOPPSSIISS
      mmyyssqqll--zzrrmm ----aaccttiioonn [ bbaacckkuupp | rreessttoorree | sscchheedduullee--bbaacckkuupp | rreeppoorrtt | lliisstt
      | ppuurrggee | ppaarrssee--bbiinnllooggss | cchheecckk  |  vveerriiffyy--bbaacckkuupp  |  eexxttrraacctt--bbaacckkuupp  |
      aabboorrtt--bbaacckkuupp ]

DDEESSCCRRIIPPTTIIOONN
      ZRM  for  MySQL  provides  automated  scheduling of live MySQL database
      backup. You only need to configure it once to reflect the MySQL deploy-
      ment,  then  schedule it to run unattended backups. Various options can
      help an administrator:

      * Verify the backups created.

      * Generate various types of reports about the backups created.

      * Specify compression and encryption as desired.

      * Report information about the backups via an email or RSS feed.

      * Access pre- and post- backup plugins to extend the suite further.

      * Control full and selective restore operations on the  database,  both
      locally and remotely.

      ZRM  for  MySQL’s primary command line utility is mmyyssqqll--zzrrmm, which pro-
      vides the core backup/restore functions for MySQL databases.

      Use the mmyyssqqll--zzrrmm..ccoonnff(5) configuration file to set mmyyssqqll--zzrrmm  options.
      Use the ----aaccttiioonn cchheecckk option to verify the configuration of mmyyssqqll--zzrrmm.

      Use mmyyssqqll--zzrrmm to create full or incremental backups of MySQL  databases
      and  perform  full,  incremental  and  selective  restores as well. The
      ----lliisstt option provides information about prior backups.

      To display help on individual action options, append the ----hheellpp  option
      to the appropriate command line. For example: mmyyssqqll--zzrrmm ----aaccttiioonn bbaacckkuupp
      ----hheellpp

BBAACCKKUUPP SSEETTSS
      ZRM for MySQL organizes the backups into ’backup sets.’ Each backup set
      defines:

      * a list of database(s) or table(s) within a database to back up

      * backup options to use on this backup set

      * scheduling options to use on this backup set.

      Backup sets are identified by a unique name.

      Every  backup  run (each time mmyyssqqll--zzrrmm is executed) is associated with
      one backup set. Various parameters can be associated with  each  backup
      run.

      mmyyssqqll--zzrrmm     first     reads    the    global    configuration    file
      (//eettcc//mmyyssqqll--zzrrmm//mmyyssqqll--zzrrmm..ccoonnff). The global configuration file  can  be
      overridden   by   any   backup   set   configuration   file  stored  in
      //eettcc//mmyyssqqll--zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e/ directory. The mmyyssqqll--zzrrmm  command  line
      options  will  override  the  parameters specified in the configuration
      files.

BBAACCKKUUPP MMEETTHHOODDSS
      mmyyssqqll--zzrrmm backups can be either full or incremental.  Full backups  can
      be  logical backups or raw backups.  Logical backups contain SQL state-
      ments to recreate the database.  Raw backups are actual copies  of  the
      database files.

      When  logical  backup is specified, the utility uses only mmyyssqqlldduummpp for
      backing up specified databases and tables.

      When raw backup is specified, the utility 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,
      it  uses  mmyyssqqllhhoottccooppyy for backing up that database. Otherwise, it uses
      mmyyssqqlldduummpp for backing up the specified database.

      An index file is also created in the backup directory. The  index  con-
      tains  the  details of what was backed up, how much data was backed up,
      what parameters were used to backup the data, how much time it took  to
      backup etc.

RREECCOOVVEERRYY
      When  restoring databases, only the aallll--ddaattaabbaasseess and ddaattaabbaasseess options
      are allowed.  In the case of clusters, only the aallll--ddaattaabbaasseess option is
      allowed.

      When the backup contains only specific tables from a database, you need
      to specify mmyyssqqll--zzrrmm action as restore and the database name to restore
      the backed up tables.  Tables not included in the backup but present in
      the database will be left untouched.

AACCTTIIOONNSS
      Specify bbaacckkuupp to initiate a backup run.

      Use rreessttoorree to restore from a specified backup.

      Use sscchheedduullee--bbaacckkuupp to setup the schedule for the backup.

      specify rreeppoorrtt to generate reports on backup runs.

      Use cchheecckk to verify if a backup set configuration is correct.

      Use lliisstt to display the backup level, the name of  the  directory  con-
      taining  the  backup  and the index of the last backup of the specified
      backup set.

      Action ppaarrssee--bbiinnllooggss 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.

      Specify ppuurrggee to remove backups present in the directory  specified  by
      the destination option whose retention policy has been exceeded.

      Specify vveerriiffyy--bbaacckkuupp to verify a backup

      Use eexxttrraacctt--bbaacckkuupp to uncompress/decrypt a specified backup

      Specify aabboorrtt--bbaacckkuupp to abort the backup run for a given backup-set.

OOPPTTIIOONNSS
      ----aaccttiioonn bbaacckkuupp | rreessttoorree | sscchheedduullee--bbaacckkuupp | rreeppoorrtt |
                 lliisstt | ppuurrggee | ppaarrssee--bbiinnllooggss | cchheecckk | vveerriiffyy--bbaacckkuupp |
                 eexxttrraacctt--bbaacckkuupp | aabboorrtt--bbaacckkuupp

             These mutually exclusive ----aaccttiioonn options choose the basic func-
             tionality of the utility. This form cannot be used in  the  con-
             figuration file.

FFIILLEESS
      //vvaarr//lliibb//mmyyssqqll--zzrrmm
             Directory under which all backup data is stored.

      //eettcc//mmyyssqqll--zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e//mmyyssqqll--zzrrmm..ccoonnff
             Configuration file ZRM for MySQL.

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

SSEEEE AALLSSOO
      mysql-zrm-backup(1),     mysql-zrm-manage-backup(1),     mysql-zrm-man-
      age-backup(1),        mysql-zrm-restore(1),         mysql-zrm-check(1),
      mysql-zrm-list(1),    mysql-zrm-parse-binlogs(1),   mysql-zrm-purge(1),
      mysql-zrm-extract-backup(1),                mysql-zrm-verify-backup(1),
      mysql-zrm-abort-backup(1),                      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 (http://mysql-
      backup.zmanda.com/)

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

Zmanda, Inc.                     ZRM for MySQL                    mysql-zrm(1)

Referenced By

mysql-zrm-abort-backup(1), mysql-zrm-backup(1), mysql-zrm-check(1), mysql-zrm.conf(5), mysql-zrm-extract-backup(1), mysql-zrm-list(1), mysql-zrm-parse-binlogs(1), mysql-zrm-purge(1), mysql-zrm-restore(1), mysql-zrm-scheduler(1), mysql-zrm-verify-backup(1).