From: Mark Addison Date: Thu, 19 Aug 2004 20:41:32 +0000 (+0000) Subject: Doc tweaks X-Git-Tag: v0.06~8 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=91f28468f293ce987a7f927c112316d27a6b87f6;p=dbsrgits%2FSQL-Translator.git Doc tweaks --- diff --git a/lib/SQL/Translator/Parser/XML/SQLFairy.pm b/lib/SQL/Translator/Parser/XML/SQLFairy.pm index d4a06ad..7edcdab 100644 --- a/lib/SQL/Translator/Parser/XML/SQLFairy.pm +++ b/lib/SQL/Translator/Parser/XML/SQLFairy.pm @@ -1,7 +1,7 @@ package SQL::Translator::Parser::XML::SQLFairy; # ------------------------------------------------------------------- -# $Id: SQLFairy.pm,v 1.9 2004-08-19 14:08:59 grommit Exp $ +# $Id: SQLFairy.pm,v 1.10 2004-08-19 20:41:31 grommit Exp $ # ------------------------------------------------------------------- # Copyright (C) 2003 Mark Addison , # @@ -42,7 +42,7 @@ SQL::Translator::Parser::XML::SQLFairy - parser for SQL::Translator's XML. =head1 DESCRIPTION This parser handles the flavor of XML used natively by the SQLFairy -project (SQL::Translator). The XML must be in the namespace +project (L). The XML must be in the namespace "http://sqlfairy.sourceforge.net/sqlfairy.xml." See L for details of this format. @@ -64,15 +64,14 @@ tags then the order the tags appear in the XML will be used. =head2 default_value -Leave the tag out all together to use the default in Schema::Field. -Use empty tags or 'EMPTY_STRING' for a zero lenth string. 'NULL' for an +Leave the attribute out all together to use the default in L. +Use empty quotes or 'EMPTY_STRING' for a zero lenth string. 'NULL' for an explicit null (currently sets default_value to undef in the Schema::Field obj). - - EMPTY_STRING - - NULL + + + =head2 ARGS @@ -88,13 +87,12 @@ XPathing etc! So we have moved to a fixed version described in L. This version of the parser will still parse the old formats and emmit warnings -when it sees them being used. -The old format is B and B be supported in future -versions. +when it sees them being used but they should be considered B. -To convert your old format files simply pass them through the translator; +To convert your old format files simply pass them through the translator :) - sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml + $ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml =cut @@ -103,7 +101,7 @@ To convert your old format files simply pass them through the translator; use strict; use vars qw[ $DEBUG $VERSION @EXPORT_OK ]; -$VERSION = sprintf "%d.%02d", q$Revision: 1.9 $ =~ /(\d+)\.(\d+)/; +$VERSION = sprintf "%d.%02d", q$Revision: 1.10 $ =~ /(\d+)\.(\d+)/; $DEBUG = 0 unless defined $DEBUG; use Data::Dumper; @@ -311,6 +309,11 @@ Ignores the order attribute for Constraints, Views, Indices, Views, Triggers and Procedures, using the tag order instead. (This is the order output by the SQLFairy XML producer). +=head1 SEE ALSO + +L, L, L, +L. + =head1 TODO =over 4 @@ -325,7 +328,7 @@ Test foreign keys are parsed ok. =item * -Control over defaulting of non-existant tags. +Control over defaulting. =back @@ -333,9 +336,4 @@ Control over defaulting of non-existant tags. Mark D. Addison Emark.addison@itn.co.ukE. -=head1 SEE ALSO - -perl(1), SQL::Translator, SQL::Translator::Producer::XML::SQLFairy, -SQL::Translator::Schema. - =cut diff --git a/lib/SQL/Translator/Producer/XML/SQLFairy.pm b/lib/SQL/Translator/Producer/XML/SQLFairy.pm index 73fa851..73e1a9f 100644 --- a/lib/SQL/Translator/Producer/XML/SQLFairy.pm +++ b/lib/SQL/Translator/Producer/XML/SQLFairy.pm @@ -1,7 +1,7 @@ package SQL::Translator::Producer::XML::SQLFairy; # ------------------------------------------------------------------- -# $Id: SQLFairy.pm,v 1.17 2004-08-19 14:09:00 grommit Exp $ +# $Id: SQLFairy.pm,v 1.18 2004-08-19 20:41:32 grommit Exp $ # ------------------------------------------------------------------- # Copyright (C) 2003 Ken Y. Clark , # darren chamberlain , @@ -38,26 +38,27 @@ SQL::Translator::Producer::XML::SQLFairy - SQLFairy's default XML format to => 'XML-SQLFairy', filename => 'schema.sql', show_warnings => 1, - add_drop_table => 1, ); print $t->translate; =head1 DESCRIPTION -Creates XML output of a schema, in SQLFairy format XML. +Creates XML output of a schema, in the flavor of XML used natively by the +SQLFairy project (L). This format is detailed here. -The XML lives in the http://sqlfairy.sourceforge.net/sqlfairy.xml namespace. +The XML lives in the C namespace. With a root element of . -Objects in the schema are mapped to tags of the same name as the objects class. +Objects in the schema are mapped to tags of the same name as the objects class +(all lowercase). The attributes of the objects (e.g. $field->name) are mapped to attributes of the tag, except for sql, comments and action, which get mapped to child data elements. List valued attributes (such as the list of fields in an index) -get mapped to a comma seperated list of values in the attribute. +get mapped to comma seperated lists of values in the attribute. Child objects, such as a tables fields, get mapped to child tags wrapped in a set of container tags using the plural of their contained classes name. @@ -71,33 +72,34 @@ e.g. - - - - - - - - - - - - ... - - - - - - -
- - - SELECT email FROM Basic WHERE email IS NOT NULL - + + + + + + + + + + + + ... + + + + +
+ + + + + SELECT email FROM Basic WHERE email IS NOT NULL + + @@ -155,15 +157,15 @@ the result is a great many possible XML formats, not so good for DTD writing, XPathing etc! So we have moved to a fixed version described above. This version of the producer will now only produce the new style XML. -To convert your old format files simply pass them through the translator; +To convert your old format files simply pass them through the translator :) - sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml + $ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml =cut use strict; use vars qw[ $VERSION @EXPORT_OK ]; -$VERSION = sprintf "%d.%02d", q$Revision: 1.17 $ =~ /(\d+)\.(\d+)/; +$VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/; use Exporter; use base qw(Exporter); @@ -389,7 +391,7 @@ Mark Addison Emark.addison@itn.co.ukE. =head1 SEE ALSO -perl(1), SQL::Translator, SQL::Translator::Parser::XML::SQLFairy, -SQL::Translator::Schema, XML::Writer. +L, L, L, +L, L. =cut