1 package SQL::Translator::Parser::XML::SQLFairy;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2003 Mark Addison <mark.addison@itn.co.uk>,
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
23 SQL::Translator::Parser::XML::SQLFairy - parser for SQL::Translator's XML.
29 my $translator = SQL::Translator->new( show_warnings => 1 );
31 my $out = $obj->translate(
32 from => 'XML-SQLFairy',
34 filename => 'schema.xml',
35 ) or die $translator->error;
41 This parser handles the flavor of XML used natively by the SQLFairy
42 project (L<SQL::Translator>). The XML must be in the namespace
43 "http://sqlfairy.sourceforge.net/sqlfairy.xml."
44 See L<SQL::Translator::Producer::XML::SQLFairy> for details of this format.
46 You do not need to specify every attribute of the Schema objects as any missing
47 from the XML will be set to their default values. e.g. A field could be written
50 <sqlf:field name="email" data_type="varchar" size="255" />
54 <sqlf:field name="email" data_type="varchar" size="255" is_nullable="1"
55 is_auto_increment="0" is_primary_key="0" is_foreign_key="0" order="4">
56 <sqlf:comments></sqlf:comments>
59 If you do not explicitly set the order of items using order attributes on the
60 tags then the order the tags appear in the XML will be used.
64 Leave the attribute out all together to use the default in L<Schema::Field>.
65 Use empty quotes or 'EMPTY_STRING' for a zero lenth string. 'NULL' for an
66 explicit null (currently sets default_value to undef in the
69 <sqlf:field default_value="" /> <!-- Empty string -->
70 <sqlf:field default_value="EMPTY_STRING" /> <!-- Empty string -->
71 <sqlf:field default_value="NULL" /> <!-- NULL -->
75 Doesn't take any extra parser args at the moment.
79 The previous version of the SQLFairy XML allowed the attributes of the the
80 schema objects to be written as either xml attributes or as data elements, in
81 any combination. While this allows for lots of flexibility in writing the XML
82 the result is a great many possible XML formats, not so good for DTD writing,
83 XPathing etc! So we have moved to a fixed version described in
84 L<SQL::Translator::Producer::XML::SQLFairy>.
86 This version of the parser will still parse the old formats and emmit warnings
87 when it sees them being used but they should be considered B<heavily
90 To convert your old format files simply pass them through the translator :)
92 $ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml
96 # -------------------------------------------------------------------
100 use vars qw[ $DEBUG $VERSION @EXPORT_OK ];
102 $DEBUG = 0 unless defined $DEBUG;
106 use base qw(Exporter);
107 @EXPORT_OK = qw(parse);
109 use base qw/SQL::Translator::Parser/; # Doesnt do anything at the mo!
110 use SQL::Translator::Utils 'debug';
112 use XML::XPath::XMLParser;
115 my ( $translator, $data ) = @_;
116 my $schema = $translator->schema;
117 local $DEBUG = $translator->debug;
118 my $xp = XML::XPath->new(xml => $data);
120 $xp->set_namespace("sqlf", "http://sqlfairy.sourceforge.net/sqlfairy.xml");
123 # Work our way through the tables
125 my @nodes = $xp->findnodes(
126 '/sqlf:schema/sqlf:table|/sqlf:schema/sqlf:tables/sqlf:table'
130 ("".$xp->findvalue('sqlf:order|@order',$a) || 0)
132 ("".$xp->findvalue('sqlf:order|@order',$b) || 0)
135 debug "Adding table:".$xp->findvalue('sqlf:name',$tblnode);
137 my $table = $schema->add_table(
138 get_tagfields($xp, $tblnode, "sqlf:" => qw/name order extra/)
139 ) or die $schema->error;
144 my @nodes = $xp->findnodes('sqlf:fields/sqlf:field',$tblnode);
147 ("".$xp->findvalue('sqlf:order',$a) || 0)
149 ("".$xp->findvalue('sqlf:order',$b) || 0)
152 my %fdata = get_tagfields($xp, $_, "sqlf:",
153 qw/name data_type size default_value is_nullable extra
154 is_auto_increment is_primary_key is_foreign_key comments/
158 exists $fdata{'default_value'} and
159 defined $fdata{'default_value'}
161 if ( $fdata{'default_value'} =~ /^\s*NULL\s*$/ ) {
162 $fdata{'default_value'}= undef;
164 elsif ( $fdata{'default_value'} =~ /^\s*EMPTY_STRING\s*$/ ) {
165 $fdata{'default_value'} = "";
169 my $field = $table->add_field( %fdata ) or die $table->error;
171 $table->primary_key( $field->name ) if $fdata{'is_primary_key'};
175 # - We should be able to make the table obj spot this when
183 @nodes = $xp->findnodes('sqlf:constraints/sqlf:constraint',$tblnode);
185 my %data = get_tagfields($xp, $_, "sqlf:",
186 qw/name type table fields reference_fields reference_table
187 match_type on_delete on_update extra/
189 $table->add_constraint( %data ) or die $table->error;
195 @nodes = $xp->findnodes('sqlf:indices/sqlf:index',$tblnode);
197 my %data = get_tagfields($xp, $_, "sqlf:",
198 qw/name type fields options extra/);
199 $table->add_index( %data ) or die $table->error;
206 @nodes = $xp->findnodes('sqlf:comments/sqlf:comment',$tblnode);
208 my $data = $_->string_value;
209 $table->comments( $data );
217 @nodes = $xp->findnodes(
218 '/sqlf:schema/sqlf:view|/sqlf:schema/sqlf:views/sqlf:view'
221 my %data = get_tagfields($xp, $_, "sqlf:",
222 qw/name sql fields order extra/
224 $schema->add_view( %data ) or die $schema->error;
230 @nodes = $xp->findnodes(
231 '/sqlf:schema/sqlf:trigger|/sqlf:schema/sqlf:triggers/sqlf:trigger'
234 my %data = get_tagfields($xp, $_, "sqlf:", qw/
235 name perform_action_when database_event fields on_table action order
238 $schema->add_trigger( %data ) or die $schema->error;
244 @nodes = $xp->findnodes(
245 '/sqlf:schema/sqlf:procedure|/sqlf:schema/sqlf:procedures/sqlf:procedure'
248 my %data = get_tagfields($xp, $_, "sqlf:",
249 qw/name sql parameters owner comments order extra/
251 $schema->add_procedure( %data ) or die $schema->error;
257 # -------------------------------------------------------------------
260 # get_tagfields XP, NODE, NAMESPACE => qw/TAGNAMES/;
261 # get_tagfields $node, "sqlf:" => qw/name type fields reference/;
263 # Returns hash of data.
264 # TODO - Add handling of an explicit NULL value.
267 my ($xp, $node, @names) = @_;
270 if ( m/:$/ ) { $ns = $_; next; } # Set def namespace
271 my $thisns = (s/(^.*?:)// ? $1 : $ns);
273 my $is_attrib = m/^(sql|comments|action|extra)$/ ? 0 : 1;
275 my $attrib_path = "\@$thisns$_";
276 my $tag_path = "$thisns$_";
277 if ( $xp->exists($attrib_path,$node) ) {
278 $data{$_} = "".$xp->findvalue($attrib_path,$node);
279 warn "Use of '$_' as an attribute is depricated."
280 ." Use a child tag instead."
281 ." To convert your file to the new version see the Docs.\n"
283 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
285 elsif ( $xp->exists($tag_path,$node) ) {
288 my $extra_nodes = $xp->find($tag_path,$node);
289 foreach ( $extra_nodes->pop->getAttributes ) {
290 $extra{$_->getName} = $_->getData;
295 $data{$_} = "".$xp->findvalue($tag_path,$node);
297 warn "Use of '$_' as a child tag is depricated."
298 ." Use an attribute instead."
299 ." To convert your file to the new version see the Docs.\n"
301 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
305 return wantarray ? %data : \%data;
310 # -------------------------------------------------------------------
316 Ignores the order attribute for Constraints, Views, Indices,
317 Views, Triggers and Procedures, using the tag order instead. (This is the order
318 output by the SQLFairy XML producer).
322 L<perl>, L<SQL::Translator>, L<SQL::Translator::Producer::XML::SQLFairy>,
323 L<SQL::Translator::Schema>.
331 Support options attribute.
335 Test foreign keys are parsed ok.
339 Control over defaulting.
345 Mark D. Addison E<lt>mark.addison@itn.co.ukE<gt>.