mysql: No longer prepend vroot to the backupdir.
[matthijs/upstream/backupninja.git] / examples / example.mysql
index d22cbcbd392f7ed9843bda3dcd037efe4ff3e23d..00298451b003961e01809ef351b25652c7fe044a 100644 (file)
@@ -53,31 +53,49 @@ compress    = yes
 # which databases to backup. should either be the word 'all' or a 
 # space separated list of database names.
 #
-# nodata = < table1 table2 table3 > (no default)
+# nodata = < db.table1 db.table2 db.table3 > (no default)
 # only dump the structure for the database tables listed here, this means
 # no data contained in these tables will be dumped. This is very useful
 # to backup databases that have tables with large amounts of cache data that
 # isn't necessary to backup, but you still need the structure to exist
-# on a restore
+# on a restore. You *must* specify the table as part of a database, such
+# as "drupal.cache", where the database name is "drupal" and the table that
+# you do not want to dump the data for is called "cache". 
 #
 # backupdir = < path/to/destination > (default = /var/backups/mysql)
 # where to dump the backups. hotcopy backups will be in a subdirectory 
 # 'hotcopy' and sqldump backups will be in a subdirectory 'sqldump'
+# This variable is interpolated, see backup.d (5) for which variables are
+# available.
 #
 # hotcopy = < yes | no > (default = no)
 # make a backup of the actual database binary files using mysqlhotcopy.
+# When using hotcopy, backupdir must be a dir inside each vserver! You can use
+# the interpolation feature to do this for multiple vservers by starting
+# backupdir with %v (not /%v), which will be replaced by the current
+# vserver root.
 #
 # sqldump = < yes | no > (default = no)
 # make a backup using mysqldump. this creates text files with sql commands
 # sufficient to recontruct the database.
 #
+# sqldumpoptions = <options>
+# (default = --lock-tables --complete-insert --add-drop-table --quick --quote-names)
+# arguments to pass to mysqldump
+#
 # compress = < yes | no > (default = yes)
 # if yes, compress the sqldump output. 
 #
-# vsname = <vserver> (no default)
-# what vserver to operate on (only used if vserver = yes 
-# in /etc/backupninja.conf), if you do not specify a vsname the 
-# host will be operated on
+# vsnames = all | <vserver1> <vserver2> (no default)
+# what vservers to operate on (only used if vserver = yes 
+# in /etc/backupninja.conf), if you do not specify vsnames the 
+# host will be operated on.
+# 
+# Note that backupninja 0.9.6 and before used "vsname" to run in a single
+# vserver. It also automatically prepended the vserver root directory to
+# backupdir. Newer versions still do this if you're using the deprecated (but
+# still supported) "vsname" variable. To achieve the same effect while using
+# the vsnames variable, prepend backupdir with %v
 # 
 # NB: databases = all doesn't seem to work with hotcopy = yes 
 # when vsname is specified, I would like to know how to fix this.