1mysql‐zrm‐backup(1) mysql‐
2zrm‐backup(1)
3NNAAMMEE
7 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp ‐ Backup utility for ZRM for MySQL.
8SSYYNNOOPPSSIISS
10 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
11 [‐‐‐‐bbaacckkuupp‐‐sseett _n_a_m_e]
12 [_B_a_c_k_u_p _S_o_u_r_c_e _O_p_t_i_o_n_s]
13 [_M_y_S_Q_L _A_c_c_e_s_s _O_p_t_i_o_n_s]
14 [_B_a_c_k_u_p _M_e_t_h_o_d _O_p_t_i_o_n_s]
15 [_B_a_c_k_u_p _D_e_s_t_i_n_a_t_i_o_n _O_p_t_i_o_n_s]
16 [_L_o_g_g_i_n_g _a_n_d _N_o_t_i_f_i_c_a_t_i_o_n _O_p_t_i_o_n_s]
17 [‐‐‐‐ooppttiioonnss‐‐ffiillee _c_o_n_f___f_i_l_e]
18 [‐‐‐‐hheellpp]]
19BBaacckkuupp SSoouurrccee SSyynnooppssiiss
21 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
22 [‐‐‐‐aallll‐‐ddaattaabbaasseess] | [‐‐‐‐ddaattaabbaasseess "_d_b_n_a_m_e_1
23_d_b_n_a_m_e_2"...] |
24 [‐‐‐‐ddaattaabbaassee "_n_a_m_e" [‐‐‐‐ttaabblleess _t_n_a_m_e_1 _t_n_a_m_e_2
25...]]
26 [‐‐‐‐rroouuttiinneess | ‐‐‐‐nnoo‐‐rroouuttiinneess]
27 [‐‐‐‐mmyyssqqll‐‐bbiinnppaatthh _M_y_S_Q_L___c_o_m_m_a_n_d___d_i_r]
28 [‐‐‐‐mmyyssqqll‐‐bbiinnlloogg‐‐ppaatthh _M_y_S_Q_L___b_i_n_a_r_y___l_o_g___d_i_r]
29MMyySSQQLL AAcccceessss SSyynnooppssiiss
31 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
32 [‐‐‐‐uusseerr _u_s_e_r]
33 [‐‐‐‐ppaasssswwoorrdd _p_a_s_s_w_o_r_d]
34 [‐‐‐‐hhoosstt _h_o_s_t_n_a_m_e]
35 [‐‐‐‐ppoorrtt _p_o_r_t_n_u_m_b_e_r]
36 [‐‐‐‐ssoocckkeett _n_a_m_e]
37 [‐‐‐‐ssssll‐‐ooppttiioonnss _"_M_y_S_Q_L _s_s_l _o_p_t_i_o_n_s_"]
38CCoommpprreessssiioonn aanndd EEnnccrryyppttiioonn SSyynnooppssiiss
40 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
41 [‐‐‐‐ccoommpprreessss | ‐‐‐‐nnoo‐‐ccoommpprreessss ]
42 [‐‐‐‐ccoommpprreessss‐‐mmyyssqqlldduummpp‐‐oonntthheeffllyy |
43‐‐‐‐nnoo‐‐ccoommpprreessss‐‐mmyyssqqll‐‐
44 dduummpp‐‐oonntthheeffllyy]
45 [‐‐‐‐ccoommpprreessss‐‐pplluuggiinn _p_l_u_g_i_n___n_a_m_e]
46 [‐‐‐‐nnoo‐‐eennccrryypptt | ‐‐‐‐eennccrryypptt]
47 [‐‐‐‐eennccrryypptt‐‐pplluuggiinn pplluuggiinn__nnaammee
48[‐‐‐‐ddeeccrryypptt‐‐ooppttiioonn
49 _o_p_t_i_o_n]]
50 [‐‐‐‐ppaassssffiillee _f_i_l_e_n_a_m_e]
51PPlluuggiinn SSyynnooppssiiss
53 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
54 [‐‐‐‐pprree‐‐bbaacckkuupp‐‐pplluuggiinn _p_l_u_g_i_n]
55 [‐‐‐‐pprree‐‐bbaacckkuupp‐‐pplluuggiinn‐‐ooppttiioonnss _"_o_p_t_i_o_n_1
56_o_p_t_i_o_n_2 _._._._"]
57 [‐‐‐‐ccooppyy‐‐pplluuggiinn _p_l_u_g_i_n]
58 [‐‐‐‐sssshh‐‐uusseerr _u_s_e_r]
59 [‐‐‐‐rreemmoottee‐‐mmyyssqqll‐‐bbiinnppaatthh _p_a_t_h]
60 [‐‐‐‐ssoocckkeett‐‐rreemmoottee‐‐ppoorrtt _p_o_r_t]
61 [‐‐‐‐ppoosstt‐‐bbaacckkuupp‐‐pplluuggiinn _p_l_u_g_i_n]
62 [‐‐‐‐ppoosstt‐‐bbaacckkuupp‐‐pplluuggiinn‐‐ooppttiioonnss _"_o_p_t_i_o_n_1
63_o_p_t_i_o_n_2 _._._._"]
64BBaacckkuupp MMeetthhoodd SSyynnooppssiiss
66 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
67 [‐‐‐‐bbaacckkuupp‐‐lleevveell _l_e_v_e_l]
68 [‐‐‐‐bbaacckkuupp‐‐mmooddee rraaww | llooggiiccaall]
69 [‐‐‐‐ssyynncchhrroonnoouuss‐‐cchheecckkssuumm | ‐‐‐‐nnoo‐‐ssyynncchhrroonnoouuss‐‐cchheecckkssuumm]
70 [‐‐‐‐rreepplliiccaattiioonn | ‐‐‐‐nnoorreepplliiccaattiioonn]
71 [‐‐‐‐rreetteennttiioonn‐‐ppoolliiccyy _b_a_c_k_u_p___r_e_t_e_n_t_i_o_n___t_i_m_e]
72 [‐‐‐‐ddeeffaauulltt‐‐cchhaarraacctteerr‐‐sseett _c_h_a_r___s_e_t___n_a_m_e]
73SSnnaappsshhoott PPlluuggiinn SSyynnooppssiiss
75 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
76 [‐‐‐‐ssnnaappsshhoott‐‐pplluuggiinn _n_a_m_e]
77 [‐‐‐‐cchheecckk‐‐iinnnnooddbb | ‐‐‐‐nnoo‐‐cchheecckk‐‐iinnnnooddbb]
78 [‐‐‐‐bbaacckkuupp‐‐ttyyppee rreegguullaarr|‐‐‐‐bbaacckkuupp‐‐ttyyppee qquuiicckk]]
79 ‐‐‐‐ssnnaappsshhoott‐‐pplluuggiinn llvvmm‐‐ssnnaappsshhoott [‐‐‐‐ssnnaappsshhoott‐‐ssiizzee
81_s_i_z_e]
82 ‐‐‐‐ssnnaappsshhoott‐‐pplluuggiinn zzffss
84 (no options necessary)
85 ‐‐‐‐llvvmm‐‐ssnnaappsshhoott _s_i_z_e;
87 (deprecated; use
88 ‐‐‐‐ssnnaappsshhoott‐‐pplluuggiinn llvvmm‐‐ssnnaappsshhoott
89 ‐‐‐‐ssnnaappsshhoott‐‐ssiizzee instead)
90BBaacckkuupp DDeessttiinnaattiioonn SSyynnooppssiiss
92 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
93 [‐‐‐‐bbaacckkuupp‐‐nnaammee _i_m_a_g_e___n_a_m_e]
94 [‐‐‐‐ddeessttiinnaattiioonn _d_i_r___p_a_t_h]
95 [‐‐‐‐ttmmppddiirr _t_e_m_p___d_i_r
96LLooggggiinngg aanndd NNoottiiffiiccaattiioonn SSyynnooppssiiss
98 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
99 [‐‐‐‐mmaaiillttoo _a_d_d_r_e_s_s]
100 [‐‐‐‐ccoommmmeenntt "_c_o_m_m_e_n_t _s_t_r_i_n_g"]
101 [‐‐‐‐qquuiieett|‐‐‐‐nnoo‐‐qquuiieett]
102 [‐‐‐‐vveerrbboossee]
103DDEESSCCRRIIPPTTIIOONN
105 ZRM for MySQL provides automated scheduling of live
106MySQL database
107 backup. You only need to configure it once to reflect the
108MySQL deploy‐
109 ment, then schedule it to run unattended backups. Vari‐
110ous options can
111 help an administrator:
112 * Verify the backups created.
114 * Generate various types of reports about the backups cre‐
116ated.
117 * Specify compression and encryption as desired.
119 * Report information about the backups via an email or RSS
121feed.
122 * Access pre‐ and post‐ backup plugins to extend the suite
124further.
125 * Control full and selective restore operations on the
127database, both
128 locally and remotely.
129 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp provides the core backup functions of
131ZRM for MySQL
132 databases.
133 Use the mmyyssqqll‐‐zzrrmm..ccoonnff(5) configuration file to set
135mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp
136 options described on this page. Use the ‐‐‐‐aaccttiioonn cchheecckk
137option to ver‐
138 ify the configuration of mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp.
139 Use mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp to create full or incremental back‐
141ups of MySQL
142 databases.
143 To display help on individual action options, append the
145‐‐help option
146 to the command line. For example: ’mysql‐zrm‐backup
147‐‐options‐file
148 ‐‐help’
149BBAACCKKUUPP SSEETTSS
151 ZRM for MySQL organizes backups into Backup Sets.
152Each backup set
153 defines the list of databases or tables within a data‐
154base, how it
155 should be backed up and the backup schedule for the da‐
156ta. Backup sets
157 are identified by a unique name.
158 Every backup run (each time mmyyssqqll‐‐zzrrmm is executed) is as‐
160sociated with
161 one backup set. Various parameters can be associated
162with each backup
163 run.
164 mmyyssqqll‐‐zzrrmm first reads the global configu‐
166ration file
167 (//eettcc//mmyyssqqll‐‐zzrrmm//mmyyssqqll‐‐zzrrmm..ccoonnff). The global configura‐
168tion file can be
169 overridden by backup set specific configuration file
170stored in
171 //eettcc//mmyyssqqll‐‐zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e directory. The mmyyssqqll‐‐zzrrmm
172command line
173 options will override the parameters specified in the
174configuration
175 files.
176BBAACCKKUUPP MMEETTHHOODDSS
183 mmyyssqqll‐‐zzrrmm backups can be either full or incremental.
184Full backups can
185 be logical backups or raw backups. Logical backups con‐
186tain SQL state‐
187 ments to recreate the database. Raw backups are actual
188copies of the
189 database files.
190 When logical backup is specified, the utility uses only
192mmyyssqqlldduummpp for
193 backing up specified databases and tables.
194 When raw backup is specified, the utility has the
196ability to decide
197 which backup mechanism to use for a particular database.
198If there are
199 no transactional storage engine based tables in the speci‐
200fied database,
201 then it uses mmyyssqqllhhoottccooppyy for backing up that database.
202Otherwise, it
203 uses mmyyssqqlldduummpp for backing up the specified database.
204 Snapshot backups are discussed in the Snapshot Options
206section of this
207 man page.
208 When rreepplliiccaattiioonn is specified and if the MySQL server is a
210replication
211 slave, then it will also backup all replication related
212files.
213 When ddeessttiinnaattiioonn specified then the backups are stored in
215a sub‐direc‐
216 tory under the specified directory. Default path is
217//vvaarr//lliibb//mmyyssqqll‐‐zzrrmm.
218 If the destination specified does not exist, it will
219return an error
220 and exit; the utility does not create the directory.
221 An index file is also created in the backup directory. The
223index is a
224 file that contains the details of what was backed up, how
225much data was
226 backed up, what parameters were used to backup the data,
227how much time
228 it took to backup etc.
229 When an incremental backup is specified, the follow‐
231ing options are
232 ignored:
233 bbaacckkuupp‐‐mmooddee,
235 ssnnaappsshhoott‐‐pplluuggiinn,
237 aallll‐‐ddaattaabbaasseess,
239 ddaattaabbaasseess,
241 ddaattaabbaassee
243 ttaabblleess
245OOPPTTIIOONNSS
248 You can select a backup set by name on the command
249line, or select
250 source database(s), backup methods, plugins, etc. by us‐
251ing the options
252 described in the Options subsections that follow. You can
253also specify
254 mysql‐zrm‐backup options in a configuration file speci‐
255fied using the
256 ‐‐‐‐ooppttiioonnss switch.
257 ‐‐‐‐bbaacckkuupp‐‐sseett _n_a_m_e
260 Specify backup‐set for the backup run. This is a
261Command line
262 option only and cannot be specified in the con‐
263figuration file.
264 The default value is _B_a_c_k_u_p_S_e_t_1. If such a value
265is already
266 present, it will be used.
267 ‐‐‐‐ooppttiioonnss‐‐ffiillee _c_o_n_f___f_i_l_e
269 Set the file along with full pathname
270that contains
271 mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp configuration options; this file
272has the same
273 format as mmyyssqqll‐‐zzrrmm..ccoonnff(5).
274 ‐‐‐‐hheellpp Displays the help message and exits. This com‐
276mand‐line‐only
277 parameter cannot be specified in the configuration
278file.
279BBaacckkuupp SSoouurrccee OOppttiioonnss
282 ‐‐‐‐aallll‐‐ddaattaabbaasseess
283 Opt for all databases to be backed up or restored.
284This is the
285 default if _d_a_t_a_b_a_s_e or _d_a_t_a_b_a_s_e_s are not specified.
286 ‐‐‐‐ddaattaabbaasseess _"_n_a_m_e_1 _n_a_m_e_2 _._._._"
288 List the databases to backup or restore.
289 ‐‐‐‐ddaattaabbaassee _n_a_m_e [‐‐‐‐ttaabblleess "_n_a_m_e_1 _n_a_m_e_2 _._._."]
291 List the tables that should be backed up. This
292option is valid
293 during the backup operation only.
294 ‐‐‐‐rroouuttiinneess|‐‐‐‐nnoo‐‐rroouuttiinneess
296 If ‐‐‐‐rroouuttiinneess is specified then mysqldump will dump
297stored rou‐
298 tines. The default is ‐‐‐‐nnoo‐‐rroouuttiinneess. This parameter
299is optional.
300 ‐‐‐‐mmyyssqqll‐‐bbiinnppaatthh _m_y_s_q_l___c_o_m_m_a_n_d___d_i_r
302 Set the full path where mysql binary commands
303are installed.
304 For example: //oopptt//llaammpppp//bbiinn.
305 ‐‐‐‐mmyyssqqll‐‐bbiinnlloogg‐‐ppaatthh _m_y_s_q_l___b_i_n_a_r_y___l_o_g___l_o_c_a_t_i_o_n
307 Set the full path of the location of mysql bi‐
308nary logs. For
309 example: //vvaarr//lloogg//mmyyssqqll
310MMyySSQQLL AAcccceessss OOppttiioonnss
314 ‐‐‐‐uusseerr _u_s_e_r
315 Specify MySQL backup/restore user
316 ‐‐‐‐ppaasssswwoorrdd _p_a_s_s_w_o_r_d
318 Specify password for the MySQL user
319 ‐‐‐‐hhoosstt _h_o_s_t_n_a_m_e
321 Specify MySQL server host name or IP name.
322 ‐‐‐‐ppoorrtt _p_o_r_t_n_u_m_b_e_r
324 Specify MySQL server port.
325 ‐‐‐‐ssoocckkeett _n_a_m_e
327 Specify socket file to use for communication with
328MySQL server.
329 ‐‐‐‐ssssll‐‐ooppttiioonnss "_M_y_S_Q_L _s_s_l _o_p_t_i_o_n_s"
331 Set any ‐‐‐‐ssssll** options that MySQL supports. Refer
332to MySQL Docu‐
333 mentation for SSL options details.
334BBaacckkuupp MMeetthhoodd OOppttiioonnss
337 ‐‐‐‐bbaacckkuupp‐‐lleevveell _l_e_v_e_l
338 Choose 0 for full backup. Choose 1 for incremen‐
339tal back up.
340 Default is full backup.
341 ‐‐‐‐bbaacckkuupp‐‐mmooddee rraaww|llooggiiccaall
343 Database/tables that use a transactional engine
344cannot be backed
345 up by mmyyssqqlldduummpp. They should be backed up by
346mmyyssqqllhhoottccooppyy.
347 Choose rraaww to use mmyyssqqllhhoottccooppyy to back up the
348database/tables
349 that use a transactional engine. Choose llooggiiccaall to
350use mmyyssqqll‐‐
351 dduummpp to back up the database/tables that don’t
352use a transac‐
353 tional engine. Default value is rraaww.
354 ‐‐‐‐ssyynncchhrroonnoouuss‐‐cchheecckkssuumm | ‐‐‐‐nnoo‐‐ssyynncchhrroonnoouuss‐‐cchheecckkssuumm
356 Specifies whether a checksum should be produced
357during the
358 backup process. Default is
359nnoo‐‐ssyynncchhrroonnoouuss‐‐cchheecckkssuumm, in which
360 case the checksum is produced only after the backup
361process is
362 complete. Specifying ‐‐‐‐ssyynncchhrroonnoouuss‐‐cchheecckkssuumm
363significantly
364 increases overall backup times.
365 ‐‐‐‐rreepplliiccaattiioonn | ‐‐‐‐nnoorreepplliiccaattiioonn
367 Choose replication to backup replication files.
368They will be
369 backed up only if the host is a replication
370slave. Default
371 option is ‐‐‐‐nnoorreepplliiccaattiioonn.
372 ‐‐‐‐ddeeffaauulltt‐‐cchhaarraacctteerr‐‐sseett _c_h_a_r___s_e_t___n_a_m_e
374 The default character set that mysqldump should
375use. If not
376 specified utf8 is used. This parameter is optional.
377PPlluuggiinn OOppttiioonnss
380 ‐‐‐‐pprree‐‐bbaacckkuupp‐‐pplluuggiinn _p_l_u_g_i_n
381 (Optional) Specify the plugin along with full
382pathname to be
383 called before a backup run. All pre‐backup plugin
384scripts must
385 accept the following command‐line parameters
386(which are passed
387 to the plugin using ‐‐‐‐pprree‐‐bbaacckkuupp‐‐pplluuggiinn‐‐ooppttiioonnss:
388 ‐‐‐‐aallll‐‐ddaattaabbaasseess
390 Use when all databases on the server are being
391backed up.
392 ‐‐‐‐ddaattaabbaassee _d_a_t_a_b_a_s_e_1 _d_a_t_a_b_a_s_e_2......
394 Use when selected databases are being backed
395up.
396 ‐‐‐‐ddaattaabbaassee ddaattaabbaassee ‐‐‐‐ttaabblleess ttaabbllee11 ttaabbllee22......
398 Use if selected tables are being backed up.
399 The script should be written to return a non‐
401zero value on
402 error; pre‐backup plugin failures should cancel
403the backup and
404 generate a failure message for reports and logs.
405 ‐‐‐‐pprree‐‐bbaacckkuupp‐‐pplluuggiinn‐‐ooppttiioonnss ""_o_p_t_i_o_n_1 _o_p_t_i_o_n_2...""
407 Pass options to the pprree‐‐bbaacckkuupp‐‐pplluuggiinn as one of the
408command line
409 arguments.
410 ‐‐‐‐ccooppyy‐‐pplluuggiinn _p_l_u_g_i_n
412 Specify plugin along with full pathname to be used
413for transfer‐
414 ring backup files to and from a remote MySQL
415server to the
416 machine running ZRM for MySQL. Use this option
417when
418 1. remote incremental backup is required
419 2. copying replication related files from a re‐
420mote machine
421 3. execute mmyyssqqllhhoottccooppyy (MySQL command) and
422copy the data
423 from the remote machine
424 4. restore data to a remote machine using
425mmyyssqqllhhoottccooppyy(MySQL
426 command). This parameter is optional.
427 ‐‐‐‐sssshh‐‐uusseerr _u_s_e_r
429 Specifies the user to be used for SSH. This pa‐
430rameter is only
431 used by the ssh‐copy.pl plugin. The user specified
432should either
433 be the user mmyyssqqlldd runs as or root. If not speci‐
434fied the default
435 value used is mmyyssqqll. This parameter is
436optional.
437 ‐‐‐‐rreemmoottee‐‐mmyyssqqll‐‐bbiinnppaatthh _p_a_t_h Full path where mysql
438binaries are
439 installed on the remote machine. For example:
440//oopptt//llaammpppp//bbiinn.
441 This parameter is only used by the sock‐
442et‐copy.pl and
443 ssh‐copy.pl plugins. If not specified, the default
444value used is
445 //uussrr//bbiinn.
446 ‐‐‐‐ssoocckkeett‐‐rreemmoottee‐‐ppoorrtt _p_o_r_t
448 Port that the socket‐plugin.pl should use to
449connect. This
450 parameter is only used by the socket‐copy.pl
451plugin. If not
452 specified the default value used is 25300. This
453parameter is
454 optional
455 ‐‐‐‐ppoosstt‐‐bbaacckkuupp‐‐pplluuggiinn _p_l_u_g_i_n
457 Set the plugin along with full pathname to be
458called after a
459 backup run. If synchronous‐checksum is not set or
460its value is
461 set to zero, the post backup plugin is called
462twice, once at the
463 end of backup and once when the checksum is fin‐
464ished.
465 ‐‐‐‐ppoosstt‐‐bbaacckkuupp‐‐pplluuggiinn‐‐ooppttiioonnss ""_O_p_t_i_o_n_1 _O_p_t_i_o_n_2 _O_p_t_i_o_n_3
468_O_p_t_i_o_n_4...""
469 _o_p_t_i_o_n_1 is the value of
470ppoosstt‐‐bbaacckkuupp‐‐pplluuggiinn‐‐ooppttiioonnss from the
471 mmyyssqqll‐‐zzrrmm..ccoonnff(5) file. _o_p_t_i_o_n_2 is the data being
472backed up. It
473 will be either
474 ‐‐‐‐aallll‐‐ddaattaabbaasseess
476 Use when all databases on the server are being
477backed up.
478 ‐‐‐‐ddaattaabbaassee _d_a_t_a_b_a_s_e_1 _d_a_t_a_b_a_s_e_2......
480 Use when selected databases are being backed
481up.
482 ‐‐‐‐ddaattaabbaassee ddaattaabbaassee ‐‐‐‐ttaabblleess ttaabbllee11 ttaabbllee22......
484 Use if selected tables are being backed up.
485 _O_p_t_i_o_n_3 will be ‐‐‐‐bbaacckkuupp‐‐ddiirreeccttoorryy _p_a_t_h
487 _O_p_t_i_o_n_4 will be ‐‐‐‐cchheecckkssuumm‐‐ppeennddiinngg or it will be
489‐‐‐‐cchheecckkssuumm‐‐ffiinn‐‐
490 iisshheedd if synchronous‐checksum is set to 1.
491 If synchronous‐checksum is not set or its value is
493set to zero,
494 the post‐backup‐plugin is called again and it will
495have 3 param‐
496 eters First parameter is the value of
497ppoosstt‐‐bbaacckkuupp‐‐pplluuggiinn‐‐ooppttiioonnss
498 from the mmyyssqqll‐‐zzrrmm..ccoonnff(5) configuration file.
499Second parameter
500 will be ‐‐‐‐bbaacckkuupp‐‐ddiirreeccttoorryy _p_a_t_h. Third parame‐
501ter will be
502 ‐‐‐‐cchheecckkssuumm‐‐ffiinniisshheedd.
503CCoommpprreessssiioonn aanndd EEnnccrryyppttiioonn OOppttiioonnss
505 ‐‐‐‐ccoommpprreessss | ‐‐‐‐nnoo‐‐ccoommpprreessss
506 Choose whether the files should be compressed us‐
507ing the utility
508 specified by the ‐‐‐‐ccoommpprreessss‐‐pplluuggiinn. The default
509is ‐‐‐‐nnoo‐‐ccoomm‐‐
510 pprreessss.
511 ‐‐‐‐ccoommpprreessss‐‐mmyyssqqlldduummpp‐‐oonntthheeffllyy |
513‐‐‐‐nnoo‐‐ccoommpprreessss‐‐mmyyssqqlldduummpp‐‐oonntthheeffllyy
514 Choose whether to compress the data dumped by
515mmyyssqqlldduummpp on the
516 fly. Default compression command used is ggzziipp.
517Default is no
518 compression on the fly.
519 ‐‐‐‐ccoommpprreessss‐‐pplluuggiinn _p_l_u_g_i_n___n_a_m_e
521 Use _p_l_u_g_i_n___n_a_m_e to specify a path to the utility to
522use for com‐
523 pression. The default is ggzziipp.
524 ‐‐‐‐nnoo‐‐eennccrryypptt | ‐‐‐‐eennccrryypptt
526 Choose whether the files should be encrypted using
527the utility
528 specified by the ‐‐‐‐eennccrryypptt‐‐pplluuggiinn. The default is
529‐‐‐‐nnoo‐‐eennccrryypptt.
530 ‐‐‐‐eennccrryypptt‐‐pplluuggiinn pplluuggiinn__nnaammee [‐‐‐‐ddeeccrryypptt‐‐ooppttiioonn [_o_p_t_i_o_n]
532 Use pplluuggiinn__nnaammee to specify a utility to use for
533compression
534 along with its full path. If ddeeccrryypptt‐‐ooppttiioonn is
535not specified
536 then the ‐‐dd option of encrypt‐plugin is used for
537decrypting.
538 ‐‐‐‐ppaassssffiillee _f_i_l_e_n_a_m_e
540SSnnaappsshhoott PPlluuggiinn OOppttiioonnss
542 ‐‐‐‐ssnnaappsshhoott‐‐pplluuggiinn _p_l_u_g_i_n
543 Specifies the plugin to be used for snapshot op‐
544erations. The
545 default is the lvm‐snapshot plugin.
546 [‐‐‐‐cchheecckk‐‐iinnnnooddbb | ‐‐‐‐nnoo‐‐cchheecckk‐‐iinnnnooddbb]
548 Specifies whether to check for iinnnnooddbb shared data
549and log files
550 to back up during every snapshot‐based based
551backup. If
552 ‐‐‐‐cchheecckk‐‐iinnnnooddbb is specified, iinnnnooddbb shared data
553and logs are
554 only backed up if the databases being backed up use
555iinnnnooddbb. If
556 ‐‐‐‐nnoo‐‐cchheecckk‐‐iinnnnooddbb is specified (the default),
557the iinnnnooddbb
558 databases and logs are backed up regardless of
559whether they are
560 relevant. The default value is
561‐‐‐‐nnoo‐‐cchheecckk‐‐iinnnnooddbb, which means
562 iinnnnooddbb shared data and logs are always copied if
563the iinnnnooddbb
564 engine is enabled in MySQL. In most cases,
565‐‐‐‐nnoo‐‐cchheecckk‐‐iinnnnooddbb
566 provides the best performance.
567 ‐‐‐‐ssnnaappsshhoott‐‐ssiizzee _s_i_z_e
569 Set the size of the llvvmm‐‐ssnnaappsshhoott to be generated.
570For rraaww back‐
571 ups, each specified database is first checked en‐
572sure that it is
573 on a LVM volume, and then a snapshot of the speci‐
574fied size is
575 created and used to backup the database. If
576the specified
577 database is not on a LVM volume, either
578mmyyssqqllhhoottccooppyy or mmyyssqqll‐‐
579 dduummpp will be used to create the backup based on the
580logic speci‐
581 fied by the ‐‐‐‐bbaacckkuupp‐‐mmooddee option. This option is
582ignored if the
583 ‐‐‐‐bbaacckkuupp‐‐mmooddee is llooggiiccaall.
584 ‐‐‐‐bbaacckkuupp‐‐ttyyppee rreegguullaarr|‐‐‐‐bbaacckkuupp‐‐ttyyppee qquuiicckk
586 Choose the method of snapshot backup. The rreegguullaarr
587option speci‐
588 fies that the snapshot should be copied into a
589standard ZRM for
590 MySQL backup archive. The qquuiicckk option specifies
591that the snap‐
592 shot itself should be used as a near‐line backup.
593Quick backups
594 are convenient as they provide near‐instantaneous
595restores, but
596 because they remain on the MySQL server they do
597not protect
598 against media or server failure. Note that if
599the ’’’quick’’’
600 option is specified, the ’’’compress’’’ and
601’’’encrypt’’’
602 options are ignored, and the backup size will al‐
603ways be zero. In
604 addition, no checksums are performed, which means
605that quick
606 snapshot backups cannot be verified.
607BBaacckkuupp DDeessttiinnaattiioonn OOppttiioonnss
609 ‐‐‐‐bbaacckkuupp‐‐nnaammee _i_m_a_g_e___n_a_m_e
610 Specify a unique name to store the backup. If
611a name is not
612 specified or it already exists in the ‐‐‐‐ddeessttiinnaattiioonn
613_d_i_r_p_a_t_h (see
614 the next option), the backup image will be named
615with the cur‐
616 rent date and time.
617 ‐‐‐‐ddeessttiinnaattiioonn _d_i_r___p_a_t_h
619 Specify the directory where backup should be
620stored. Default
621 location is //vvaarr//lliibb//mmyyssqqll‐‐zzrrmm//. If this option
622is specified,
623 the directory must be exist and should be writable
624by the ZRM
625 for MySQL user, otherwise the utility exits with an
626error.
627LLooggggiinngg aanndd NNoottiiffiiccaattiioonn OOppttiioonnss
629 ‐‐‐‐mmaaiillttoo _a_d_d_r_e_s_s
630 Set the address to which a backup report will be
631sent.
632 ‐‐‐‐ccoommmmeenntt "_C_o_m_m_e_n_t _s_t_r_i_n_g"
634 Insert a comment or a note about the backup run.
635This can be
636 used to tag backup runs and the note can re‐
637trieved using the
638 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr(1) utility.
639 ‐‐‐‐qquuiieett | ‐‐‐‐nnoo‐‐qquuiieett
641 Choose quiet to suppress display of log mes‐
642sages on stdout.
643 Choose _n_o_‐_q_u_i_e_t to display the log messages stdout.
644Default is
645 ‐‐‐‐nnoo‐‐qquuiieett.
646 ‐‐‐‐vveerrbboossee
648 Provide verbose output in the log. Default is
649that verbose is
650 turned off and a terse output is generated.
651 FFIILLEESS
654 //vvaarr//lliibb//mmyyssqqll‐‐zzrrmm
656 Default directory for storing all backup data.
657 //eettcc//mmyyssqqll‐‐zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e//mmyyssqqll‐‐zzrrmm..ccoonnff
660 Default location for the backup‐set configuration
661file used by
662 the mmyyssqqll‐‐zzrrmm‐‐bbaacckkuupp utility.
663RREETTUURRNN VVAALLUUEESS
666 On success, zero is returned. On error, non‐zero value is
667returned.
668SSEEEE AALLSSOO
671 mysql‐zrm(1), mysql‐zrm‐manage‐backup(1), mysql‐
672zrm‐restore(1),
673 mysql‐zrm‐check(1), mysql‐zrm‐list(1), mysql‐
674zrm‐getconf(1),
675 mysql‐zrm‐setconf(1), mysql‐zrm‐parse‐binlogs(1), mysql‐
676zrm‐purge(1),
677 mysql‐zrm‐extract‐backup(1), mysql‐zrm‐ver‐
678ify‐backup(1),
679 mysql‐zrm‐abort‐backup(1), mysql‐zrm‐
680scheduler(1),
681 mysql‐zrm‐reporter(1), mysql‐zrm.conf(5), mysqldump(1),
682mysqlbinlog(1),
683 mysql(1), lvm(8), Zmanda Recovery Manager for MySQL
684(http://mysql‐
685 backup.zmanda.com/)
686AAUUTTHHOORR
689 Zmanda Inc. (http://www.zmanda.com)
690Zmanda, Inc. ZRM for MySQL 2.1 mysql‐
694zrm‐backup(1)
695