1 package SQL::Translator::Parser::XML::SQLFairy;
5 SQL::Translator::Parser::XML::SQLFairy - parser for SQL::Translator's XML.
11 my $translator = SQL::Translator->new( show_warnings => 1 );
13 my $out = $obj->translate(
14 from => 'XML-SQLFairy',
16 filename => 'schema.xml',
17 ) or die $translator->error;
23 This parser handles the flavor of XML used natively by the SQLFairy
24 project (L<SQL::Translator>). The XML must be in the namespace
25 "http://sqlfairy.sourceforge.net/sqlfairy.xml."
26 See L<SQL::Translator::Producer::XML::SQLFairy> for details of this format.
28 You do not need to specify every attribute of the Schema objects as any missing
29 from the XML will be set to their default values. e.g. A field could be written
32 <sqlf:field name="email" data_type="varchar" size="255" />
36 <sqlf:field name="email" data_type="varchar" size="255" is_nullable="1"
37 is_auto_increment="0" is_primary_key="0" is_foreign_key="0" order="4">
38 <sqlf:comments></sqlf:comments>
41 If you do not explicitly set the order of items using order attributes on the
42 tags then the order the tags appear in the XML will be used.
46 Leave the attribute out all together to use the default in L<Schema::Field>.
47 Use empty quotes or 'EMPTY_STRING' for a zero lenth string. 'NULL' for an
48 explicit null (currently sets default_value to undef in the
51 <sqlf:field default_value="" /> <!-- Empty string -->
52 <sqlf:field default_value="EMPTY_STRING" /> <!-- Empty string -->
53 <sqlf:field default_value="NULL" /> <!-- NULL -->
57 Doesn't take any extra parser args at the moment.
61 The previous version of the SQLFairy XML allowed the attributes of the the
62 schema objects to be written as either xml attributes or as data elements, in
63 any combination. While this allows for lots of flexibility in writing the XML
64 the result is a great many possible XML formats, not so good for DTD writing,
65 XPathing etc! So we have moved to a fixed version described in
66 L<SQL::Translator::Producer::XML::SQLFairy>.
68 This version of the parser will still parse the old formats and emmit warnings
69 when it sees them being used but they should be considered B<heavily
72 To convert your old format files simply pass them through the translator :)
74 $ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml
80 use vars qw[ $DEBUG $VERSION @EXPORT_OK ];
82 $DEBUG = 0 unless defined $DEBUG;
85 use Carp::Clan qw/^SQL::Translator/;
87 use base qw(Exporter);
88 @EXPORT_OK = qw(parse);
90 use base qw/SQL::Translator::Parser/; # Doesnt do anything at the mo!
91 use SQL::Translator::Utils 'debug';
93 use XML::LibXML::XPathContext;
96 my ( $translator, $data ) = @_;
97 my $schema = $translator->schema;
98 local $DEBUG = $translator->debug;
99 my $doc = XML::LibXML->new->parse_string($data);
100 my $xp = XML::LibXML::XPathContext->new($doc);
102 $xp->registerNs("sqlf", "http://sqlfairy.sourceforge.net/sqlfairy.xml");
105 # Work our way through the tables
107 my @nodes = $xp->findnodes(
108 '/sqlf:schema/sqlf:table|/sqlf:schema/sqlf:tables/sqlf:table'
112 ("".$xp->findvalue('sqlf:order|@order',$a) || 0)
114 ("".$xp->findvalue('sqlf:order|@order',$b) || 0)
117 debug "Adding table:".$xp->findvalue('sqlf:name',$tblnode);
119 my $table = $schema->add_table(
120 get_tagfields($xp, $tblnode, "sqlf:" => qw/name order extra/)
121 ) or die $schema->error;
126 my @nodes = $xp->findnodes('sqlf:fields/sqlf:field',$tblnode);
129 ("".$xp->findvalue('sqlf:order',$a) || 0)
131 ("".$xp->findvalue('sqlf:order',$b) || 0)
134 my %fdata = get_tagfields($xp, $_, "sqlf:",
135 qw/name data_type size default_value is_nullable extra
136 is_auto_increment is_primary_key is_foreign_key comments/
140 exists $fdata{'default_value'} and
141 defined $fdata{'default_value'}
143 if ( $fdata{'default_value'} =~ /^\s*NULL\s*$/ ) {
144 $fdata{'default_value'}= undef;
146 elsif ( $fdata{'default_value'} =~ /^\s*EMPTY_STRING\s*$/ ) {
147 $fdata{'default_value'} = "";
151 my $field = $table->add_field( %fdata ) or die $table->error;
153 $table->primary_key( $field->name ) if $fdata{'is_primary_key'};
157 # - We should be able to make the table obj spot this when
165 @nodes = $xp->findnodes('sqlf:constraints/sqlf:constraint',$tblnode);
167 my %data = get_tagfields($xp, $_, "sqlf:",
168 qw/name type table fields reference_fields reference_table
169 match_type on_delete on_update extra/
171 $table->add_constraint( %data ) or die $table->error;
177 @nodes = $xp->findnodes('sqlf:indices/sqlf:index',$tblnode);
179 my %data = get_tagfields($xp, $_, "sqlf:",
180 qw/name type fields options extra/);
181 $table->add_index( %data ) or die $table->error;
188 @nodes = $xp->findnodes('sqlf:comments/sqlf:comment',$tblnode);
190 my $data = $_->string_value;
191 $table->comments( $data );
199 @nodes = $xp->findnodes(
200 '/sqlf:schema/sqlf:view|/sqlf:schema/sqlf:views/sqlf:view'
203 my %data = get_tagfields($xp, $_, "sqlf:",
204 qw/name sql fields order extra/
206 $schema->add_view( %data ) or die $schema->error;
212 @nodes = $xp->findnodes(
213 '/sqlf:schema/sqlf:trigger|/sqlf:schema/sqlf:triggers/sqlf:trigger'
216 my %data = get_tagfields($xp, $_, "sqlf:", qw/
217 name perform_action_when database_event database_events fields
218 on_table action order extra
222 if (my $evt = $data{database_event} and $translator->{show_warnings}) {
223 carp 'The database_event tag is deprecated - please use ' .
224 'database_events (which can take one or more comma separated ' .
226 $data{database_events} = join (', ',
227 $data{database_events} || (),
232 # split into arrayref
233 if (my $evts = $data{database_events}) {
234 $data{database_events} = [split (/\s*,\s*/, $evts) ];
237 $schema->add_trigger( %data ) or die $schema->error;
243 @nodes = $xp->findnodes(
244 '/sqlf:schema/sqlf:procedure|/sqlf:schema/sqlf:procedures/sqlf:procedure'
247 my %data = get_tagfields($xp, $_, "sqlf:",
248 qw/name sql parameters owner comments order extra/
250 $schema->add_procedure( %data ) or die $schema->error;
258 # get_tagfields XP, NODE, NAMESPACE => qw/TAGNAMES/;
259 # get_tagfields $node, "sqlf:" => qw/name type fields reference/;
261 # Returns hash of data.
262 # TODO - Add handling of an explicit NULL value.
265 my ($xp, $node, @names) = @_;
268 if ( m/:$/ ) { $ns = $_; next; } # Set def namespace
269 my $thisns = (s/(^.*?:)// ? $1 : $ns);
271 my $is_attrib = m/^(sql|comments|action|extra)$/ ? 0 : 1;
273 my $attrib_path = "\@$_";
274 my $tag_path = "$thisns$_";
275 if ( my $found = $xp->find($attrib_path,$node) ) {
276 $data{$_} = "".$found->to_literal;
277 warn "Use of '$_' as an attribute is depricated."
278 ." Use a child tag instead."
279 ." To convert your file to the new version see the Docs.\n"
281 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
283 elsif ( $found = $xp->find($tag_path,$node) ) {
286 foreach ( $found->pop->getAttributes ) {
287 $extra{$_->getName} = $_->getData;
292 $data{$_} = "".$found->to_literal;
294 warn "Use of '$_' as a child tag is depricated."
295 ." Use an attribute instead."
296 ." To convert your file to the new version see the Docs.\n"
298 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
302 return wantarray ? %data : \%data;
311 Ignores the order attribute for Constraints, Views, Indices, Views, Triggers
312 and Procedures, using the tag order instead. (This is the order output by the
313 SQLFairy XML producer).
317 L<perl>, L<SQL::Translator>, L<SQL::Translator::Producer::XML::SQLFairy>,
318 L<SQL::Translator::Schema>.
326 Support options attribute.
330 Test foreign keys are parsed ok.
334 Control over defaulting.
340 Mark D. Addison E<lt>mark.addison@itn.co.ukE<gt>,
341 Jonathan Yu E<lt>frequency@cpan.orgE<gt>