X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator.pm;h=c1d1afc899983d0b5ed2869937fe4ddf251ce6b4;hb=b11c7cf75750389d0e22c9b70563b11dc45ba955;hp=ae28b031edaaf07d6b9c27e3c4409351463c9a58;hpb=45ee6be0c0a19130e05b4deaee8eb075030015c9;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator.pm b/lib/SQL/Translator.pm index ae28b03..c1d1afc 100644 --- a/lib/SQL/Translator.pm +++ b/lib/SQL/Translator.pm @@ -1,7 +1,7 @@ package SQL::Translator; # ---------------------------------------------------------------------- -# $Id: Translator.pm,v 1.26 2003-05-09 16:51:47 kycl4rk Exp $ +# $Id: Translator.pm,v 1.46 2003-10-03 20:17:48 dlc Exp $ # ---------------------------------------------------------------------- # Copyright (C) 2003 Ken Y. Clark , # darren chamberlain , @@ -26,13 +26,18 @@ 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.26 $ =~ /(\d+)\.(\d+)/; +require 5.004; + +$VERSION = '0.03'; +$REVISION = sprintf "%d.%02d", q$Revision: 1.46 $ =~ /(\d+)\.(\d+)/; $DEBUG = 0 unless defined $DEBUG; $ERROR = ""; use Carp qw(carp); +use Data::Dumper; +use Class::Base; +use File::Find; use File::Spec::Functions qw(catfile); use File::Basename qw(dirname); use IO::Dir; @@ -43,7 +48,7 @@ use SQL::Translator::Schema; # 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]) @@ -60,7 +65,6 @@ $DEFAULT_SUB = sub { $_[1] } unless defined $DEFAULT_SUB; # ---------------------------------------------------------------------- sub init { my ( $self, $config ) = @_; - # # Set the parser and producer. # @@ -71,13 +75,13 @@ sub init { $self->parser ($config->{'parser'} || $config->{'from'} || $DEFAULT_SUB); $self->producer($config->{'producer'} || $config->{'to'} || $DEFAULT_SUB); - # - # Set up callbacks for formatting of pk,fk,table,package names in producer - # - $self->format_table_name($config->{'format_table_name'}); - $self->format_package_name($config->{'format_package_name'}); - $self->format_fk_name($config->{'format_fk_name'}); - $self->format_pk_name($config->{'format_pk_name'}); + # + # Set up callbacks for formatting of pk,fk,table,package names in producer + # + $self->format_table_name($config->{'format_table_name'}); + $self->format_package_name($config->{'format_package_name'}); + $self->format_fk_name($config->{'format_fk_name'}); + $self->format_pk_name($config->{'format_pk_name'}); # # Set the parser_args and producer_args @@ -107,14 +111,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; } @@ -129,16 +133,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]) # ---------------------------------------------------------------------- @@ -203,6 +197,7 @@ sub producer { # 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" }; @@ -295,6 +290,7 @@ sub parser { # 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" }; @@ -338,9 +334,9 @@ sub filename { if (-d $filename) { my $msg = "Cannot use directory '$filename' as input source"; return $self->error($msg); - } elsif (ref($filename) eq 'ARRAY') { - $self->{'filename'} = $filename; - $self->debug("Got array of files: ".join(', ',@$filename)."\n"); + } elsif (ref($filename) eq 'ARRAY') { + $self->{'filename'} = $filename; + $self->debug("Got array of files: ".join(', ',@$filename)."\n"); } elsif (-f _ && -r _) { $self->{'filename'} = $filename; $self->debug("Got filename: '$self->{'filename'}'\n"); @@ -393,27 +389,38 @@ sub data { local $/; my $data; - my @files = ref($filename) eq 'ARRAY' ? @$filename : ($filename); + my @files = ref($filename) eq 'ARRAY' ? @$filename : ($filename); - foreach my $file (@files) { - unless (open FH, $file) { - return $self->error("Can't read file '$file': $!"); - } + foreach my $file (@files) { + unless (open FH, $file) { + return $self->error("Can't read file '$file': $!"); + } - $data .= ; + $data .= ; - unless (close FH) { - return $self->error("Can't close file '$file': $!"); - } - } + unless (close FH) { + return $self->error("Can't close file '$file': $!"); + } + } - $self->{'data'} = \$data; + $self->{'data'} = \$data; } return $self->{'data'}; } # ---------------------------------------------------------------------- +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 @@ -521,9 +528,6 @@ sub translate { # Get the data. # ---------------------------------------------------------------- my $data = $self->data; - unless (ref($data) eq 'SCALAR' and length $$data) { - return $self->error("Empty data file!"); - } # ---------------------------------------------------------------- # Local reference to the parser subroutine @@ -550,15 +554,23 @@ sub translate { # 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); + } } - eval { $producer_output = $producer->($self, $parser_output, $schema) }; + $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) }; if ($@ || ! $producer_output) { my $msg = sprintf "translate: Error with producer '%s': %s", $producer_type, ($@) ? $@ : " no results"; @@ -637,31 +649,61 @@ sub _args { $self->{$type}; } - # ---------------------------------------------------------------------- # _list($type) # ---------------------------------------------------------------------- sub _list { - my $self = shift; - my $type = shift || return (); + my $self = shift; + my $type = shift || return (); my $uctype = ucfirst lc $type; - my %found; + # + # First find all the directories where SQL::Translator + # parsers or producers (the "type") appear to live. + # load("SQL::Translator::$uctype") or return (); my $path = catfile "SQL", "Translator", $uctype; + my @dirs; 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); - for (grep /\.pm$/, $dh->read) { - s/\.pm$//; - $found{ join "::", "SQL::Translator::$uctype", $_ } = 1; - } + push @dirs, $dir; } - return keys %found; + # + # Now use File::File::find to look recursively in those + # directories for all the *.pm files, then present them + # with the slashes turned into dashes. + # + my %found; + find( + sub { + if ( -f && m/\.pm$/ ) { + my $mod = $_; + $mod =~ s/\.pm$//; + my $cur_dir = $File::Find::dir; + my $base_dir = catfile 'SQL', 'Translator', $uctype; + + # + # See if the current directory is below the base directory. + # + if ( $cur_dir =~ m/$base_dir(.*)/ ) { + $cur_dir = $1; + $cur_dir =~ s!^/!!; # kill leading slash + $cur_dir =~ s!/!-!g; # turn other slashes into dashes + } + else { + $cur_dir = ''; + } + + $found{ join '-', map { $_ || () } $cur_dir, $mod } = 1; + } + }, + @dirs + ); + + return sort { lc $a cmp lc $b } keys %found; } # ---------------------------------------------------------------------- @@ -682,40 +724,45 @@ sub load { 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}; } # ---------------------------------------------------------------------- @@ -729,32 +776,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}, @@ -762,8 +826,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; @@ -772,12 +836,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 @@ -814,6 +884,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 @@ -827,14 +913,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 @@ -1010,8 +1088,6 @@ 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. @@ -1020,14 +1096,53 @@ 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, Ekclark@cpan.orgE, -darren chamberlain Edarren@cpan.orgE, -Chris Mungall Ecjm@fruitfly.orgE, -Allen Day Eallenday@users.sourceforge.netE +The following people have contributed to the SQLFairy project: + +=over 4 + +=item * Mark Addison + +=item * Sam Angiuoli + +=item * Darren Chamberlain + +=item * Ken Y. Clark + +=item * Allen Day + +=item * Paul Harrington + +=item * Mikey Melillo + +=item * Chris Mungall + +=item * Ross Smith II + +=item * Gudmundur A. Thorisson + +=item * Chris To + +=item * Jason Williams + +=item * Ying Zhang + +=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 @@ -1047,12 +1162,21 @@ USA =head1 BUGS -Please use http://rt.cpan.org/ for reporting bugs. +Please use L for reporting bugs. + +=head1 PRAISE + +If you find this module useful, please use +L to rate it. =head1 SEE ALSO L, L, L, -L - +L, +L, +L, +L, +L, +L.