X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator.pm;h=08a129579e9888366429e1f081db088c3ef80d2f;hb=ede3a3eff20681c8b3dcdb34ec28a5381ef1e776;hp=f99a4fcd8c0d2becacc5492b5a9112a160bc7110;hpb=5760246dbd9b3e03521df51b88801a3363fcf9da;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator.pm b/lib/SQL/Translator.pm index f99a4fc..08a1295 100644 --- a/lib/SQL/Translator.pm +++ b/lib/SQL/Translator.pm @@ -1,7 +1,7 @@ package SQL::Translator; # ---------------------------------------------------------------------- -# $Id: Translator.pm,v 1.25 2003-05-06 12:44:54 dlc Exp $ +# $Id: Translator.pm,v 1.37 2003-07-31 20:49:42 dlc Exp $ # ---------------------------------------------------------------------- # Copyright (C) 2003 Ken Y. Clark , # darren chamberlain , @@ -26,23 +26,27 @@ use strict; use vars qw( $VERSION $REVISION $DEFAULT_SUB $DEBUG $ERROR ); use base 'Class::Base'; -$VERSION = '0.01'; -$REVISION = sprintf "%d.%02d", q$Revision: 1.25 $ =~ /(\d+)\.(\d+)/; +require 5.004; + +$VERSION = '0.02'; +$REVISION = sprintf "%d.%02d", q$Revision: 1.37 $ =~ /(\d+)\.(\d+)/; $DEBUG = 0 unless defined $DEBUG; $ERROR = ""; use Carp qw(carp); +use Class::Base; use File::Spec::Functions qw(catfile); use File::Basename qw(dirname); use IO::Dir; +use SQL::Translator::Schema; # ---------------------------------------------------------------------- # The default behavior is to "pass through" values (note that the # 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]) @@ -59,7 +63,6 @@ $DEFAULT_SUB = sub { $_[1] } unless defined $DEFAULT_SUB; # ---------------------------------------------------------------------- sub init { my ( $self, $config ) = @_; - # # Set the parser and producer. # @@ -106,14 +109,14 @@ sub init { $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; } @@ -128,16 +131,6 @@ sub add_drop_table { 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]) # ---------------------------------------------------------------------- @@ -412,7 +405,21 @@ sub data { return $self->{'data'}; } +# ---------------------------------------------------------------------- +sub schema { +# +# Returns the SQL::Translator::Schema object +# + my $self = shift; + unless ( defined $self->{'schema'} ) { + $self->{'schema'} = SQL::Translator::Schema->new; + } + + return $self->{'schema'}; +} + +# ---------------------------------------------------------------------- sub trace { my $self = shift; my $arg = shift; @@ -542,7 +549,12 @@ sub translate { return $self->error($msg); } - eval { $producer_output = $producer->($self, $parser_output) }; + if ($self->validate) { + my $schema = $self->schema; + return $self->error('Invalid schema') unless $schema->is_valid; + } + + eval { $producer_output = $producer->($self) }; if ($@ || ! $producer_output) { my $msg = sprintf "translate: Error with producer '%s': %s", $producer_type, ($@) ? $@ : " no results"; @@ -621,7 +633,6 @@ sub _args { $self->{$type}; } - # ---------------------------------------------------------------------- # _list($type) # ---------------------------------------------------------------------- @@ -635,7 +646,7 @@ sub _list { 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); @@ -666,6 +677,7 @@ sub load { return 1; } +# ---------------------------------------------------------------------- sub format_table_name { my $self = shift; my $sub = shift; @@ -675,6 +687,7 @@ sub format_table_name { return $sub; } +# ---------------------------------------------------------------------- sub format_package_name { my $self = shift; my $sub = shift; @@ -684,22 +697,49 @@ sub format_package_name { return $sub; } +# ---------------------------------------------------------------------- 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; + + if ( ref $_[0] eq 'CODE' ) { + $self->{'_format_pk_name'} = shift; + } + + if ( @_ ) { + if ( defined $self->{'_format_pk_name'} ) { + return $self->{'_format_pk_name'}->( @_ ); + } + else { + return ''; + } + } + + return $self->{'_format_pk_name'}; +# 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; } +# ---------------------------------------------------------------------- sub format_pk_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; + + if ( ref $_[0] eq 'CODE' ) { + $self->{'_format_pk_name'} = shift; + } + + if ( @_ ) { + if ( defined $self->{'_format_pk_name'} ) { + return $self->{'_format_pk_name'}->( @_ ); + } + else { + return ''; + } + } + + return $self->{'_format_pk_name'}; } # ---------------------------------------------------------------------- @@ -713,32 +753,49 @@ sub isa($$) { 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}, @@ -746,8 +803,8 @@ SQL::Translator - convert schema from one database to another ); 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; @@ -756,12 +813,18 @@ SQL::Translator - convert schema from one database to another =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 @@ -798,6 +861,22 @@ data debug +=item * + +add_drop_table + +=item * + +no_comments + +=item * + +trace + +=item * + +validate + =back All options are, well, optional; these attributes can be set via @@ -811,14 +890,6 @@ advantage is gained by passing options to the constructor. 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 @@ -994,20 +1065,28 @@ parsed. If a filename is set, then that file is opened and read when the C method is called, as long as the data instance variable is not set. -=pod +=head2 schema + +Returns the SQL::Translator::Schema object. =head2 trace 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, Ekclark@cpan.orgE, darren chamberlain Edarren@cpan.orgE, Chris Mungall Ecjm@fruitfly.orgE, -Allen Day Eallenday@users.sourceforge.netE +Allen Day Eallenday@users.sourceforge.netE, +Sam Angiuoli Eangiuoli@users.sourceforge.netE, +Ying Zhang Ezyolive@yahoo.comE, +Mike Mellilo . =head1 COPYRIGHT @@ -1034,5 +1113,9 @@ Please use http://rt.cpan.org/ for reporting bugs. L, L, L, -L - +L, +L, +L, +L, +L +L.