1 package SQL::Translator::Producer::XML;
3 # -------------------------------------------------------------------
4 # $Id: XML.pm,v 1.6 2003-04-25 11:47:25 dlc Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7 # darren chamberlain <darren@cpan.org>,
8 # Chris Mungall <cjm@fruitfly.org>
10 # This program is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU General Public License as
12 # published by the Free Software Foundation; version 2.
14 # This program is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program; if not, write to the Free Software
21 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
23 # -------------------------------------------------------------------
26 use vars qw[ $VERSION $XML ];
27 $VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
29 use SQL::Translator::Utils qw(header_comment);
31 # -------------------------------------------------------------------
33 my ( $translator, $data ) = @_;
34 my $prargs = $translator->producer_args;
36 aggregate('<?xml version="1.0"?>', $indent);
37 aggregate('<schema>', $indent);
38 aggregate('<!-- ' . header_comment('', '') . '-->');
43 sort { $a->[0] <=> $b->[0] }
44 map { [ $_->{'order'}, $_ ] }
47 aggregate( '<table>', $indent );
50 aggregate( "<name>$table->{'table_name'}</name>", $indent );
51 aggregate( "<order>$table->{'order'}</order>", $indent );
56 aggregate( '<fields>', $indent );
59 sort { $a->[0] <=> $b->[0] }
60 map { [ $_->{'order'}, $_ ] }
61 values %{ $table->{'fields'} }
63 aggregate( '<field>', ++$indent );
66 for my $key ( keys %$field ) {
67 my $val = defined $field->{ $key } ? $field->{ $key } : '';
68 $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
69 aggregate("<$key>$val</$key>", $indent)
70 if ($val || (!$val && $prargs->{'emit_empty_tags'}));
74 aggregate("</field>", $indent--);
76 aggregate( "</fields>", $indent );
81 aggregate( '<indices>', $indent );
82 for my $index ( @{ $table->{'indices'} } ) {
83 aggregate( '<index>', ++$indent );
86 for my $key ( keys %$index ) {
87 my $val = defined $index->{ $key } ? $index->{ $key } : '';
88 $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
89 aggregate( "<$key>$val</$key>", $indent );
93 aggregate( "</index>", $indent-- );
95 aggregate( "</indices>", $indent );
98 aggregate( "</table>", $indent );
102 aggregate( '</schema>', $indent );
107 # -------------------------------------------------------------------
109 my ( $text, $indent ) = @_;
110 $XML .= (' ' x $indent) . "$text\n";
116 # -------------------------------------------------------------------
117 # The eyes of fire, the nostrils of air,
118 # The mouth of water, the beard of earth.
120 # -------------------------------------------------------------------
124 SQL::Translator::Producer::XML - XML output
128 use SQL::Translator::Producer::XML;
132 Meant to create some sort of usable XML output.
136 Takes the following optional C<producer_args>:
140 =item emit_empty_tags
142 If this is set to a true value, then tags corresponding to value-less
143 elements will be emitted. For example, take this schema:
145 CREATE TABLE random (
146 id int auto_increment PRIMARY KEY,
147 foo varchar(255) not null default '',
151 With C<emit_empty_tags> = 1, this will be dumped with XML similar to:
158 <is_auto_inc>1</is_auto_inc>
160 <is_primary_key>1</is_primary_key>
161 <data_type>int</data_type>
163 <constraints></constraints>
170 With C<emit_empty_tags> = 0, you'd get:
177 <is_auto_inc>1</is_auto_inc>
178 <is_primary_key>1</is_primary_key>
179 <data_type>int</data_type>
186 This can lead to dramatic size savings.
194 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>