1 package SQL::Translator::Producer::XML::SQLFairy;
3 # -------------------------------------------------------------------
4 # $Id: SQLFairy.pm,v 1.17 2004-08-19 14:09:00 grommit Exp $
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',
48 Creates XML output of a schema, in SQLFairy format XML.
50 The XML lives in the 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.
55 The attributes of the objects (e.g. $field->name) are mapped to attributes of
56 the tag, except for sql, comments and action, which get mapped to child data
59 List valued attributes (such as the list of fields in an index)
60 get mapped to a comma seperated list of values in the attribute.
62 Child objects, such as a tables fields, get mapped to child tags wrapped in a
63 set of container tags using the plural of their contained classes name.
65 L<SQL::Translator::Schema::Field>'s extra attribute (a hash of arbitary data) is
66 mapped to a tag called extra, with the hash of data as attributes, sorted into
71 <schema name="" database=""
72 xmlns="http://sqlfairy.sourceforge.net/sqlfairy.xml">
74 <table name="Story" order="1">
77 <field name="id" data_type="BIGINT" size="20"
78 is_nullable="0" is_auto_increment="1" is_primary_key="1"
79 is_foreign_key="0" order="3">
80 <extra ZEROFILL="1" />
83 <field name="created" data_type="datetime" size="0"
84 is_nullable="1" is_auto_increment="0" is_primary_key="0"
85 is_foreign_key="0" order="1">
93 <index name="foobar" type="NORMAL" fields="foo,bar" options="" />
98 <view name="email_list" fields="email" order="1">
99 <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 ];
166 $VERSION = sprintf "%d.%02d", q$Revision: 1.17 $ =~ /(\d+)\.(\d+)/;
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/], 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/],
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/],
252 xml_obj_children( $xml, $table,
255 name type fields reference_table reference_fields
256 on_delete on_update match_type expression options deferrable
260 $xml->endTag( [ $Namespace => 'table' ] );
262 $xml->endTag( [ $Namespace => 'tables' ] );
267 xml_obj_children( $xml, $schema,
269 methods => [qw/name sql fields order/],
275 xml_obj_children( $xml, $schema,
277 methods => [qw/name database_event action on_table perform_action_when
284 xml_obj_children( $xml, $schema,
286 methods => [qw/name sql parameters owner comments order/],
289 $xml->endTag([ $Namespace => 'schema' ]);
297 # Takes and XML::Write object, Schema::* parent object, the tag name,
298 # the collection name and a list of methods (of the children) to write as XML.
299 # The collection name defaults to the name with an s on the end and is used to
300 # work out the method to get the children with. eg a name of 'foo' gives a
301 # collection of foos and gets the members using ->get_foos.
303 sub xml_obj_children {
304 my ($xml,$parent) = (shift,shift);
306 my ($name,$collection_name,$methods)
307 = @args{qw/tag collection_tag methods/};
308 $collection_name ||= "${name}s";
309 my $meth = "get_$collection_name";
311 my @kids = $parent->$meth;
313 $xml->startTag( [ $Namespace => $collection_name ] );
314 for my $obj ( @kids ) {
321 $xml->endTag( [ $Namespace => $collection_name ] );
325 # Takes an XML::Writer, Schema::* object and list of method names
326 # and writes the obect out as XML. All methods values are written as attributes
327 # except for the methods listed in @MAP_AS_ELEMENTS which get written as child
330 # The attributes/tags are written in the same order as the method names are
334 # - Should the Namespace be passed in instead of global? Pass in the same
335 # as Writer ie [ NS => TAGNAME ]
337 my $elements_re = join("|", @MAP_AS_ELEMENTS);
338 $elements_re = qr/^($elements_re)$/;
340 my ($xml, $obj, %args) = @_;
341 my $tag = $args{'tag'} || '';
342 my $end_tag = $args{'end_tag'} || '';
343 my @meths = @{ $args{'methods'} };
346 # Use array to ensure consistant (ie not hash) ordering of attribs
347 # The order comes from the meths list passed in.
350 foreach ( grep { defined $obj->$_ } @meths ) {
351 my $what = m/$elements_re/ ? \@tags : \@attr;
352 my $val = $_ eq 'extra'
355 $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
356 push @$what, $_ => $val;
358 my $child_tags = @tags;
359 $end_tag && !$child_tags
360 ? $xml->emptyTag( [ $Namespace => $tag ], @attr )
361 : $xml->startTag( [ $Namespace => $tag ], @attr );
362 while ( my ($name,$val) = splice @tags,0,2 ) {
363 if ( ref $val eq 'HASH' ) {
364 $xml->emptyTag( [ $Namespace => $name ],
365 map { ($_, $val->{$_}) } sort keys %$val );
368 $xml->dataElement( [ $Namespace => $name ], $val );
371 $xml->endTag( [ $Namespace => $tag ] ) if $child_tags && $end_tag;
376 # -------------------------------------------------------------------
377 # The eyes of fire, the nostrils of air,
378 # The mouth of water, the beard of earth.
380 # -------------------------------------------------------------------
386 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
387 Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
388 Mark Addison E<lt>mark.addison@itn.co.ukE<gt>.
392 perl(1), SQL::Translator, SQL::Translator::Parser::XML::SQLFairy,
393 SQL::Translator::Schema, XML::Writer.