clarify how the nodata option should be specified in the config file for mysql

[matthijs/upstream/backupninja.git] / examples / example.mysql

diff --git a/examples/example.mysql b/examples/example.mysql
index 25750ad725d06c589dfa42e1b1b3a983307f1db3..bd996e7ccaafe96197c065c64b96dd6b06d7c2ad 100644 (file)
--- a/examples/example.mysql
+++ b/examples/example.mysql
@@ -53,6 +53,15 @@ compress    = yes
 # which databases to backup. should either be the word 'all' or a 
 # space separated list of database names.
 #
 # which databases to backup. should either be the word 'all' or a 
 # space separated list of database names.
 #

+# 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. 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'
 # 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'