You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by aa...@apache.org on 2008/04/18 15:06:42 UTC
svn commit: r649516 - in /cayenne/sandbox/dbpatch: docs/cover.html
docs/dbpatch.html docs/index.html docs/toc.html version.properties
Author: aadamchik
Date: Fri Apr 18 06:06:41 2008
New Revision: 649516
URL: http://svn.apache.org/viewvc?rev=649516&view=rev
Log:
raw docs
Added:
cayenne/sandbox/dbpatch/docs/dbpatch.html (with props)
Modified:
cayenne/sandbox/dbpatch/docs/cover.html
cayenne/sandbox/dbpatch/docs/index.html
cayenne/sandbox/dbpatch/docs/toc.html
cayenne/sandbox/dbpatch/version.properties
Modified: cayenne/sandbox/dbpatch/docs/cover.html
URL: http://svn.apache.org/viewvc/cayenne/sandbox/dbpatch/docs/cover.html?rev=649516&r1=649515&r2=649516&view=diff
==============================================================================
--- cayenne/sandbox/dbpatch/docs/cover.html (original)
+++ cayenne/sandbox/dbpatch/docs/cover.html Fri Apr 18 06:06:41 2008
@@ -3,15 +3,10 @@
<head>
<meta content="en-us" http-equiv="Content-Language" />
<link href="style.css" rel="stylesheet" type="text/css" />
- <title>dbpatch</title>
+ <title>DBPatch</title>
</head>
<body>
- <h2>dbpatch</h2>
- <p>TODO: something about this antlib</p>
- <h3>What's this?</h3>
- <h3>Building</h3>
- <p>dependencies on Ant , external libs and tools <i>version?</i>
- </p>
- <h3>Using</h3>
+ <h2>DBPatch</h2>
+ <p>DBPatch library is intended to maintain versioning of a database schema and data during iterative development.</p>
</body>
</html>
Added: cayenne/sandbox/dbpatch/docs/dbpatch.html
URL: http://svn.apache.org/viewvc/cayenne/sandbox/dbpatch/docs/dbpatch.html?rev=649516&view=auto
==============================================================================
--- cayenne/sandbox/dbpatch/docs/dbpatch.html (added)
+++ cayenne/sandbox/dbpatch/docs/dbpatch.html Fri Apr 18 06:06:41 2008
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html>
+ <head>
+ <meta content="en-us" http-equiv="Content-Language" />
+ <link href="style.css" rel="stylesheet" type="text/css" />
+ <title>DBPathc</title>
+ </head>
+ <body>
+ <h2>DBPatch</h2>
+ <p>TODO: something about this antlib</p>
+ <pre>
+ An Ant task that supports maintaining evolving database schema via incremental
+SQL "patches". A "DB Patch" is a text file that contains native SQL code for
+the target database. Patches are indexed in a special "patch index" file that defines
+the order of patches. Patch names can be arbitrary. An extra arbitrary "patchReleaseId"
+attribute is defined to provide a simple namespace for patches. Otherwise the task is
+configured similar to the standard Ant "SQL" task:
+
+ http://ant.apache.org/manual/CoreTasks/sql.html
+
+The following taskdef is needed:
+
+ <taskdef name="dbpatch" classname="org.apache.cayenne.tools.DBPatchTask"/>
+
+
+An example of dbpatch task invocation:
+
+ <dbpatch
+ patchIndex="patches/index.txt"
+ patchReleaseId="${version}"
+ driver="com.mysql.jdbc.Driver"
+ url="${db.url}"
+ 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 ...
+
+
+ </pre>
+ </body>
+</html>
Propchange: cayenne/sandbox/dbpatch/docs/dbpatch.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: cayenne/sandbox/dbpatch/docs/index.html
URL: http://svn.apache.org/viewvc/cayenne/sandbox/dbpatch/docs/index.html?rev=649516&r1=649515&r2=649516&view=diff
==============================================================================
--- cayenne/sandbox/dbpatch/docs/index.html (original)
+++ cayenne/sandbox/dbpatch/docs/index.html Fri Apr 18 06:06:41 2008
@@ -3,7 +3,7 @@
<head>
<meta content="en-us" http-equiv="Content-Language" />
<link href="style.css" rel="stylesheet" type="text/css" />
- <title>User Manual - dbpatch</title>
+ <title>User Manual - DBPatch</title>
</head>
<frameset cols="26%,74%">
<frame name="navFrame" src="toc.html" />
@@ -11,6 +11,6 @@
</frameset>
<noframes>
<H2>User Manual - dbpatch</H2>
- <a href="toc.html">User Manual - dbpatch</a>
+ <a href="toc.html">User Manual - DBPatch</a>
</noframes>
</html>
Modified: cayenne/sandbox/dbpatch/docs/toc.html
URL: http://svn.apache.org/viewvc/cayenne/sandbox/dbpatch/docs/toc.html?rev=649516&r1=649515&r2=649516&view=diff
==============================================================================
--- cayenne/sandbox/dbpatch/docs/toc.html (original)
+++ cayenne/sandbox/dbpatch/docs/toc.html Fri Apr 18 06:06:41 2008
@@ -10,7 +10,7 @@
<a href="cover.html">Overview</a>
<br />
<h2>Tasks</h2>
- <a href="task.html">task</a>
+ <a href="dbpatch.html">DBPatch</a>
<br />
</body>
</html>
Modified: cayenne/sandbox/dbpatch/version.properties
URL: http://svn.apache.org/viewvc/cayenne/sandbox/dbpatch/version.properties?rev=649516&r1=649515&r2=649516&view=diff
==============================================================================
--- cayenne/sandbox/dbpatch/version.properties (original)
+++ cayenne/sandbox/dbpatch/version.properties Fri Apr 18 06:06:41 2008
@@ -1 +1 @@
-#artifact.version=1.0alpha
\ No newline at end of file
+artifact.version=0.7
\ No newline at end of file