package SQL::Translator;
# ----------------------------------------------------------------------
-# $Id: Translator.pm,v 1.26 2003-05-09 16:51:47 kycl4rk Exp $
+# $Id: Translator.pm,v 1.42 2003-08-21 18:12:56 kycl4rk Exp $
# ----------------------------------------------------------------------
# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
# darren chamberlain <darren@cpan.org>,
use vars qw( $VERSION $REVISION $DEFAULT_SUB $DEBUG $ERROR );
use base 'Class::Base';
-$VERSION = '0.01';
-$REVISION = sprintf "%d.%02d", q$Revision: 1.26 $ =~ /(\d+)\.(\d+)/;
+require 5.004;
+
+$VERSION = '0.02';
+$REVISION = sprintf "%d.%02d", q$Revision: 1.42 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
$ERROR = "";
use Carp qw(carp);
+use Data::Dumper;
+use Class::Base;
use File::Spec::Functions qw(catfile);
use File::Basename qw(dirname);
use IO::Dir;
# SQL::Translator instance is the first value ($_[0]), and the stuff
# to be parsed is the second value ($_[1])
# ----------------------------------------------------------------------
-$DEFAULT_SUB = sub { $_[1] } unless defined $DEFAULT_SUB;
+$DEFAULT_SUB = sub { $_[0]->schema } unless defined $DEFAULT_SUB;
# ----------------------------------------------------------------------
# init([ARGS])
# ----------------------------------------------------------------------
sub init {
my ( $self, $config ) = @_;
-
#
# Set the parser and producer.
#
$self->add_drop_table( $config->{'add_drop_table'} );
- $self->custom_translate( $config->{'xlate'} );
-
$self->no_comments( $config->{'no_comments'} );
$self->show_warnings( $config->{'show_warnings'} );
$self->trace( $config->{'trace'} );
+ $self->validate( $config->{'validate'} );
+
return $self;
}
return $self->{'add_drop_table'} || 0;
}
-
-# ----------------------------------------------------------------------
-# custom_translate([$bool])
-# ----------------------------------------------------------------------
-sub custom_translate {
- my $self = shift;
- $self->{'custom_translate'} = shift if @_;
- return $self->{'custom_translate'} || {};
-}
-
# ----------------------------------------------------------------------
# no_comments([$bool])
# ----------------------------------------------------------------------
# passed a string containing no "::"; relative package name
else {
+ $producer =~ s/-/::/g;
my $Pp = sprintf "SQL::Translator::Producer::$producer";
load($Pp) or die "Can't load $Pp: $@";
$self->{'producer'} = \&{ "$Pp\::produce" };
# passed a string containing no "::"; relative package name
else {
+ $parser =~ s/-/::/g;
my $Pp = "SQL::Translator::Parser::$parser";
load( $Pp ) or die "Can't load $Pp: $@";
$self->{'parser'} = \&{ "$Pp\::parse" };
}
# ----------------------------------------------------------------------
+sub reset {
+#
+# Deletes the existing Schema object so that future calls to translate
+# don't append to the existing.
+#
+ my $self = shift;
+ $self->{'schema'} = undef;
+ return 1;
+}
+
+# ----------------------------------------------------------------------
sub schema {
#
# Returns the SQL::Translator::Schema object
# the future, each of these might happen in a Safe environment,
# depending on how paranoid we want to be.
# ----------------------------------------------------------------
- my $schema = $self->schema;
- eval { $parser_output = $parser->($self, $$data, $schema) };
- if ($@ || ! $parser_output) {
- my $msg = sprintf "translate: Error with parser '%s': %s",
- $parser_type, ($@) ? $@ : " no results";
- return $self->error($msg);
+ unless ( defined $self->{'schema'} ) {
+ eval { $parser_output = $parser->($self, $$data) };
+ if ($@ || ! $parser_output) {
+ my $msg = sprintf "translate: Error with parser '%s': %s",
+ $parser_type, ($@) ? $@ : " no results";
+ return $self->error($msg);
+ }
+ }
+
+ $self->debug("Schema =\n", Dumper($self->schema), "\n");
+
+ if ($self->validate) {
+ my $schema = $self->schema;
+ return $self->error('Invalid schema') unless $schema->is_valid;
}
- eval { $producer_output = $producer->($self, $parser_output, $schema) };
+ eval { $producer_output = $producer->($self) };
if ($@ || ! $producer_output) {
my $msg = sprintf "translate: Error with producer '%s': %s",
$producer_type, ($@) ? $@ : " no results";
$self->{$type};
}
-
# ----------------------------------------------------------------------
# _list($type)
# ----------------------------------------------------------------------
my $path = catfile "SQL", "Translator", $uctype;
for (@INC) {
my $dir = catfile $_, $path;
- $self->debug("_list_${type}s searching $dir");
+ $self->debug("_list_${type}s searching $dir\n");
next unless -d $dir;
my $dh = IO::Dir->new($dir);
return 1;
}
+# ----------------------------------------------------------------------
sub format_table_name {
- my $self = shift;
- my $sub = shift;
- $self->{'_format_table_name'} = $sub if ref $sub eq 'CODE';
- return $self->{'_format_table_name'}->( $sub, @_ )
- if defined $self->{'_format_table_name'};
- return $sub;
+ return shift->_format_name('_format_table_name', @_);
}
+# ----------------------------------------------------------------------
sub format_package_name {
- my $self = shift;
- my $sub = shift;
- $self->{'_format_package_name'} = $sub if ref $sub eq 'CODE';
- return $self->{'_format_package_name'}->( $sub, @_ )
- if defined $self->{'_format_package_name'};
- return $sub;
+ return shift->_format_name('_format_package_name', @_);
}
+# ----------------------------------------------------------------------
sub format_fk_name {
- my $self = shift;
- my $sub = shift;
- $self->{'_format_fk_name'} = $sub if ref $sub eq 'CODE';
- return $self->{'_format_fk_name'}->( $sub, @_ )
- if defined $self->{'_format_fk_name'};
- return $sub;
+ return shift->_format_name('_format_fk_name', @_);
}
+# ----------------------------------------------------------------------
sub format_pk_name {
+ return shift->_format_name('_format_pk_name', @_);
+}
+
+# ----------------------------------------------------------------------
+# The other format_*_name methods rely on this one. It optionally
+# accepts a subroutine ref as the first argument (or uses an identity
+# sub if one isn't provided or it doesn't already exist), and applies
+# it to the rest of the arguments (if any).
+# ----------------------------------------------------------------------
+sub _format_name {
my $self = shift;
- my $sub = shift;
- $self->{'_format_pk_name'} = $sub if ref $sub eq 'CODE';
- return $self->{'_format_pk_name'}->( $sub, @_ )
- if defined $self->{'_format_pk_name'};
- return $sub;
+ my $field = shift;
+ my @args = @_;
+
+ if (ref($args[0]) eq 'CODE') {
+ $self->{$field} = shift @args;
+ }
+ elsif (! exists $self->{$field}) {
+ $self->{$field} = sub { return shift };
+ }
+
+ return @args ? $self->{$field}->(@args) : $self->{$field};
}
# ----------------------------------------------------------------------
return UNIVERSAL::isa($ref, $type);
}
+# ----------------------------------------------------------------------
+sub validate {
+ my ( $self, $arg ) = @_;
+ if ( defined $arg ) {
+ $self->{'validate'} = $arg ? 1 : 0;
+ }
+ return $self->{'validate'} || 0;
+}
+
1;
-#-----------------------------------------------------
-# Rescue the drowning and tie your shoestrings.
-# Henry David Thoreau
-#-----------------------------------------------------
-__END__
+# ----------------------------------------------------------------------
+# Who killed the pork chops?
+# What price bananas?
+# Are you my Angel?
+# Allen Ginsberg
+# ----------------------------------------------------------------------
+
+=pod
=head1 NAME
-SQL::Translator - convert schema from one database to another
+SQL::Translator - manipulate structured data definitions (SQL and more)
=head1 SYNOPSIS
use SQL::Translator;
- my $translator = SQL::Translator->new(
- debug => 1, # Print debug info
- trace => 0, # Print Parse::RecDescent trace
- no_comments => 0, # Don't include comments in output
- show_warnings => 0, # Print name mutations, conflicts
- add_drop_table => 1, # Add "drop table" statements
-
+ my $translator = SQL::Translator->new(
+ # Print debug info
+ debug => 1,
+ # Print Parse::RecDescent trace
+ trace => 0,
+ # Don't include comments in output
+ no_comments => 0,
+ # Print name mutations, conflicts
+ show_warnings => 0,
+ # Add "drop table" statements
+ add_drop_table => 1,
+ # Validate schema object
+ validate => 1,
# Make all table names CAPS in producers which support this option
- format_table_name => sub {my $tablename = shift; return uc($tablename)},
-
+ format_table_name => sub {my $tablename = shift; return uc($tablename)},
# Null-op formatting, only here for documentation's sake
format_package_name => sub {return shift},
format_fk_name => sub {return shift},
);
my $output = $translator->translate(
- from => "MySQL",
- to => "Oracle",
+ from => 'MySQL',
+ to => 'Oracle',
# Or an arrayref of filenames, i.e. [ $file1, $file2, $file3 ]
filename => $file,
) or die $translator->error;
=head1 DESCRIPTION
-This module attempts to simplify the task of converting one database
-create syntax to another through the use of Parsers (which understand
-the source format) and Producers (which understand the destination
-format). The idea is that any Parser can be used with any Producer in
-the conversion process. So, if you wanted Postgres-to-Oracle, you
-would use the Postgres parser and the Oracle producer.
+SQL::Translator is a group of Perl modules that converts
+vendor-specific SQL table definitions into other formats, such as
+other vendor-specific SQL, ER diagrams, documentation (POD and HTML),
+XML, and Class::DBI classes. The main focus of SQL::Translator is
+SQL, but parsers exist for other structured data formats, including
+Excel spreadsheets and arbitrarily delimited text files. Through the
+separation of the code into parsers and producers with an object model
+in between, it's possible to combine any parser with any producer, to
+plug in custom parsers or producers, or to manipulate the parsed data
+via the built-in object model. Presently only the definition parts of
+SQL are handled (CREATE, ALTER), not the manipulation of data (INSERT,
+UPDATE, DELETE).
=head1 CONSTRUCTOR
debug
+=item *
+
+add_drop_table
+
+=item *
+
+no_comments
+
+=item *
+
+trace
+
+=item *
+
+validate
+
=back
All options are, well, optional; these attributes can be set via
Toggles whether or not to add "DROP TABLE" statements just before the
create definitions.
-=head2 custom_translate
-
-Allows the user to override default translation of fields. For example,
-if a MySQL "text" field would normally be converted to a "long" for Oracle,
-the user could specify to change it to a "CLOB." Accepts a hashref where
-keys are the "from" value and values are the "to," returns the current
-value of the field.
-
=head2 no_comments
Toggles whether to print comments in the output. Accepts a true or false
the C<translate> method is called, as long as the data instance
variable is not set.
-=pod
-
=head2 schema
Returns the SQL::Translator::Schema object.
Turns on/off the tracing option of Parse::RecDescent.
-=pod
+=head2 validate
+
+Whether or not to validate the schema object after parsing and before
+producing.
=head1 AUTHORS
-Ken Y. Clark, E<lt>kclark@cpan.orgE<gt>,
-darren chamberlain E<lt>darren@cpan.orgE<gt>,
-Chris Mungall E<lt>cjm@fruitfly.orgE<gt>,
-Allen Day E<lt>allenday@users.sourceforge.netE<gt>
+The following people have contributed to the SQLFairy project:
+
+=over 4
+
+=item * Mark Addison <grommit@users.sourceforge.net>
+
+=item * Sam Angiuoli <angiuoli@users.sourceforge.net>
+
+=item * Darren Chamberlain <dlc@users.sourceforge.net>
+
+=item * Ken Y. Clark <kclark@cpan.org>
+
+=item * Allen Day <allenday@users.sourceforge.net>
+
+=item * Paul Harrington <phrrngtn@users.sourceforge.net>
+
+=item * Mikey Melillo <mmelillo@users.sourceforge.net>
+
+=item * Chris Mungall <cjm@fruitfly.org>
+
+=item * Ross Smith II <rossta@users.sf.net>
+
+=item * Gudmundur A. Thorisson <mummi@cshl.org>
+
+=item * Chris To <christot@users.sourceforge.net>
+
+=item * Jason Williams <smdwilliams@users.sourceforge.net>
+
+=item * Ying Zhang <zyolive@yahoo.com>
+
+=back
+
+If you would like to contribute to the project, you can send patches
+to the developers mailing list:
+
+ sqlfairy-developers@lists.sourceforge.net
+
+Or send us a message (with your Sourceforge username) asking to be
+added to the project and what you'd like to contribute.
+
=head1 COPYRIGHT
=head1 BUGS
-Please use http://rt.cpan.org/ for reporting bugs.
+Please use L<http://rt.cpan.org/> for reporting bugs.
+
+=head1 PRAISE
+
+If you find this module useful, please use
+L<http://cpanratings.perl.org/rate/?distribution=SQL-Translator> to rate it.
=head1 SEE ALSO
L<perl>,
L<SQL::Translator::Parser>,
L<SQL::Translator::Producer>,
-L<Parse::RecDescent>
-
+L<Parse::RecDescent>,
+L<GD>,
+L<GraphViz>,
+L<Text::RecordParser>,
+L<Class::DBI>,
+L<XML::Writer>.
projects / dbsrgits/SQL-Translator.git / blobdiff