Author: fh
Date: Mon Jul 23 12:50:10 2007
New Revision: 5726
Log:
- improvements to design 1.3
Modified:
trunk/DatabaseSchema/design/design-1.3.txt
Modified: trunk/DatabaseSchema/design/design-1.3.txt
==============================================================================
--- trunk/DatabaseSchema/design/design-1.3.txt [iso-8859-1] (original)
+++ trunk/DatabaseSchema/design/design-1.3.txt [iso-8859-1] Mon Jul 23 12:50:10
2007
@@ -10,16 +10,22 @@
Introduction
============
-Version 1.4 of DatabaseSchema will include a script that supports writing and
-saving schemas to file or database. The corresponding issue in the issue
-tracker to this design document is #010534.
+Version 1.3 of DatabaseSchema will include scripts that support:
+ - outputing a database schema
+ - writing a database schema to a database
+ - outputing a database diff
+ - writinga database diff to a database
+ - schema validating
+
+The corresponding issue in the issue tracker to this design document is
+#010534.
Design description
==================
-Ther implementation will consist of two scripts. One for loading schemas into
-the database and one for saving schemas from database to file.
-The scripts will be based on the ConsoleTools component for input handling.
+The implementation will consist of five scripts and will use ConsoleTools for
+handling of parameters. The scripts in this proposal are writtin in UNIX style
+accepting intput from STDIN and writing to STDOUT by default.
Saving a database schema
------------------------
@@ -34,8 +40,8 @@
-n, --native-format=FORMAT Overrides -f, one of db handler names.
-t, --target-file=FILE Path to filename to write output to.
-By default it will write the output to stdout in the XML format. If the user
-has added additional formats they to can be used with -f.
+By default it will write the output to STDOUT in the XML format. If the user
+has added additional formats they too can be used with -f.
Loading a database schema
@@ -50,9 +56,9 @@
-f, --format=FORMAT One of xml[default] or php.
-t, --target-file=FILE Path to filename to read from.
-By default it will load the input from stdin. If -t is used the tool will try
+By default it will load the input from STDIN. If -t is used the tool will try
to guess the format based on the file extension. The format can always be
-overriden with -f. If the user has added additional formats they to can be
+overriden with -f. If the user has added additional formats they too can be
used with -f.
@@ -69,8 +75,8 @@
FROM and TO can both be DSN's specifying databases to read from
or they can be paths to files containing db schema definitions.
-By default it will write the output to stdout in the XML format. If the user
-has added additional formats they to can be used with -f.
+By default it will write the output to STDOUT in the XML format. If the user
+has added additional formats they too can be used with -f.
Applying a diff
--------------
@@ -83,9 +89,9 @@
-t, --target-file=FILE Path to filename to write output to
TARGET is the DSN to the database that should have the diff applied. By default
-the script will load the diff from stdin. This can be overriden with -t.
+the script will load the diff from STDIN. This can be overriden with -t.
-Since this script can be potentially harmful to your database I wonder if we
+Since this script can be potentially harmful to your database should we
should issue a warning by default and ask if the user is sure he/she wants to
continue. This could be surpressed with an optional parameter.
@@ -100,6 +106,7 @@
-f, --format=FORMAT One of xml[default] or php.
-t, --target-file=FILE Path or DSN to validate.
+Validates the schema from STDIN or given by -f.
..
--
svn-components mailing list
[EMAIL PROTECTED]
http://lists.ez.no/mailman/listinfo/svn-components
