svn commit: r635340 - /cayenne/sandbox/DBPatch/doc/README.txt

[aa...@apache.org]

Author: aadamchik
Date: Sun Mar  9 12:58:21 2008
New Revision: 635340

URL: http://svn.apache.org/viewvc?rev=635340&view=rev
Log:
dbpatch docs

Modified:
    cayenne/sandbox/DBPatch/doc/README.txt

Modified: cayenne/sandbox/DBPatch/doc/README.txt
URL: http://svn.apache.org/viewvc/cayenne/sandbox/DBPatch/doc/README.txt?rev=635340&r1=635339&r2=635340&view=diff
==============================================================================
--- cayenne/sandbox/DBPatch/doc/README.txt (original)
+++ cayenne/sandbox/DBPatch/doc/README.txt Sun Mar  9 12:58:21 2008
@@ -22,3 +22,26 @@
 		userid="${db.userid}"
 		password="${db.password}"/>
 
+DB patch task does all its initial setup tasks on its own. Namely, on first run it creates 
+a table called "patch_tracking" (or a table with a different name if a user sets a 'patch_tracking' 
+attribute). This table stores the names of patches that have been applied to the target DB, so
+that subsequent runs could skip them.
+
+Supported attributes:
+
+patchIndex:
+    (Required)
+    A text file that contains the names of the patches to run in the order they should be executed, 
+    one file per line. Empty lines and lines starting with # or // are skipped. The rest are treated
+    as file names in the directory relative to the patch index file directory.
+patchTableName: 
+    (Optional, default value is 'patch_tracking') 
+    An attribute that defines the name of the table where patch tracking information is stored. 
+    Can contain schema name. E.g. "myschema.mypatchtable".
+patchReleaseId: 
+	(Optional, default is null)
+	Defines a namespace for patch file names. All patch files must have unique names for a given patch 
+	release id.
+
+... SQL task attributes ...
+    
\ No newline at end of file