1 package SQL::Translator::Producer::XML::SQLFairy;
3 # -------------------------------------------------------------------
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7 # darren chamberlain <darren@cpan.org>,
8 # Chris Mungall <cjm@fruitfly.org>,
9 # Mark Addison <mark.addison@itn.co.uk>.
11 # This program is free software; you can redistribute it and/or
12 # modify it under the terms of the GNU General Public License as
13 # published by the Free Software Foundation; version 2.
15 # This program is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 # General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with this program; if not, write to the Free Software
22 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
24 # -------------------------------------------------------------------
30 SQL::Translator::Producer::XML::SQLFairy - SQLFairy's default XML format
36 my $t = SQL::Translator->new(
39 filename => 'schema.sql',
47 Creates XML output of a schema, in the flavor of XML used natively by the
48 SQLFairy project (L<SQL::Translator>). This format is detailed here.
50 The XML lives in the C<http://sqlfairy.sourceforge.net/sqlfairy.xml> namespace.
51 With a root element of <schema>.
53 Objects in the schema are mapped to tags of the same name as the objects class
56 The attributes of the objects (e.g. $field->name) are mapped to attributes of
57 the tag, except for sql, comments and action, which get mapped to child data
60 List valued attributes (such as the list of fields in an index)
61 get mapped to comma seperated lists of values in the attribute.
63 Child objects, such as a tables fields, get mapped to child tags wrapped in a
64 set of container tags using the plural of their contained classes name.
66 An objects's extra attribute (a hash of arbitary data) is
67 mapped to a tag called extra, with the hash of data as attributes, sorted into
72 <schema name="" database=""
73 xmlns="http://sqlfairy.sourceforge.net/sqlfairy.xml">
76 <table name="Story" order="1">
78 <field name="id" data_type="BIGINT" size="20"
79 is_nullable="0" is_auto_increment="1" is_primary_key="1"
80 is_foreign_key="0" order="3">
81 <extra ZEROFILL="1" />
84 <field name="created" data_type="datetime" size="0"
85 is_nullable="1" is_auto_increment="0" is_primary_key="0"
86 is_foreign_key="0" order="1">
93 <index name="foobar" type="NORMAL" fields="foo,bar" options="" />
99 <view name="email_list" fields="email" order="1">
100 <sql>SELECT email FROM Basic WHERE email IS NOT NULL</sql>
106 To see a complete example of the XML translate one of your schema :)
108 $ sqlt -f MySQL -t XML-SQLFairy schema.sql
116 Set to true to use the default namespace prefix of 'sqlf', instead of using
117 the default namespace for
118 C<http://sqlfairy.sourceforge.net/sqlfairy.xml namespace>
122 <!-- add_prefix=0 -->
125 <!-- add_prefix=1 -->
126 <sqlf:field name="foo" />
130 Set to the namespace prefix you want to use for the
131 C<http://sqlfairy.sourceforge.net/sqlfairy.xml namespace>
135 <!-- prefix='foo' -->
136 <foo:field name="foo" />
140 If true (the default) inserts newlines around the XML, otherwise the schema is
145 When using newlines the number of whitespace characters to use as the indent.
146 Default is 2, set to 0 to turn off indenting.
152 The previous version of the SQLFairy XML allowed the attributes of the the
153 schema objects to be written as either xml attributes or as data elements, in
154 any combination. The old producer could produce attribute only or data element
155 only versions. While this allowed for lots of flexibility in writing the XML
156 the result is a great many possible XML formats, not so good for DTD writing,
157 XPathing etc! So we have moved to a fixed version described above.
159 This version of the producer will now only produce the new style XML.
160 To convert your old format files simply pass them through the translator :)
162 $ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml
167 use vars qw[ @EXPORT_OK ];
170 use base qw(Exporter);
171 @EXPORT_OK = qw(produce);
174 use SQL::Translator::Utils qw(header_comment debug);
176 # Will someone fix XML::Writer already?
182 # Which schema object attributes (methods) to write as xml elements rather than
183 # as attributes. e.g. <comments>blah, blah...</comments>
184 my @MAP_AS_ELEMENTS = qw/sql comments action extra/;
188 my $Namespace = 'http://sqlfairy.sourceforge.net/sqlfairy.xml';
193 my $translator = shift;
194 my $schema = $translator->schema;
195 $PArgs = $translator->producer_args;
196 my $newlines = defined $PArgs->{newlines} ? $PArgs->{newlines} : 1;
197 my $indent = defined $PArgs->{indent} ? $PArgs->{indent} : 2;
198 my $io = IO::Scalar->new;
200 # Setup the XML::Writer and set the namespace
202 $prefix = $Name if $PArgs->{add_prefix};
203 $prefix = $PArgs->{prefix} if $PArgs->{prefix};
204 my $xml = XML::Writer->new(
207 PREFIX_MAP => { $Namespace => $prefix },
208 DATA_MODE => $newlines,
209 DATA_INDENT => $indent,
213 $xml->xmlDecl('UTF-8');
214 $xml->comment(header_comment('', ''));
215 xml_obj($xml, $schema,
216 tag => "schema", methods => [qw/name database extra/], end_tag => 0 );
221 $xml->startTag( [ $Namespace => "tables" ] );
222 for my $table ( $schema->get_tables ) {
223 debug "Table:",$table->name;
224 xml_obj($xml, $table,
226 methods => [qw/name order extra/],
233 xml_obj_children( $xml, $table,
236 name data_type size is_nullable default_value is_auto_increment
237 is_primary_key is_foreign_key extra comments order
244 xml_obj_children( $xml, $table,
246 collection_tag => "indices",
247 methods => [qw/name type fields options extra/],
253 xml_obj_children( $xml, $table,
256 name type fields reference_table reference_fields
257 on_delete on_update match_type expression options deferrable
265 xml_obj_children( $xml, $table,
267 collection_tag => "comments",
273 $xml->endTag( [ $Namespace => 'table' ] );
275 $xml->endTag( [ $Namespace => 'tables' ] );
280 xml_obj_children( $xml, $schema,
282 methods => [qw/name sql fields order extra/],
288 xml_obj_children( $xml, $schema,
290 methods => [qw/name database_event action on_table perform_action_when
291 fields order extra/],
297 xml_obj_children( $xml, $schema,
299 methods => [qw/name sql parameters owner comments order extra/],
302 $xml->endTag([ $Namespace => 'schema' ]);
310 # Takes and XML::Write object, Schema::* parent object, the tag name,
311 # the collection name and a list of methods (of the children) to write as XML.
312 # The collection name defaults to the name with an s on the end and is used to
313 # work out the method to get the children with. eg a name of 'foo' gives a
314 # collection of foos and gets the members using ->get_foos.
316 sub xml_obj_children {
317 my ($xml,$parent) = (shift,shift);
319 my ($name,$collection_name,$methods)
320 = @args{qw/tag collection_tag methods/};
321 $collection_name ||= "${name}s";
324 if ( $collection_name eq 'comments' ) {
327 $meth = "get_$collection_name";
330 my @kids = $parent->$meth;
332 $xml->startTag( [ $Namespace => $collection_name ] );
334 for my $obj ( @kids ) {
335 if ( $collection_name eq 'comments' ){
336 $xml->dataElement( [ $Namespace => 'comment' ], $obj );
345 $xml->endTag( [ $Namespace => $collection_name ] );
349 # Takes an XML::Writer, Schema::* object and list of method names
350 # and writes the obect out as XML. All methods values are written as attributes
351 # except for the methods listed in @MAP_AS_ELEMENTS which get written as child
354 # The attributes/tags are written in the same order as the method names are
358 # - Should the Namespace be passed in instead of global? Pass in the same
359 # as Writer ie [ NS => TAGNAME ]
361 my $elements_re = join("|", @MAP_AS_ELEMENTS);
362 $elements_re = qr/^($elements_re)$/;
364 my ($xml, $obj, %args) = @_;
365 my $tag = $args{'tag'} || '';
366 my $end_tag = $args{'end_tag'} || '';
367 my @meths = @{ $args{'methods'} };
370 # Use array to ensure consistant (ie not hash) ordering of attribs
371 # The order comes from the meths list passed in.
374 foreach ( grep { defined $obj->$_ } @meths ) {
375 my $what = m/$elements_re/ ? \@tags : \@attr;
376 my $val = $_ eq 'extra'
379 $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
380 push @$what, $_ => $val;
382 my $child_tags = @tags;
383 $end_tag && !$child_tags
384 ? $xml->emptyTag( [ $Namespace => $tag ], @attr )
385 : $xml->startTag( [ $Namespace => $tag ], @attr );
386 while ( my ($name,$val) = splice @tags,0,2 ) {
387 if ( ref $val eq 'HASH' ) {
388 $xml->emptyTag( [ $Namespace => $name ],
389 map { ($_, $val->{$_}) } sort keys %$val );
392 $xml->dataElement( [ $Namespace => $name ], $val );
395 $xml->endTag( [ $Namespace => $tag ] ) if $child_tags && $end_tag;
400 # -------------------------------------------------------------------
401 # The eyes of fire, the nostrils of air,
402 # The mouth of water, the beard of earth.
404 # -------------------------------------------------------------------
410 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
411 Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
412 Mark Addison E<lt>mark.addison@itn.co.ukE<gt>.
416 L<perl(1)>, L<SQL::Translator>, L<SQL::Translator::Parser::XML::SQLFairy>,
417 L<SQL::Translator::Schema>, L<XML::Writer>.