package SQL::Translator::Producer::XML;
# -------------------------------------------------------------------
-# $Id: XML.pm,v 1.9 2003-06-09 02:01:23 kycl4rk Exp $
-# -------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>,
-# Chris Mungall <cjm@fruitfly.org>
+# Copyright (C) 2002-2009 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# 02111-1307 USA
# -------------------------------------------------------------------
-use strict;
-use vars qw[ $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.9 $ =~ /(\d+)\.(\d+)/;
-
-use IO::Scalar;
-use SQL::Translator::Utils qw(header_comment);
-use XML::Writer;
-
-my $sqlf_ns = 'http://sqlfairy.sourceforge.net/sqlfairy.xml';
-
-# -------------------------------------------------------------------
-sub produce {
- my ( $translator, $data ) = @_;
- my $schema = $translator->schema;
- my $args = $translator->producer_args;
-
- my $io = IO::Scalar->new;
- my $xml = XML::Writer->new(
- OUTPUT => $io,
- NAMESPACES => 1,
- PREFIX_MAP => { $sqlf_ns => 'sqlf' },
- DATA_MODE => 1,
- DATA_INDENT => 2,
- );
-
- $xml->xmlDecl('UTF-8');
- $xml->comment(header_comment('', ''));
- $xml->startTag([ $sqlf_ns => 'schema' ]);
-
- for my $table ( $schema->get_tables ) {
- my $table_name = $table->name or next;
- $xml->startTag ( [ $sqlf_ns => 'table' ] );
- $xml->dataElement( [ $sqlf_ns => 'name' ], $table_name );
- $xml->dataElement( [ $sqlf_ns => 'order' ], $table->order );
-
- #
- # Fields
- #
- $xml->startTag( [ $sqlf_ns => 'fields' ] );
- for my $field ( $table->get_fields ) {
- $xml->startTag( [ $sqlf_ns => 'field' ] );
-
- for my $method (
- qw[
- name data_type default_value is_auto_increment
- is_primary_key is_nullable is_foreign_key order size
- ]
- ) {
- my $val = $field->$method || '';
- $xml->dataElement( [ $sqlf_ns => $method ], $val )
- if ( defined $val ||
- ( !defined $val && $args->{'emit_empty_tags'} ) );
- }
-
- $xml->endTag( [ $sqlf_ns => 'field' ] );
- }
-
- $xml->endTag( [ $sqlf_ns => 'fields' ] );
-
- #
- # Indices
- #
- $xml->startTag( [ $sqlf_ns => 'indices' ] );
- for my $index ( $table->get_indices ) {
- $xml->startTag( [ $sqlf_ns => 'index' ] );
-
- for my $method ( qw[ fields name options type ] ) {
- my $val = $index->$method || '';
- $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
- $xml->dataElement( [ $sqlf_ns => $method ], $val )
- if ( defined $val ||
- ( !defined $val && $args->{'emit_empty_tags'} ) );
- }
-
- $xml->endTag( [ $sqlf_ns => 'index' ] );
- }
- $xml->endTag( [ $sqlf_ns => 'indices' ] );
-
- #
- # Constraints
- #
- $xml->startTag( [ $sqlf_ns => 'constraints' ] );
- for my $index ( $table->get_constraints ) {
- $xml->startTag( [ $sqlf_ns => 'constraint' ] );
-
- for my $method (
- qw[
- deferrable expression fields match_type name
- options on_delete on_update reference_fields
- reference_table type
- ]
- ) {
- my $val = $index->$method || '';
- $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
- $xml->dataElement( [ $sqlf_ns => $method ], $val )
- if ( defined $val ||
- ( !defined $val && $args->{'emit_empty_tags'} ) );
- }
-
- $xml->endTag( [ $sqlf_ns => 'constraint' ] );
- }
- $xml->endTag( [ $sqlf_ns => 'constraints' ] );
-
- $xml->endTag( [ $sqlf_ns => 'table' ] );
- }
-
- $xml->endTag([ $sqlf_ns => 'schema' ]);
- $xml->end;
-
- return $io;
-}
-
-1;
-
-# -------------------------------------------------------------------
-# The eyes of fire, the nostrils of air,
-# The mouth of water, the beard of earth.
-# William Blake
-# -------------------------------------------------------------------
+=pod
=head1 NAME
-SQL::Translator::Producer::XML - XML output
-
-=head1 SYNOPSIS
-
- use SQL::Translator::Producer::XML;
+SQL::Translator::Producer::XML - Alias to XML::SQLFairy producer
=head1 DESCRIPTION
-Meant to create some sort of usable XML output.
-
-=head1 ARGS
-
-Takes the following optional C<producer_args>:
+Previous versions of SQL::Translator included an XML producer, but the
+namespace has since been further subdivided. Therefore, this module is
+now just just an alias to the XML::SQLFairy producer.
-=over 4
-
-=item emit_empty_tags
-
-If this is set to a true value, then tags corresponding to value-less
-elements will be emitted. For example, take this schema:
-
- CREATE TABLE random (
- id int auto_increment PRIMARY KEY,
- foo varchar(255) not null default '',
- updated timestamp
- );
-
-With C<emit_empty_tags> = 1, this will be dumped with XML similar to:
-
- <table>
- <name>random</name>
- <order>1</order>
- <fields>
- <field>
- <is_auto_inc>1</is_auto_inc>
- <list></list>
- <is_primary_key>1</is_primary_key>
- <data_type>int</data_type>
- <name>id</name>
- <constraints></constraints>
- <null>1</null>
- <order>1</order>
- <size></size>
- <type>field</type>
- </field>
-
-With C<emit_empty_tags> = 0, you'd get:
+=head1 SEE ALSO
- <table>
- <name>random</name>
- <order>1</order>
- <fields>
- <field>
- <is_auto_inc>1</is_auto_inc>
- <is_primary_key>1</is_primary_key>
- <data_type>int</data_type>
- <name>id</name>
- <null>1</null>
- <order>1</order>
- <type>field</type>
- </field>
+SQL::Translator::Producer::XML::SQLFairy.
-This can lead to dramatic size savings.
+=head1 AUTHOR
-=back
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
-=pod
+=cut
-=head1 AUTHOR
+# -------------------------------------------------------------------
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+use strict;
+use vars qw[ $VERSION $DEBUG ];
+$VERSION = '1.59';
+$DEBUG = 1 unless defined $DEBUG;
-=head1 SEE ALSO
+use SQL::Translator::Producer::XML::SQLFairy;
-XML::Dumper;
+*produce = \&SQL::Translator::Producer::XML::SQLFairy::produce;
-=cut
+1;
projects / dbsrgits/SQL-Translator.git / blobdiff