1 package SQL::Translator::Producer::XML::SQLFairy;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
5 # darren chamberlain <darren@cpan.org>,
6 # Chris Mungall <cjm@fruitfly.org>,
7 # Mark Addison <mark.addison@itn.co.uk>.
9 # This program is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU General Public License as
11 # published by the Free Software Foundation; version 2.
13 # This program is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 # General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
22 # -------------------------------------------------------------------
28 SQL::Translator::Producer::XML::SQLFairy - SQLFairy's default XML format
34 my $t = SQL::Translator->new(
37 filename => 'schema.sql',
45 Creates XML output of a schema, in the flavor of XML used natively by the
46 SQLFairy project (L<SQL::Translator>). This format is detailed here.
48 The XML lives in the C<http://sqlfairy.sourceforge.net/sqlfairy.xml> namespace.
49 With a root element of <schema>.
51 Objects in the schema are mapped to tags of the same name as the objects class
54 The attributes of the objects (e.g. $field->name) are mapped to attributes of
55 the tag, except for sql, comments and action, which get mapped to child data
58 List valued attributes (such as the list of fields in an index)
59 get mapped to comma seperated lists of values in the attribute.
61 Child objects, such as a tables fields, get mapped to child tags wrapped in a
62 set of container tags using the plural of their contained classes name.
64 An objects's extra attribute (a hash of arbitary data) is
65 mapped to a tag called extra, with the hash of data as attributes, sorted into
70 <schema name="" database=""
71 xmlns="http://sqlfairy.sourceforge.net/sqlfairy.xml">
74 <table name="Story" order="1">
76 <field name="id" data_type="BIGINT" size="20"
77 is_nullable="0" is_auto_increment="1" is_primary_key="1"
78 is_foreign_key="0" order="3">
79 <extra ZEROFILL="1" />
82 <field name="created" data_type="datetime" size="0"
83 is_nullable="1" is_auto_increment="0" is_primary_key="0"
84 is_foreign_key="0" order="1">
91 <index name="foobar" type="NORMAL" fields="foo,bar" options="" />
97 <view name="email_list" fields="email" order="1">
98 <sql>SELECT email FROM Basic WHERE email IS NOT NULL</sql>
104 To see a complete example of the XML translate one of your schema :)
106 $ sqlt -f MySQL -t XML-SQLFairy schema.sql
114 Set to true to use the default namespace prefix of 'sqlf', instead of using
115 the default namespace for
116 C<http://sqlfairy.sourceforge.net/sqlfairy.xml namespace>
120 <!-- add_prefix=0 -->
123 <!-- add_prefix=1 -->
124 <sqlf:field name="foo" />
128 Set to the namespace prefix you want to use for the
129 C<http://sqlfairy.sourceforge.net/sqlfairy.xml namespace>
133 <!-- prefix='foo' -->
134 <foo:field name="foo" />
138 If true (the default) inserts newlines around the XML, otherwise the schema is
143 When using newlines the number of whitespace characters to use as the indent.
144 Default is 2, set to 0 to turn off indenting.
150 The previous version of the SQLFairy XML allowed the attributes of the the
151 schema objects to be written as either xml attributes or as data elements, in
152 any combination. The old producer could produce attribute only or data element
153 only versions. While this allowed for lots of flexibility in writing the XML
154 the result is a great many possible XML formats, not so good for DTD writing,
155 XPathing etc! So we have moved to a fixed version described above.
157 This version of the producer will now only produce the new style XML.
158 To convert your old format files simply pass them through the translator :)
160 $ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml
165 use vars qw[ $VERSION @EXPORT_OK ];
169 use base qw(Exporter);
170 @EXPORT_OK = qw(produce);
173 use SQL::Translator::Utils qw(header_comment debug);
175 # Will someone fix XML::Writer already?
181 # Which schema object attributes (methods) to write as xml elements rather than
182 # as attributes. e.g. <comments>blah, blah...</comments>
183 my @MAP_AS_ELEMENTS = qw/sql comments action extra/;
187 my $Namespace = 'http://sqlfairy.sourceforge.net/sqlfairy.xml';
192 my $translator = shift;
193 my $schema = $translator->schema;
194 $PArgs = $translator->producer_args;
195 my $newlines = defined $PArgs->{newlines} ? $PArgs->{newlines} : 1;
196 my $indent = defined $PArgs->{indent} ? $PArgs->{indent} : 2;
197 my $io = IO::Scalar->new;
199 # Setup the XML::Writer and set the namespace
201 $prefix = $Name if $PArgs->{add_prefix};
202 $prefix = $PArgs->{prefix} if $PArgs->{prefix};
203 my $xml = XML::Writer->new(
206 PREFIX_MAP => { $Namespace => $prefix },
207 DATA_MODE => $newlines,
208 DATA_INDENT => $indent,
212 $xml->xmlDecl('UTF-8');
213 $xml->comment(header_comment('', ''));
214 xml_obj($xml, $schema,
215 tag => "schema", methods => [qw/name database extra/], end_tag => 0 );
220 $xml->startTag( [ $Namespace => "tables" ] );
221 for my $table ( $schema->get_tables ) {
222 debug "Table:",$table->name;
223 xml_obj($xml, $table,
225 methods => [qw/name order extra/],
232 xml_obj_children( $xml, $table,
235 name data_type size is_nullable default_value is_auto_increment
236 is_primary_key is_foreign_key extra comments order
243 xml_obj_children( $xml, $table,
245 collection_tag => "indices",
246 methods => [qw/name type fields options extra/],
252 xml_obj_children( $xml, $table,
255 name type fields reference_table reference_fields
256 on_delete on_update match_type expression options deferrable
264 xml_obj_children( $xml, $table,
266 collection_tag => "comments",
272 $xml->endTag( [ $Namespace => 'table' ] );
274 $xml->endTag( [ $Namespace => 'tables' ] );
279 xml_obj_children( $xml, $schema,
281 methods => [qw/name sql fields order extra/],
287 xml_obj_children( $xml, $schema,
289 methods => [qw/name database_event action on_table perform_action_when
290 fields order extra/],
296 xml_obj_children( $xml, $schema,
298 methods => [qw/name sql parameters owner comments order extra/],
301 $xml->endTag([ $Namespace => 'schema' ]);
309 # Takes and XML::Write object, Schema::* parent object, the tag name,
310 # the collection name and a list of methods (of the children) to write as XML.
311 # The collection name defaults to the name with an s on the end and is used to
312 # work out the method to get the children with. eg a name of 'foo' gives a
313 # collection of foos and gets the members using ->get_foos.
315 sub xml_obj_children {
316 my ($xml,$parent) = (shift,shift);
318 my ($name,$collection_name,$methods)
319 = @args{qw/tag collection_tag methods/};
320 $collection_name ||= "${name}s";
323 if ( $collection_name eq 'comments' ) {
326 $meth = "get_$collection_name";
329 my @kids = $parent->$meth;
331 $xml->startTag( [ $Namespace => $collection_name ] );
333 for my $obj ( @kids ) {
334 if ( $collection_name eq 'comments' ){
335 $xml->dataElement( [ $Namespace => 'comment' ], $obj );
344 $xml->endTag( [ $Namespace => $collection_name ] );
348 # Takes an XML::Writer, Schema::* object and list of method names
349 # and writes the obect out as XML. All methods values are written as attributes
350 # except for the methods listed in @MAP_AS_ELEMENTS which get written as child
353 # The attributes/tags are written in the same order as the method names are
357 # - Should the Namespace be passed in instead of global? Pass in the same
358 # as Writer ie [ NS => TAGNAME ]
360 my $elements_re = join("|", @MAP_AS_ELEMENTS);
361 $elements_re = qr/^($elements_re)$/;
363 my ($xml, $obj, %args) = @_;
364 my $tag = $args{'tag'} || '';
365 my $end_tag = $args{'end_tag'} || '';
366 my @meths = @{ $args{'methods'} };
369 # Use array to ensure consistant (ie not hash) ordering of attribs
370 # The order comes from the meths list passed in.
373 foreach ( grep { defined $obj->$_ } @meths ) {
374 my $what = m/$elements_re/ ? \@tags : \@attr;
375 my $val = $_ eq 'extra'
378 $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
379 push @$what, $_ => $val;
381 my $child_tags = @tags;
382 $end_tag && !$child_tags
383 ? $xml->emptyTag( [ $Namespace => $tag ], @attr )
384 : $xml->startTag( [ $Namespace => $tag ], @attr );
385 while ( my ($name,$val) = splice @tags,0,2 ) {
386 if ( ref $val eq 'HASH' ) {
387 $xml->emptyTag( [ $Namespace => $name ],
388 map { ($_, $val->{$_}) } sort keys %$val );
391 $xml->dataElement( [ $Namespace => $name ], $val );
394 $xml->endTag( [ $Namespace => $tag ] ) if $child_tags && $end_tag;
399 # -------------------------------------------------------------------
400 # The eyes of fire, the nostrils of air,
401 # The mouth of water, the beard of earth.
403 # -------------------------------------------------------------------
409 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
410 Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
411 Mark Addison E<lt>mark.addison@itn.co.ukE<gt>.
415 L<perl(1)>, L<SQL::Translator>, L<SQL::Translator::Parser::XML::SQLFairy>,
416 L<SQL::Translator::Schema>, L<XML::Writer>.