[Jifty-commit] r2750 - jifty/trunk/lib/Jifty/Script

[jifty-commit at lists.jifty.org]

Author: bartb
Date: Sat Feb  3 17:27:45 2007
New Revision: 2750

Modified:
   jifty/trunk/lib/Jifty/Script/Schema.pm

Log:
update docs about SchemaCheck

Modified: jifty/trunk/lib/Jifty/Script/Schema.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Schema.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Schema.pm	Sat Feb  3 17:27:45 2007
@@ -546,6 +546,7 @@
    --setup            Upgrade or install the database, creating it if need be
    --create-database  Only creates the database
    --drop-database    Drops the database
+   --ignore-reserved-words   Ignore any SQL reserved words in schema definition
 
    --help             brief help message
    --man              full documentation
@@ -579,6 +580,11 @@
 assumed if the database does not exist, or the database version is not
 the same as the application's version.
 
+=item B<--ignore-reserved-words>
+
+Ignore any SQL reserved words used in table or column deffinitions, if
+this option is not used and a reserved word is found it will cause an error.
+
 =item B<--help>
 
 Print a brief help message and exits.
@@ -602,6 +608,13 @@
 I<ProjectRoot>C</etc/config.yml>, because the SQL generated may depend
 on the database type.)
 
+By default checks for SQL reserved words in your table names and
+column definitions, throwing an error if any are found.  
+
+If you want to permanently turn this behaviour off you can set
+CheckSchema to 0 in the database section of your applications config
+file.
+
 =head1 BUGS
 
 Due to limitations of L<DBIx::DBSchema>, this probably only works with