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
81 our ( $DEBUG, @EXPORT_OK );
82 our $VERSION = '1.59';
83 $DEBUG = 0 unless defined $DEBUG;
86 use Carp::Clan qw/^SQL::Translator/;
88 use base qw(Exporter);
89 @EXPORT_OK = qw(parse);
91 use base qw/SQL::Translator::Parser/; # Doesnt do anything at the mo!
92 use SQL::Translator::Utils 'debug';
94 use XML::LibXML::XPathContext;
97 my ( $translator, $data ) = @_;
98 my $schema = $translator->schema;
99 local $DEBUG = $translator->debug;
100 my $doc = XML::LibXML->new->parse_string($data);
101 my $xp = XML::LibXML::XPathContext->new($doc);
103 $xp->registerNs("sqlf", "http://sqlfairy.sourceforge.net/sqlfairy.xml");
106 # Work our way through the tables
108 my @nodes = $xp->findnodes(
109 '/sqlf:schema/sqlf:table|/sqlf:schema/sqlf:tables/sqlf:table'
113 ("".$xp->findvalue('sqlf:order|@order',$a) || 0)
115 ("".$xp->findvalue('sqlf:order|@order',$b) || 0)
118 debug "Adding table:".$xp->findvalue('sqlf:name',$tblnode);
120 my $table = $schema->add_table(
121 get_tagfields($xp, $tblnode, "sqlf:" => qw/name order extra/)
122 ) or die $schema->error;
127 my @nodes = $xp->findnodes('sqlf:fields/sqlf:field',$tblnode);
130 ("".$xp->findvalue('sqlf:order',$a) || 0)
132 ("".$xp->findvalue('sqlf:order',$b) || 0)
135 my %fdata = get_tagfields($xp, $_, "sqlf:",
136 qw/name data_type size default_value is_nullable extra
137 is_auto_increment is_primary_key is_foreign_key comments/
141 exists $fdata{'default_value'} and
142 defined $fdata{'default_value'}
144 if ( $fdata{'default_value'} =~ /^\s*NULL\s*$/ ) {
145 $fdata{'default_value'}= undef;
147 elsif ( $fdata{'default_value'} =~ /^\s*EMPTY_STRING\s*$/ ) {
148 $fdata{'default_value'} = "";
152 my $field = $table->add_field( %fdata ) or die $table->error;
154 $table->primary_key( $field->name ) if $fdata{'is_primary_key'};
158 # - We should be able to make the table obj spot this when
166 @nodes = $xp->findnodes('sqlf:constraints/sqlf:constraint',$tblnode);
168 my %data = get_tagfields($xp, $_, "sqlf:",
169 qw/name type table fields reference_fields reference_table
170 match_type on_delete on_update extra/
172 $table->add_constraint( %data ) or die $table->error;
178 @nodes = $xp->findnodes('sqlf:indices/sqlf:index',$tblnode);
180 my %data = get_tagfields($xp, $_, "sqlf:",
181 qw/name type fields options extra/);
182 $table->add_index( %data ) or die $table->error;
189 @nodes = $xp->findnodes('sqlf:comments/sqlf:comment',$tblnode);
191 my $data = $_->string_value;
192 $table->comments( $data );
200 @nodes = $xp->findnodes(
201 '/sqlf:schema/sqlf:view|/sqlf:schema/sqlf:views/sqlf:view'
204 my %data = get_tagfields($xp, $_, "sqlf:",
205 qw/name sql fields order extra/
207 $schema->add_view( %data ) or die $schema->error;
213 @nodes = $xp->findnodes(
214 '/sqlf:schema/sqlf:trigger|/sqlf:schema/sqlf:triggers/sqlf:trigger'
217 my %data = get_tagfields($xp, $_, "sqlf:", qw/
218 name perform_action_when database_event database_events fields
219 on_table action order extra
223 if (my $evt = $data{database_event} and $translator->{show_warnings}) {
224 carp 'The database_event tag is deprecated - please use ' .
225 'database_events (which can take one or more comma separated ' .
227 $data{database_events} = join (', ',
228 $data{database_events} || (),
233 # split into arrayref
234 if (my $evts = $data{database_events}) {
235 $data{database_events} = [split (/\s*,\s*/, $evts) ];
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;
259 # get_tagfields XP, NODE, NAMESPACE => qw/TAGNAMES/;
260 # get_tagfields $node, "sqlf:" => qw/name type fields reference/;
262 # Returns hash of data.
263 # TODO - Add handling of an explicit NULL value.
266 my ($xp, $node, @names) = @_;
269 if ( m/:$/ ) { $ns = $_; next; } # Set def namespace
270 my $thisns = (s/(^.*?:)// ? $1 : $ns);
272 my $is_attrib = m/^(sql|comments|action|extra)$/ ? 0 : 1;
274 my $attrib_path = "\@$_";
275 my $tag_path = "$thisns$_";
276 if ( my $found = $xp->find($attrib_path,$node) ) {
277 $data{$_} = "".$found->to_literal;
278 warn "Use of '$_' as an attribute is depricated."
279 ." Use a child tag instead."
280 ." To convert your file to the new version see the Docs.\n"
282 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
284 elsif ( $found = $xp->find($tag_path,$node) ) {
287 foreach ( $found->pop->getAttributes ) {
288 $extra{$_->getName} = $_->getData;
293 $data{$_} = "".$found->to_literal;
295 warn "Use of '$_' as a child tag is depricated."
296 ." Use an attribute instead."
297 ." To convert your file to the new version see the Docs.\n"
299 debug "Got $_=".( defined $data{ $_ } ? $data{ $_ } : 'UNDEF' );
303 return wantarray ? %data : \%data;
312 Ignores the order attribute for Constraints, Views, Indices, Views, Triggers
313 and Procedures, using the tag order instead. (This is the order output by the
314 SQLFairy XML producer).
318 L<perl>, L<SQL::Translator>, L<SQL::Translator::Producer::XML::SQLFairy>,
319 L<SQL::Translator::Schema>.
327 Support options attribute.
331 Test foreign keys are parsed ok.
335 Control over defaulting.
341 Mark D. Addison E<lt>mark.addison@itn.co.ukE<gt>,
342 Jonathan Yu E<lt>frequency@cpan.orgE<gt>