1 package SQL::Translator::Parser::XML::SQLFairy;
3 # -------------------------------------------------------------------
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Mark Addison <mark.addison@itn.co.uk>,
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
25 SQL::Translator::Parser::XML::SQLFairy - parser for SQL::Translator's XML.
31 my $translator = SQL::Translator->new( show_warnings => 1 );
33 my $out = $obj->translate(
34 from => 'XML-SQLFairy',
36 filename => 'schema.xml',
37 ) or die $translator->error;
43 This parser handles the flavor of XML used natively by the SQLFairy
44 project (L<SQL::Translator>). The XML must be in the namespace
45 "http://sqlfairy.sourceforge.net/sqlfairy.xml."
46 See L<SQL::Translator::Producer::XML::SQLFairy> for details of this format.
48 You do not need to specify every attribute of the Schema objects as any missing
49 from the XML will be set to their default values. e.g. A field could be written
52 <sqlf:field name="email" data_type="varchar" size="255" />
56 <sqlf:field name="email" data_type="varchar" size="255" is_nullable="1"
57 is_auto_increment="0" is_primary_key="0" is_foreign_key="0" order="4">
58 <sqlf:comments></sqlf:comments>
61 If you do not explicitly set the order of items using order attributes on the
62 tags then the order the tags appear in the XML will be used.
66 Leave the attribute out all together to use the default in L<Schema::Field>.
67 Use empty quotes or 'EMPTY_STRING' for a zero lenth string. 'NULL' for an
68 explicit null (currently sets default_value to undef in the
71 <sqlf:field default_value="" /> <!-- Empty string -->
72 <sqlf:field default_value="EMPTY_STRING" /> <!-- Empty string -->
73 <sqlf:field default_value="NULL" /> <!-- NULL -->
77 Doesn't take any extra parser args at the moment.
81 The previous version of the SQLFairy XML allowed the attributes of the the
82 schema objects to be written as either xml attributes or as data elements, in
83 any combination. While this allows for lots of flexibility in writing the XML
84 the result is a great many possible XML formats, not so good for DTD writing,
85 XPathing etc! So we have moved to a fixed version described in
86 L<SQL::Translator::Producer::XML::SQLFairy>.
88 This version of the parser will still parse the old formats and emmit warnings
89 when it sees them being used but they should be considered B<heavily
92 To convert your old format files simply pass them through the translator :)
94 $ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml
98 # -------------------------------------------------------------------
102 use vars qw[ $DEBUG @EXPORT_OK ];
103 $DEBUG = 0 unless defined $DEBUG;
107 use base qw(Exporter);
108 @EXPORT_OK = qw(parse);
110 use base qw/SQL::Translator::Parser/; # Doesnt do anything at the mo!
111 use SQL::Translator::Utils 'debug';
113 use XML::XPath::XMLParser;
116 my ( $translator, $data ) = @_;
117 my $schema = $translator->schema;
118 local $DEBUG = $translator->debug;
119 my $xp = XML::XPath->new(xml => $data);
121 $xp->set_namespace("sqlf", "http://sqlfairy.sourceforge.net/sqlfairy.xml");
124 # Work our way through the tables
126 my @nodes = $xp->findnodes(
127 '/sqlf:schema/sqlf:table|/sqlf:schema/sqlf:tables/sqlf:table'
131 ("".$xp->findvalue('sqlf:order|@order',$a) || 0)
133 ("".$xp->findvalue('sqlf:order|@order',$b) || 0)
136 debug "Adding table:".$xp->findvalue('sqlf:name',$tblnode);
138 my $table = $schema->add_table(
139 get_tagfields($xp, $tblnode, "sqlf:" => qw/name order extra/)
140 ) or die $schema->error;
145 my @nodes = $xp->findnodes('sqlf:fields/sqlf:field',$tblnode);
148 ("".$xp->findvalue('sqlf:order',$a) || 0)
150 ("".$xp->findvalue('sqlf:order',$b) || 0)
153 my %fdata = get_tagfields($xp, $_, "sqlf:",
154 qw/name data_type size default_value is_nullable extra
155 is_auto_increment is_primary_key is_foreign_key comments/
159 exists $fdata{'default_value'} and
160 defined $fdata{'default_value'}
162 if ( $fdata{'default_value'} =~ /^\s*NULL\s*$/ ) {
163 $fdata{'default_value'}= undef;
165 elsif ( $fdata{'default_value'} =~ /^\s*EMPTY_STRING\s*$/ ) {
166 $fdata{'default_value'} = "";
170 my $field = $table->add_field( %fdata ) or die $table->error;
172 $table->primary_key( $field->name ) if $fdata{'is_primary_key'};
176 # - We should be able to make the table obj spot this when
184 @nodes = $xp->findnodes('sqlf:constraints/sqlf:constraint',$tblnode);
186 my %data = get_tagfields($xp, $_, "sqlf:",
187 qw/name type table fields reference_fields reference_table
188 match_type on_delete on_update extra/
190 $table->add_constraint( %data ) or die $table->error;
196 @nodes = $xp->findnodes('sqlf:indices/sqlf:index',$tblnode);
198 my %data = get_tagfields($xp, $_, "sqlf:",
199 qw/name type fields options extra/);
200 $table->add_index( %data ) or die $table->error;
207 @nodes = $xp->findnodes('sqlf:comments/sqlf:comment',$tblnode);
209 my $data = $_->string_value;
210 $table->comments( $data );
218 @nodes = $xp->findnodes(
219 '/sqlf:schema/sqlf:view|/sqlf:schema/sqlf:views/sqlf:view'
222 my %data = get_tagfields($xp, $_, "sqlf:",
223 qw/name sql fields order extra/
225 $schema->add_view( %data ) or die $schema->error;
231 @nodes = $xp->findnodes(
232 '/sqlf:schema/sqlf:trigger|/sqlf:schema/sqlf:triggers/sqlf:trigger'
235 my %data = get_tagfields($xp, $_, "sqlf:", qw/
236 name perform_action_when database_event fields on_table action order
239 $schema->add_trigger( %data ) or die $schema->error;
245 @nodes = $xp->findnodes(
246 '/sqlf:schema/sqlf:procedure|/sqlf:schema/sqlf:procedures/sqlf:procedure'
249 my %data = get_tagfields($xp, $_, "sqlf:",
250 qw/name sql parameters owner comments order extra/
252 $schema->add_procedure( %data ) or die $schema->error;
258 # -------------------------------------------------------------------
261 # get_tagfields XP, NODE, NAMESPACE => qw/TAGNAMES/;
262 # get_tagfields $node, "sqlf:" => qw/name type fields reference/;
264 # Returns hash of data.
265 # TODO - Add handling of an explicit NULL value.
268 my ($xp, $node, @names) = @_;
271 if ( m/:$/ ) { $ns = $_; next; } # Set def namespace
272 my $thisns = (s/(^.*?:)// ? $1 : $ns);
274 my $is_attrib = m/^(sql|comments|action|extra)$/ ? 0 : 1;
276 my $attrib_path = "\@$thisns$_";
277 my $tag_path = "$thisns$_";
278 if ( $xp->exists($attrib_path,$node) ) {
279 $data{$_} = "".$xp->findvalue($attrib_path,$node);
280 warn "Use of '$_' as an attribute is depricated."
281 ." Use a child tag instead."
282 ." To convert your file to the new version see the Docs.\n"
284 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
286 elsif ( $xp->exists($tag_path,$node) ) {
289 my $extra_nodes = $xp->find($tag_path,$node);
290 foreach ( $extra_nodes->pop->getAttributes ) {
291 $extra{$_->getName} = $_->getData;
296 $data{$_} = "".$xp->findvalue($tag_path,$node);
298 warn "Use of '$_' as a child tag is depricated."
299 ." Use an attribute instead."
300 ." To convert your file to the new version see the Docs.\n"
302 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
306 return wantarray ? %data : \%data;
311 # -------------------------------------------------------------------
317 Ignores the order attribute for Constraints, Views, Indices,
318 Views, Triggers and Procedures, using the tag order instead. (This is the order
319 output by the SQLFairy XML producer).
323 L<perl>, L<SQL::Translator>, L<SQL::Translator::Producer::XML::SQLFairy>,
324 L<SQL::Translator::Schema>.
332 Support options attribute.
336 Test foreign keys are parsed ok.
340 Control over defaulting.
346 Mark D. Addison E<lt>mark.addison@itn.co.ukE<gt>.