X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator.pm;h=9c0cf38f49178d7f5132a82d64e6c07feb34043d;hb=307d95603a49f1ff8056963822538c726cde481f;hp=32e79b49508704fdca325fc39e7603a89350f428;hpb=0f3778d0fbe3334bab28de4c08523e77360b6332;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator.pm b/lib/SQL/Translator.pm index 32e79b4..9c0cf38 100644 --- a/lib/SQL/Translator.pm +++ b/lib/SQL/Translator.pm @@ -1,7 +1,7 @@ package SQL::Translator; # ---------------------------------------------------------------------- -# $Id: Translator.pm,v 1.16 2003-01-29 13:29:49 dlc Exp $ +# $Id: Translator.pm,v 1.27 2003-05-09 19:51:28 kycl4rk Exp $ # ---------------------------------------------------------------------- # Copyright (C) 2003 Ken Y. Clark , # darren chamberlain , @@ -27,7 +27,7 @@ use vars qw( $VERSION $REVISION $DEFAULT_SUB $DEBUG $ERROR ); use base 'Class::Base'; $VERSION = '0.01'; -$REVISION = sprintf "%d.%02d", q$Revision: 1.16 $ =~ /(\d+)\.(\d+)/; +$REVISION = sprintf "%d.%02d", q$Revision: 1.27 $ =~ /(\d+)\.(\d+)/; $DEBUG = 0 unless defined $DEBUG; $ERROR = ""; @@ -36,6 +36,7 @@ use Carp qw(carp); 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 @@ -70,6 +71,14 @@ 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 the parser_args and producer_args # @@ -96,7 +105,6 @@ sub init { # $self->{'debug'} = defined $config->{'debug'} ? $config->{'debug'} : $DEBUG; - $self->add_drop_table( $config->{'add_drop_table'} ); $self->custom_translate( $config->{'xlate'} ); @@ -217,7 +225,7 @@ sub producer { # # producer_type is an accessor that allows producer subs to get # information about their origin. This is poptentially important; -# since all producer subs are called as subroutine refernces, there is +# since all producer subs are called as subroutine references, there is # no way for a producer to find out which package the sub lives in # originally, for example. # ---------------------------------------------------------------------- @@ -238,8 +246,6 @@ sub producer_args { return $self->_args("producer", @_); } - - # ---------------------------------------------------------------------- # parser([$parser_spec]) # ---------------------------------------------------------------------- @@ -332,6 +338,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 (-f _ && -r _) { $self->{'filename'} = $filename; $self->debug("Got filename: '$self->{'filename'}'\n"); @@ -384,22 +393,41 @@ sub data { local $/; my $data; - unless (open FH, $filename) { - return $self->error("Can't read file '$filename': $!"); - } + my @files = ref($filename) eq 'ARRAY' ? @$filename : ($filename); - $data = ; - $self->{'data'} = \$data; + foreach my $file (@files) { + unless (open FH, $file) { + return $self->error("Can't read file '$file': $!"); + } - unless (close FH) { - return $self->error("Can't close file '$filename': $!"); - } + $data .= ; + + unless (close FH) { + return $self->error("Can't close file '$file': $!"); + } + } + + $self->{'data'} = \$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; @@ -424,8 +452,10 @@ sub trace { # # translate returns a string. # ---------------------------------------------------------------------- -sub translate { my $self = shift; my ($args, $parser, $parser_type, -$producer, $producer_type); my ($parser_output, $producer_output); +sub translate { + my $self = shift; + my ($args, $parser, $parser_type, $producer, $producer_type); + my ($parser_output, $producer_output); # Parse arguments if (@_ == 1) { @@ -483,7 +513,7 @@ $producer, $producer_type); my ($parser_output, $producer_output); $self->filename($filename); } - if (my $data = ($self->{'data'} || $self->{'datasource'})) { + if (my $data = ($args->{'data'} || $args->{'datasource'})) { $self->data($data); } @@ -491,7 +521,7 @@ $producer, $producer_type); my ($parser_output, $producer_output); # Get the data. # ---------------------------------------------------------------- my $data = $self->data; - unless (length $$data) { + unless (ref($data) eq 'SCALAR' and length $$data) { return $self->error("Empty data file!"); } @@ -558,7 +588,7 @@ $producer, $producer_type); my ($parser_output, $producer_output); # # ---------------------------------------------------------------------- sub list_parsers { - return _list("parsers"); + return shift->_list("parser"); } # ---------------------------------------------------------------------- @@ -568,7 +598,7 @@ sub list_parsers { # list_producers as well. # ---------------------------------------------------------------------- sub list_producers { - return _list("producers"); + return shift->_list("producer"); } @@ -611,14 +641,26 @@ sub _args { # _list($type) # ---------------------------------------------------------------------- sub _list { - my $type = ucfirst lc $_[0] || return (); - - load("SQL::Translator::$type"); - my $path = catfile(dirname($INC{'SQL/Translator/$type.pm'}), $type); - my $dh = IO::Dir->new($path); + my $self = shift; + my $type = shift || return (); + my $uctype = ucfirst lc $type; + my %found; + + load("SQL::Translator::$uctype") or return (); + my $path = catfile "SQL", "Translator", $uctype; + for (@INC) { + my $dir = catfile $_, $path; + $self->debug("_list_${type}s searching $dir"); + next unless -d $dir; + + my $dh = IO::Dir->new($dir); + for (grep /\.pm$/, $dh->read) { + s/\.pm$//; + $found{ join "::", "SQL::Translator::$uctype", $_ } = 1; + } + } - return map { join "::", "SQL::Translator::$type", $_ } - grep /\.pm$/, $dh->read; + return keys %found; } # ---------------------------------------------------------------------- @@ -629,13 +671,52 @@ sub _list { sub load { my $module = do { my $m = shift; $m =~ s[::][/]g; "$m.pm" }; return 1 if $INC{$module}; - - eval { require $module }; - - return if ($@); + + eval { + require $module; + $module->import(@_); + }; + + return __PACKAGE__->error($@) if ($@); 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; +} + +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; +} + +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; +} + +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; +} + # ---------------------------------------------------------------------- # isa($ref, $type) # @@ -664,18 +745,26 @@ SQL::Translator - convert schema from one database to another use SQL::Translator; my $translator = SQL::Translator->new( - xlate => $xlate || {}, # Overrides for field translation - debug => $debug, # Print debug info - trace => $trace, # Print Parse::RecDescent trace - no_comments => $no_comments, # Don't include comments in output - show_warnings => $show_warnings, # Print name mutations, conflicts - add_drop_table => $add_drop_table, # Add "drop table" statements + 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 + + # Make all table names CAPS in producers which support this option + 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}, + format_pk_name => sub {return shift}, ); my $output = $translator->translate( from => "MySQL", to => "Oracle", - filename => $file, + # Or an arrayref of filenames, i.e. [ $file1, $file2, $file3 ] + filename => $file, ) or die $translator->error; print $output; @@ -691,24 +780,38 @@ would use the Postgres parser and the Oracle producer. =head1 CONSTRUCTOR -The constructor is called B, and accepts a optional hash of options. +The constructor is called C, and accepts a optional hash of options. Valid options are: =over 4 -=item parser (aka from) +=item * + +parser / from + +=item * + +parser_args + +=item * + +producer / to + +=item * + +producer_args -=item parser_args +=item * -=item producer (aka to) +filename / file -=item producer_args +=item * -=item filename (aka file) +data -=item data +=item * -=item debug +debug =back @@ -718,12 +821,12 @@ advantage is gained by passing options to the constructor. =head1 METHODS -=head2 B +=head2 add_drop_table Toggles whether or not to add "DROP TABLE" statements just before the create definitions. -=head2 B +=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, @@ -731,36 +834,36 @@ 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 B +=head2 no_comments Toggles whether to print comments in the output. Accepts a true or false value, returns the current value. -=head2 B +=head2 producer -The B method is an accessor/mutator, used to retrieve or +The C method is an accessor/mutator, used to retrieve or define what subroutine is called to produce the output. A subroutine defined as a producer will be invoked as a function (I) -and passed 2 parameters: its container SQL::Translator instance and a +and passed 2 parameters: its container C instance and a data structure. It is expected that the function transform the data -structure to a string. The SQL::Transformer instance is provided for +structure to a string. The C instance is provided for informational purposes; for example, the type of the parser can be -retrieved using the B method, and the B and -B methods can be called when needed. +retrieved using the C method, and the C and +C methods can be called when needed. -When defining a producer, one of several things can be passed -in: A module name (e.g., My::Groovy::Producer), a module name -relative to the SQL::Translator::Producer namespace (e.g., MySQL), a -module name and function combination (My::Groovy::Producer::transmogrify), +When defining a producer, one of several things can be passed in: A +module name (e.g., C), a module name relative to +the C namespace (e.g., C), a module +name and function combination (C), or a reference to an anonymous subroutine. If a full module name is passed in (for the purposes of this method, a string containing "::" is considered to be a module name), it is treated as a package, and a -function called "produce" will be invoked: $modulename::produce. If -$modulename cannot be loaded, the final portion is stripped off and +function called "produce" will be invoked: C<$modulename::produce>. +If $modulename cannot be loaded, the final portion is stripped off and treated as a function. In other words, if there is no file named -My/Groovy/Producer/transmogrify.pm, SQL::Translator will attempt to load -My/Groovy/Producer.pm and use transmogrify as the name of the function, -instead of the default "produce". +F, C will attempt +to load F and use C as the name of +the function, instead of the default C. my $tr = SQL::Translator->new; @@ -779,12 +882,12 @@ instead of the default "produce". # $subref->($tr, $data); $tr->producer(\&my_producer); -There is also a method named B, which is a string -containing the classname to which the above B function +There is also a method named C, which is a string +containing the classname to which the above C function belongs. In the case of anonymous subroutines, this method returns the string "CODE". -Finally, there is a method named B, which is both an +Finally, there is a method named C, which is both an accessor and a mutator. Arbitrary data may be stored in name => value pairs for the producer subroutine to access: @@ -794,8 +897,8 @@ pairs for the producer subroutine to access: # $pr_args is a hashref. -Extra data passed to the B method is passed to -B: +Extra data passed to the C method is passed to +C: $tr->producer("xSV", delimiter => ',\s*'); @@ -803,12 +906,12 @@ B: my $args = $tr->producer_args; my $delimiter = $args->{'delimiter'}; # value is ,\s* -=head2 B +=head2 parser -The B method defines or retrieves a subroutine that will be +The C method defines or retrieves a subroutine that will be called to perform the parsing. The basic idea is the same as that of -B (see above), except the default subroutine name is -"parse", and will be invoked as $module_name::parse($tr, $data). +C (see above), except the default subroutine name is +"parse", and will be invoked as C<$module_name::parse($tr, $data)>. Also, the parser subroutine will be passed a string containing the entirety of the data to be parsed. @@ -825,10 +928,10 @@ entirety of the data to be parsed. return $dumper->Dump; }); -There is also B and B, which perform -analogously to B and B +There is also C and C, which perform +analogously to C and C -=head2 B +=head2 show_warnings Toggles whether to print warnings of name conflicts, identifier mutations, etc. Probably only generated by producers to let the user @@ -836,22 +939,22 @@ know when something won't translate very smoothly (e.g., MySQL "enum" fields into Oracle). Accepts a true or false value, returns the current value. -=head2 B +=head2 translate -The B method calls the subroutines referenced by the -B and B data members (described above). It accepts +The C method calls the subroutines referenced by the +C and C data members (described above). It accepts as arguments a number of things, in key => value format, including (potentially) a parser and a producer (they are passed directly to the -B and B methods). +C and C methods). -Here is how the parameter list to B is parsed: +Here is how the parameter list to C is parsed: =over =item * 1 argument means it's the data to be parsed; which could be a string -(filename) or a refernce to a scalar (a string stored in memory), or a +(filename) or a reference to a scalar (a string stored in memory), or a reference to a hash, which is parsed as being more than one argument (see next section). @@ -882,12 +985,12 @@ You get the idea. =back -=head2 B, B +=head2 filename, data -Using the B method, the filename of the data to be parsed -can be set. This method can be used in conjunction with the B -method, below. If both the B and B methods are -invoked as mutators, the data set in the B method is used. +Using the C method, the filename of the data to be parsed +can be set. This method can be used in conjunction with the C +method, below. If both the C and C methods are +invoked as mutators, the data set in the C method is used. $tr->filename("/my/data/files/create.sql"); @@ -900,15 +1003,19 @@ or: }; $tr->data(\$create_script); -B takes a string, which is interpreted as a filename. -B takes a reference to a string, which is used as the data to be +C takes a string, which is interpreted as a filename. +C takes a reference to a string, which is used as the data to be parsed. If a filename is set, then that file is opened and read when -the B method is called, as long as the data instance +the C method is called, as long as the data instance variable is not set. =pod -=head2 B +=head2 schema + +Returns the SQL::Translator::Schema object. + +=head2 trace Turns on/off the tracing option of Parse::RecDescent. @@ -916,9 +1023,10 @@ Turns on/off the tracing option of Parse::RecDescent. =head1 AUTHORS -Ken Y. Clark, Ekclark@cpan.org, -darren chamberlain Edarren@cpan.orgE, -Chris Mungall Ecjm@fruitfly.orgE +Ken Y. Clark, Ekclark@cpan.orgE, +darren chamberlain Edarren@cpan.orgE, +Chris Mungall Ecjm@fruitfly.orgE, +Allen Day Eallenday@users.sourceforge.netE =head1 COPYRIGHT @@ -936,6 +1044,10 @@ along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +=head1 BUGS + +Please use http://rt.cpan.org/ for reporting bugs. + =head1 SEE ALSO L,