1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CedarBackup2.extend.mysql</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup2-module.html">Package CedarBackup2</a> ::
<a href="CedarBackup2.extend-module.html">Package extend</a> ::
Module mysql
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup2.extend.mysql-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module mysql</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html">source code</a></span></p>
<p>Provides an extension to back up MySQL databases.</p>
<p>This is a Cedar Backup extension used to back up MySQL databases via
the Cedar Backup command line. It requires a new configuration section
<mysql> and is intended to be run either immediately before or
immediately after the standard collect action. Aside from its own
configuration, it requires the options and collect configuration sections
in the standard Cedar Backup configuration file.</p>
<p>The backup is done via the <code>mysqldump</code> command included
with the MySQL product. Output can be compressed using <code>gzip</code>
or <code>bzip2</code>. Administrators can configure the extension either
to back up all databases or to back up only specific databases. Note
that this code always produces a full backup. There is currently no
facility for making incremental backups. If/when someone has a need for
this and can describe how to do it, I'll update this extension or provide
another.</p>
<p>The extension assumes that all configured databases can be backed up
by a single user. Often, the "root" database user will be
used. An alternative is to create a separate MySQL "backup"
user and grant that user rights to read (but not write) various databases
as needed. This second option is probably the best choice.</p>
<p>The extension accepts a username and password in configuration.
However, you probably do not want to provide those values in Cedar Backup
configuration. This is because Cedar Backup will provide these values to
<code>mysqldump</code> via the command-line <code>--user</code> and
<code>--password</code> switches, which will be visible to other users in
the process listing.</p>
<p>Instead, you should configure the username and password in one of
MySQL's configuration files. Typically, that would be done by putting a
stanza like this in <code>/root/.my.cnf</code>:</p>
<pre class="literalblock">
[mysqldump]
user = root
password = <secret>
</pre>
<p>Regardless of whether you are using <code>~/.my.cnf</code> or
<code>/etc/cback.conf</code> to store database login and password
information, you should be careful about who is allowed to view that
information. Typically, this means locking down permissions so that only
the file owner can read the file contents (i.e. use mode
<code>0600</code>).</p>
<hr />
<div class="fields"> <p><strong>Author:</strong>
Kenneth J. Pronovici <pronovic@ieee.org>
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.mysql.MysqlConfig-class.html" class="summary-name">MysqlConfig</a><br />
Class representing MySQL configuration.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.mysql.LocalConfig-class.html" class="summary-name">LocalConfig</a><br />
Class representing this extension's configuration document.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mysql-module.html#executeAction" class="summary-sig-name">executeAction</a>(<span class="summary-sig-arg">configPath</span>,
<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">config</span>)</span><br />
Executes the MySQL backup action.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#executeAction">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mysql-module.html#_backupDatabase" class="summary-sig-name" onclick="show_private();">_backupDatabase</a>(<span class="summary-sig-arg">targetDir</span>,
<span class="summary-sig-arg">compressMode</span>,
<span class="summary-sig-arg">user</span>,
<span class="summary-sig-arg">password</span>,
<span class="summary-sig-arg">backupUser</span>,
<span class="summary-sig-arg">backupGroup</span>,
<span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>)</span><br />
Backs up an individual MySQL database, or all databases.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#_backupDatabase">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mysql-module.html#_getOutputFile" class="summary-sig-name" onclick="show_private();">_getOutputFile</a>(<span class="summary-sig-arg">targetDir</span>,
<span class="summary-sig-arg">database</span>,
<span class="summary-sig-arg">compressMode</span>)</span><br />
Opens the output file used for saving the MySQL dump.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#_getOutputFile">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mysql-module.html#backupDatabase" class="summary-sig-name">backupDatabase</a>(<span class="summary-sig-arg">user</span>,
<span class="summary-sig-arg">password</span>,
<span class="summary-sig-arg">backupFile</span>,
<span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>)</span><br />
Backs up an individual MySQL database, or all databases.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#backupDatabase">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger("CedarBackup2.log.extend.mysql")">logging.getLogger("CedarBackup2.log.extend.mysql")</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="MYSQLDUMP_COMMAND"></a><span class="summary-name">MYSQLDUMP_COMMAND</span> = <code title="['mysqldump']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">mysqldump</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="executeAction"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">executeAction</span>(<span class="sig-arg">configPath</span>,
<span class="sig-arg">options</span>,
<span class="sig-arg">config</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#executeAction">source code</a></span>
</td>
</tr></table>
<p>Executes the MySQL backup action.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>configPath</code></strong> (String representing a path on disk.) - Path to configuration file on disk.</li>
<li><strong class="pname"><code>options</code></strong> (Options object.) - Program command-line options.</li>
<li><strong class="pname"><code>config</code></strong> (Config object.) - Program configuration.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - Under many generic error conditions</li>
<li><code><strong class='fraise'>IOError</strong></code> - If a backup could not be written for some reason.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_backupDatabase"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_backupDatabase</span>(<span class="sig-arg">targetDir</span>,
<span class="sig-arg">compressMode</span>,
<span class="sig-arg">user</span>,
<span class="sig-arg">password</span>,
<span class="sig-arg">backupUser</span>,
<span class="sig-arg">backupGroup</span>,
<span class="sig-arg">database</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#_backupDatabase">source code</a></span>
</td>
</tr></table>
<p>Backs up an individual MySQL database, or all databases.</p>
<p>This internal method wraps the public method and adds some
functionality, like figuring out a filename, etc.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>targetDir</code></strong> - Directory into which backups should be written.</li>
<li><strong class="pname"><code>compressMode</code></strong> - Compress mode to be used for backed-up files.</li>
<li><strong class="pname"><code>user</code></strong> - User to use for connecting to the database (if any).</li>
<li><strong class="pname"><code>password</code></strong> - Password associated with user (if any).</li>
<li><strong class="pname"><code>backupUser</code></strong> - User to own resulting file.</li>
<li><strong class="pname"><code>backupGroup</code></strong> - Group to own resulting file.</li>
<li><strong class="pname"><code>database</code></strong> - Name of database, or <code>None</code> for all databases.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Name of the generated backup file.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If some value is missing or invalid.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is a problem executing the MySQL dump.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_getOutputFile"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getOutputFile</span>(<span class="sig-arg">targetDir</span>,
<span class="sig-arg">database</span>,
<span class="sig-arg">compressMode</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#_getOutputFile">source code</a></span>
</td>
</tr></table>
<p>Opens the output file used for saving the MySQL dump.</p>
<p>The filename is either <code>"mysqldump.txt"</code> or
<code>"mysqldump-<database>.txt"</code>. The
<code>".bz2"</code> extension is added if <code>compress</code>
is <code>True</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>targetDir</code></strong> - Target directory to write file in.</li>
<li><strong class="pname"><code>database</code></strong> - Name of the database (if any)</li>
<li><strong class="pname"><code>compressMode</code></strong> - Compress mode to be used for backed-up files.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Tuple of (Output file object, filename)</dd>
</dl>
</td></tr></table>
</div>
<a name="backupDatabase"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">backupDatabase</span>(<span class="sig-arg">user</span>,
<span class="sig-arg">password</span>,
<span class="sig-arg">backupFile</span>,
<span class="sig-arg">database</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mysql-pysrc.html#backupDatabase">source code</a></span>
</td>
</tr></table>
<p>Backs up an individual MySQL database, or all databases.</p>
<p>This function backs up either a named local MySQL database or all
local MySQL databases, using the passed-in user and password (if
provided) for connectivity. This function call <i>always</i> results a
full backup. There is no facility for incremental backups.</p>
<p>The backup data will be written into the passed-in backup file.
Normally, this would be an object as returned from <code>open()</code>,
but it is possible to use something like a <code>GzipFile</code> to write
compressed output. The caller is responsible for closing the passed-in
backup file.</p>
<p>Often, the "root" database user will be used when backing up
all databases. An alternative is to create a separate MySQL
"backup" user and grant that user rights to read (but not
write) all of the databases that will be backed up.</p>
<p>This function accepts a username and password. However, you probably
do not want to pass those values in. This is because they will be
provided to <code>mysqldump</code> via the command-line
<code>--user</code> and <code>--password</code> switches, which will be
visible to other users in the process listing.</p>
<p>Instead, you should configure the username and password in one of
MySQL's configuration files. Typically, this would be done by putting a
stanza like this in <code>/root/.my.cnf</code>, to provide
<code>mysqldump</code> with the root database username and its
password:</p>
<pre class="literalblock">
[mysqldump]
user = root
password = <secret>
</pre>
<p>If you are executing this function as some system user other than
root, then the <code>.my.cnf</code> file would be placed in the home
directory of that user. In either case, make sure to set restrictive
permissions (typically, mode <code>0600</code>) on <code>.my.cnf</code>
to make sure that other users cannot read the file.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>user</code></strong> (String representing MySQL username, or <code>None</code>) - User to use for connecting to the database (if any)</li>
<li><strong class="pname"><code>password</code></strong> (String representing MySQL password, or <code>None</code>) - Password associated with user (if any)</li>
<li><strong class="pname"><code>backupFile</code></strong> (Python file object as from <code>open()</code> or
<code>file()</code>.) - File use for writing backup.</li>
<li><strong class="pname"><code>database</code></strong> (String representing database name, or <code>None</code> for all
databases.) - Name of the database to be backed up.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If some value is missing or invalid.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is a problem executing the MySQL dump.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Tue Oct 19 20:56:41 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
