1mysql‐zrm(1)
2mysql‐zrm(1)
3
4
5
6NNAAMMEE
7       mmyyssqqll‐‐zzrrmm ‐ Backup and recovery utility for ZRM for MySQL
8
9SSYYNNOOPPSSIISS
10       mmyyssqqll‐‐zzrrmm ‐‐‐‐aaccttiioonn [ bbaacckkuupp | rreessttoorree | sscchheedduullee‐‐bbaacckkuupp  |
11rreeppoorrtt | lliisstt
12       |  ppuurrggee  |  ppaarrssee‐‐bbiinnllooggss  |  cchheecckk   |  vveerriiffyy‐‐bbaacckkuupp  |
13eexxttrraacctt‐‐bbaacckkuupp  |
14       aabboorrtt‐‐bbaacckkuupp ]
15
16
17DDEESSCCRRIIPPTTIIOONN
18       ZRM  for  MySQL  provides  automated  scheduling  of  live
19MySQL database
20       backup.  You only need to configure it once to reflect the
21MySQL deploy‐
22       ment,  then  schedule it to run unattended backups.  Vari‐
23ous options can
24       help an administrator:
25
26       * Verify the backups created.
27
28       * Generate various types of reports about the backups cre‐
29ated.
30
31       * Specify compression and encryption as desired.
32
33       * Report information about the backups via an email or RSS
34feed.
35
36       * Access pre‐ and post‐ backup plugins to extend the suite
37further.
38
39       * Control full and selective  restore  operations  on  the
40database,  both
41       locally and remotely.
42
43       ZRM    for    MySQL’s  primary  command  line  utility  is
44mmyyssqqll‐‐zzrrmm, which pro‐
45       vides the core backup/restore functions  for  MySQL  data‐
46bases.
47
48       Use   the  mmyyssqqll‐‐zzrrmm..ccoonnff(5)  configuration  file  to  set
49mmyyssqqll‐‐zzrrmm  options.
50       Use the ‐‐‐‐aaccttiioonn cchheecckk option to verify the  configuration
51of mmyyssqqll‐‐zzrrmm.
52
53       Use  mmyyssqqll‐‐zzrrmm  to  create  full or incremental backups of
54MySQL  databases
55       and  perform  full,  incremental  and  selective  restores
56as well. The
57       ‐‐‐‐lliisstt option provides information about prior backups.
58
59       To  display  help on individual action options, append the
60‐‐‐‐hheellpp  option
61       to the appropriate command line.  For  example:  mmyyssqqll‐‐zzrrmm
62‐‐‐‐aaccttiioonn bbaacckkuupp
63       ‐‐‐‐hheellpp
64
65
66BBAACCKKUUPP SSEETTSS
67       ZRM  for  MySQL  organizes the backups into ’backup sets.’
68Each backup set
69       defines:
70
71       * a list of database(s) or table(s) within a  database  to
72back up
73
74       * backup options to use on this backup set
75
76       * scheduling options to use on this backup set.
77
78       Backup sets are identified by a unique name.
79
80
81       Every   backup   run  (each time mmyyssqqll‐‐zzrrmm is executed) is
82associated with
83       one backup set. Various parameters can be associated  with
84each  backup
85       run.
86
87       mmyyssqqll‐‐zzrrmm     first     reads    the    global    configu‐
88ration    file
89       (//eettcc//mmyyssqqll‐‐zzrrmm//mmyyssqqll‐‐zzrrmm..ccoonnff). The global  configuration
90file  can  be
91       overridden     by    any    backup    set    configuration
92file  stored  in
93       //eettcc//mmyyssqqll‐‐zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e/ directory.  The  mmyyssqqll‐‐zzrrmm
94command  line
95       options   will  override  the  parameters specified in the
96configuration
97       files.
98
99
100BBAACCKKUUPP MMEETTHHOODDSS
101       mmyyssqqll‐‐zzrrmm backups can be either full or incremental.  Full
102backups  can
103       be   logical backups or raw backups.  Logical backups con‐
104tain SQL state‐
105       ments to recreate the database.  Raw  backups  are  actual
106copies  of  the
107       database files.
108
109       When   logical  backup is specified, the utility uses only
110mmyyssqqlldduummpp for
111       backing up specified databases and tables.
112
113       When raw backup is specified, the utility has  the  abili‐
114ty  to  decide
115       which  backup  mechanism to use for a particular database.
116If there are
117       no transactional storage engine based tables in the speci‐
118fied database,
119       it   uses  mmyyssqqllhhoottccooppyy for backing up that database. Oth‐
120erwise, it uses
121       mmyyssqqlldduummpp for backing up the specified database.
122
123       An index file is also created in the backup directory. The
124index  con‐
125       tains   the   details of what was backed up, how much data
126was backed up,
127       what parameters were used to backup  the  data,  how  much
128time it took  to
129       backup etc.
130
131
132RREECCOOVVEERRYY
133       When   restoring  databases,  only  the  aallll‐‐ddaattaabbaasseess and
134ddaattaabbaasseess options
135       are  allowed.   In  the  case  of   clusters,   only   the
136aallll‐‐ddaattaabbaasseess option is
137       allowed.
138
139       When the backup contains only specific tables from a data‐
140base, you need
141       to specify mmyyssqqll‐‐zzrrmm action as restore  and  the  database
142name to restore
143       the  backed  up tables.  Tables not included in the backup
144but present in
145       the database will be left untouched.
146
147
148AACCTTIIOONNSS
149       Specify bbaacckkuupp to initiate a backup run.
150
151       Use rreessttoorree to restore from a specified backup.
152
153       Use sscchheedduullee‐‐bbaacckkuupp to setup the schedule for the backup.
154
155       specify rreeppoorrtt to generate reports on backup runs.
156
157       Use cchheecckk to verify if a backup set configuration is  cor‐
158rect.
159
160       Use  lliisstt  to  display  the backup level, the name of  the
161directory  con‐
162       taining  the  backup  and the index of the last backup  of
163the specified
164       backup set.
165
166       Action ppaarrssee‐‐bbiinnllooggss will display the parsed output of the
167binary logs.
168       This  is  useful  to  find out the  log  positions  and/or
169timestamp to be
170       used for restore operations.
171
172       Specify  ppuurrggee  to remove backups present in the directory
173specified  by
174       the destination option whose retention policy has been ex‐
175ceeded.
176
177       Specify vveerriiffyy‐‐bbaacckkuupp to verify a backup
178
179       Use eexxttrraacctt‐‐bbaacckkuupp to uncompress/decrypt a specified back‐
180up
181
182       Specify aabboorrtt‐‐bbaacckkuupp to abort the backup run for  a  given
183backup‐set.
184
185
186OOPPTTIIOONNSS
187       ‐‐‐‐aaccttiioonn bbaacckkuupp | rreessttoorree | sscchheedduullee‐‐bbaacckkuupp | rreeppoorrtt |
188                  lliisstt   |   ppuurrggee  |  ppaarrssee‐‐bbiinnllooggss  |  cchheecckk  |
189vveerriiffyy‐‐bbaacckkuupp |
190                  eexxttrraacctt‐‐bbaacckkuupp | aabboorrtt‐‐bbaacckkuupp
191
192              These mutually exclusive  ‐‐‐‐aaccttiioonn  options  choose
193the basic func‐
194              tionality  of the utility. This form cannot be used
195in  the  con‐
196              figuration file.
197
198
199
200FFIILLEESS
201       //vvaarr//lliibb//mmyyssqqll‐‐zzrrmm
202              Directory under which all backup data is stored.
203
204
205       //eettcc//mmyyssqqll‐‐zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e//mmyyssqqll‐‐zzrrmm..ccoonnff
206              Configuration file ZRM for MySQL.
207
208
209RREETTUURRNN VVAALLUUEESS
210       On success, zero is returned. On error, non‐zero value  is
211returned.
212
213
214SSEEEE AALLSSOO
215       mysql‐zrm‐backup(1),           mysql‐zrm‐manage‐backup(1),
216mysql‐zrm‐man‐
217       age‐backup(1),        mysql‐zrm‐restore(1),         mysql‐
218zrm‐check(1),
219       mysql‐zrm‐list(1),    mysql‐zrm‐parse‐binlogs(1),   mysql‐
220zrm‐purge(1),
221       mysql‐zrm‐extract‐backup(1),                mysql‐zrm‐ver‐
222ify‐backup(1),
223       mysql‐zrm‐abort‐backup(1),                      mysql‐zrm‐
224scheduler(1),
225       mysql‐zrm‐reporter(1),  mysql‐zrm.conf(5),   mysqldump(1),
226mysqlbinlog(1),
227       mysql(1),   lvm(8),   Zmanda  Recovery  Manager  for MySQL
228(http://mysql‐
229       backup.zmanda.com/)
230
231
232AAUUTTHHOORR
233       Zmanda Inc. (http://www.zmanda.com)
234
235
236
237Zmanda,     Inc.                          ZRM      for      MySQL
238mysql‐zrm(1)
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264