X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator.pm;h=db9daa81b51a9c2b3c2db462a68f7cdec662318c;hb=389b318c4f8acd6846c71bde66a20bf70b928b3c;hp=b9d0727faf2af6a229a4fe25cb0e689f1d37551c;hpb=abfa405acf15e963e5b5760fa74464d91ca25f7e;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator.pm b/lib/SQL/Translator.pm index b9d0727..db9daa8 100644 --- a/lib/SQL/Translator.pm +++ b/lib/SQL/Translator.pm @@ -1,7 +1,7 @@ package SQL::Translator; # ---------------------------------------------------------------------- -# $Id: Translator.pm,v 1.15 2003-01-27 17:04:43 dlc Exp $ +# $Id: Translator.pm,v 1.29 2003-06-11 04:34:11 kycl4rk Exp $ # ---------------------------------------------------------------------- # Copyright (C) 2003 Ken Y. Clark , # darren chamberlain , @@ -22,48 +22,12 @@ package SQL::Translator; # 02111-1307 USA # ------------------------------------------------------------------- -=head1 NAME - -SQL::Translator - convert schema from one database to another - -=head1 SYNOPSIS - - 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 - ); - - my $output = $translator->translate( - from => "MySQL", - to => "Oracle", - filename => $file, - ) or die $translator->error; - - print $output; - -=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. - -=cut - 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.15 $ =~ /(\d+)\.(\d+)/; +$VERSION = '0.02'; +$REVISION = sprintf "%d.%02d", q$Revision: 1.29 $ =~ /(\d+)\.(\d+)/; $DEBUG = 0 unless defined $DEBUG; $ERROR = ""; @@ -72,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 @@ -80,35 +45,6 @@ use IO::Dir; # ---------------------------------------------------------------------- $DEFAULT_SUB = sub { $_[1] } unless defined $DEFAULT_SUB; -=head1 CONSTRUCTOR - -The constructor is called B, and accepts a optional hash of options. -Valid options are: - -=over 4 - -=item parser (aka from) - -=item parser_args - -=item producer (aka to) - -=item producer_args - -=item filename (aka file) - -=item data - -=item debug - -=back - -All options are, well, optional; these attributes can be set via -instance methods. Internally, they are; no (non-syntactical) -advantage is gained by passing options to the constructor. - -=cut - # ---------------------------------------------------------------------- # init([ARGS]) # The constructor. @@ -135,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 # @@ -161,29 +105,22 @@ sub init { # $self->{'debug'} = defined $config->{'debug'} ? $config->{'debug'} : $DEBUG; - $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; } -=head1 METHODS - -=head2 B - -Toggles whether or not to add "DROP TABLE" statements just before the -create definitions. - -=cut - +# ---------------------------------------------------------------------- +# add_drop_table([$bool]) +# ---------------------------------------------------------------------- sub add_drop_table { my $self = shift; if ( defined (my $arg = shift) ) { @@ -192,30 +129,9 @@ sub add_drop_table { return $self->{'add_drop_table'} || 0; } - -=head2 B - -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. - -=cut - -sub custom_translate { - my $self = shift; - $self->{'custom_translate'} = shift if @_; - return $self->{'custom_translate'} || {}; -} - -=head2 B - -Toggles whether to print comments in the output. Accepts a true or false -value, returns the current value. - -=cut - +# ---------------------------------------------------------------------- +# no_comments([$bool]) +# ---------------------------------------------------------------------- sub no_comments { my $self = shift; my $arg = shift; @@ -225,76 +141,12 @@ sub no_comments { return $self->{'no_comments'} || 0; } -=head2 B - -The B 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 -data structure. It is expected that the function transform the data -structure to a string. The SQL::Transformer 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. - -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), -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 -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". - - my $tr = SQL::Translator->new; - - # This will invoke My::Groovy::Producer::produce($tr, $data) - $tr->producer("My::Groovy::Producer"); - - # This will invoke SQL::Translator::Producer::Sybase::produce($tr, $data) - $tr->producer("Sybase"); - - # This will invoke My::Groovy::Producer::transmogrify($tr, $data), - # assuming that My::Groovy::Producer::transmogrify is not a module - # on disk. - $tr->producer("My::Groovy::Producer::transmogrify"); - - # This will invoke the referenced subroutine directly, as - # $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 -belongs. In the case of anonymous subroutines, this method returns -the string "CODE". - -Finally, there is a method named B, which is both an -accessor and a mutator. Arbitrary data may be stored in name => value -pairs for the producer subroutine to access: - - sub My::Random::producer { - my ($tr, $data) = @_; - my $pr_args = $tr->producer_args(); - - # $pr_args is a hashref. - -Extra data passed to the B method is passed to -B: - - $tr->producer("xSV", delimiter => ',\s*'); - - # In SQL::Translator::Producer::xSV: - my $args = $tr->producer_args; - my $delimiter = $args->{'delimiter'}; # value is ,\s* - -=cut -# producer and producer_type +# ---------------------------------------------------------------------- +# producer([$producer_spec]) +# +# Get or set the producer for the current translator. +# ---------------------------------------------------------------------- sub producer { my $self = shift; @@ -359,73 +211,34 @@ sub producer { }; # ---------------------------------------------------------------------- -# producer_type +# producer_type() # # 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. # ---------------------------------------------------------------------- sub producer_type { $_[0]->{'producer_type'} } # ---------------------------------------------------------------------- -# producer_args +# producer_args([\%args]) # # Arbitrary name => value pairs of paramters can be passed to a # producer using this method. # -# XXX All calls to producer_args with a value clobbers old values! -# Should probably check if $_[0] is undef, and delete stored -# args if it is: -# -# if (@_) { -# unless (defined $_[0]) { -# %{ $self->{'producer_args'} } = (); -# } -# my $args = isa($_[0], 'HASH') ? shift : { @_ }; -# %{ $self->{'producer_args'} } = ( -# %{ $self->{'producer_args'} }, -# %{ $args } -# ); -# } +# If the first argument passed in is undef, then the hash of arguments +# is cleared; all subsequent elements are added to the hash of name, +# value pairs stored as producer_args. # ---------------------------------------------------------------------- sub producer_args { my $self = shift; - if (@_) { - my $args = isa($_[0], 'HASH') ? shift : { @_ }; - $self->{'producer_args'} = $args; - } - $self->{'producer_args'}; + return $self->_args("producer", @_); } -=head2 B - -The B 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). -Also, the parser subroutine will be passed a string containing the -entirety of the data to be parsed. - - # Invokes SQL::Translator::Parser::MySQL::parse() - $tr->parser("MySQL"); - - # Invokes My::Groovy::Parser::parse() - $tr->parser("My::Groovy::Parser"); - - # Invoke an anonymous subroutine directly - $tr->parser(sub { - my $dumper = Data::Dumper->new([ $_[1] ], [ "SQL" ]); - $dumper->Purity(1)->Terse(1)->Deepcopy(1); - return $dumper->Dump; - }); - -There is also B and B, which perform -analogously to B and B - -=cut - +# ---------------------------------------------------------------------- +# parser([$parser_spec]) +# ---------------------------------------------------------------------- sub parser { my $self = shift; @@ -492,26 +305,10 @@ sub parser { # ---------------------------------------------------------------------- sub parser_type { $_[0]->{'parser_type'} } -# ---------------------------------------------------------------------- -# XXX See notes on producer_args, above sub parser_args { my $self = shift; - if (@_) { - my $args = isa($_[0], 'HASH') ? shift : { @_ }; - $self->{'parser_args'} = $args; - } - $self->{'parser_args'}; -} - -=head2 B - -Toggles whether to print warnings of name conflicts, identifier -mutations, etc. Probably only generated by producers to let the user -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. - -=cut + return $self->_args("parser", @_); +} sub show_warnings { my $self = shift; @@ -522,77 +319,6 @@ sub show_warnings { return $self->{'show_warnings'} || 0; } -=head2 B - -The B method calls the subroutines referenced by the -B and B 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). - -Here is how the parameter list to B 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 -reference to a hash, which is parsed as being more than one argument -(see next section). - - # Parse the file /path/to/datafile - my $output = $tr->translate("/path/to/datafile"); - - # Parse the data contained in the string $data - my $output = $tr->translate(\$data); - -=item * - -More than 1 argument means its a hash of things, and it might be -setting a parser, producer, or datasource (this key is named -"filename" or "file" if it's a file, or "data" for a SCALAR reference. - - # As above, parse /path/to/datafile, but with different producers - for my $prod ("MySQL", "XML", "Sybase") { - print $tr->translate( - producer => $prod, - filename => "/path/to/datafile", - ); - } - - # The filename hash key could also be: - datasource => \$data, - -You get the idea. - -=back - -=head2 B, B - -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. - - $tr->filename("/my/data/files/create.sql"); - -or: - - my $create_script = do { - local $/; - open CREATE, "/my/data/files/create.sql" or die $!; - ; - }; - $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 -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 -variable is not set. - -=cut # filename - get or set the filename sub filename { @@ -602,6 +328,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"); @@ -616,20 +345,33 @@ sub filename { } # ---------------------------------------------------------------------- -# data - get or set the data +# data([$data]) +# # if $self->{'data'} is not set, but $self->{'filename'} is, then -# $self->{'filename'} is opened and read, whith the results put into +# $self->{'filename'} is opened and read, with the results put into # $self->{'data'}. +# ---------------------------------------------------------------------- sub data { my $self = shift; - # Set $self->{'data'} to $_[0], if it is provided. + # Set $self->{'data'} based on what was passed in. We will + # accept a number of things; do our best to get it right. if (@_) { my $data = shift; if (isa($data, "SCALAR")) { $self->{'data'} = $data; } - elsif (! ref $data) { + else { + if (isa($data, 'ARRAY')) { + $data = join '', @$data; + } + elsif (isa($data, 'GLOB')) { + local $/; + $data = <$data>; + } + elsif (! ref $data && @_) { + $data = join '', $data, @_; + } $self->{'data'} = \$data; } } @@ -641,29 +383,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'}; } -=pod - -=head2 B +# ---------------------------------------------------------------------- +sub schema { +# +# Returns the SQL::Translator::Schema object +# + my $self = shift; -Turns on/off the tracing option of Parse::RecDescent. + unless ( defined $self->{'schema'} ) { + $self->{'schema'} = SQL::Translator::Schema->new; + } -=cut + return $self->{'schema'}; +} +# ---------------------------------------------------------------------- sub trace { my $self = shift; my $arg = shift; @@ -674,6 +428,20 @@ sub trace { } # ---------------------------------------------------------------------- +# translate([source], [\%args]) +# +# translate does the actual translation. The main argument is the +# source of the data to be translated, which can be a filename, scalar +# reference, or glob reference. +# +# Alternatively, translate takes optional arguements, which are passed +# to the appropriate places. Most notable of these arguments are +# parser and producer, which can be used to set the parser and +# producer, respectively. This is the applications last chance to set +# these. +# +# translate returns a string. +# ---------------------------------------------------------------------- sub translate { my $self = shift; my ($args, $parser, $parser_type, $producer, $producer_type); @@ -688,6 +456,12 @@ sub translate { $args = $_[0]; } + # Passed a GLOB reference, i.e., filehandle + elsif (isa($_[0], 'GLOB')) { + $self->debug("translate: Got a GLOB reference\n"); + $self->data($_[0]); + } + # Passed a reference to a string containing the data elsif (isa($_[0], 'SCALAR')) { # passed a ref to a string @@ -729,7 +503,7 @@ sub translate { $self->filename($filename); } - if (my $data = ($self->{'data'} || $self->{'datasource'})) { + if (my $data = ($args->{'data'} || $args->{'datasource'})) { $self->data($data); } @@ -737,7 +511,7 @@ sub translate { # Get the data. # ---------------------------------------------------------------- my $data = $self->data; - unless (length $$data) { + unless (ref($data) eq 'SCALAR' and length $$data) { return $self->error("Empty data file!"); } @@ -773,7 +547,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"; @@ -784,57 +563,504 @@ sub translate { } # ---------------------------------------------------------------------- +# list_parsers() +# +# Hacky sort of method to list all available parsers. This has +# several problems: +# +# - Only finds things in the SQL::Translator::Parser namespace +# +# - Only finds things that are located in the same directory +# as SQL::Translator::Parser. Yeck. +# +# This method will fail in several very likely cases: +# +# - Parser modules in different namespaces +# +# - Parser modules in the SQL::Translator::Parser namespace that +# have any XS componenets will be installed in +# arch_lib/SQL/Translator. +# +# ---------------------------------------------------------------------- +sub list_parsers { + return shift->_list("parser"); +} + +# ---------------------------------------------------------------------- +# list_producers() +# +# See notes for list_parsers(), above; all the problems apply to +# list_producers as well. +# ---------------------------------------------------------------------- sub list_producers { - require SQL::Translator::Producer; - my $path = catfile(dirname($INC{'SQL/Translator/Producer.pm'}), "Producer"); - my $dh = IO::Dir->new($path); + return shift->_list("producer"); +} - my @available = map { join "::", "SQL::Translator::Producer", $_ } - grep /\.pm$/, $dh->read; - return @available; -} +# ====================================================================== +# Private Methods +# ====================================================================== # ---------------------------------------------------------------------- -sub list_parsers { - require SQL::Translator::Parser; - my $path = catfile(dirname($INC{'SQL/Translator/Parser.pm'}), "Parser"); - my $dh = IO::Dir->new($path); +# _args($type, \%args); +# +# Gets or sets ${type}_args. Called by parser_args and producer_args. +# ---------------------------------------------------------------------- +sub _args { + my $self = shift; + my $type = shift; + $type = "${type}_args" unless $type =~ /_args$/; + + unless (defined $self->{$type} && isa($self->{$type}, 'HASH')) { + $self->{$type} = { }; + } + + if (@_) { + # If the first argument is an explicit undef (remember, we + # don't get here unless there is stuff in @_), then we clear + # out the producer_args hash. + if (! defined $_[0]) { + shift @_; + %{$self->{$type}} = (); + } + + my $args = isa($_[0], 'HASH') ? shift : { @_ }; + %{$self->{$type}} = (%{$self->{$type}}, %$args); + } - my @available = map { join "::", "SQL::Translator::Parser", $_ } - grep /\.pm$/, $dh->read; + $self->{$type}; +} - return @available; +# ---------------------------------------------------------------------- +# _list($type) +# ---------------------------------------------------------------------- +sub _list { + 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 keys %found; } # ---------------------------------------------------------------------- +# load($module) +# +# Loads a Perl module. Short circuits if a module is already loaded. +# ---------------------------------------------------------------------- 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) +# +# Calls UNIVERSAL::isa($ref, $type). I think UNIVERSAL::isa is ugly, +# but I like function overhead. # ---------------------------------------------------------------------- -sub isa($$) { UNIVERSAL::isa($_[0], $_[1]) } +sub isa($$) { + my ($ref, $type) = @_; + return UNIVERSAL::isa($ref, $type); +} + +# ---------------------------------------------------------------------- +sub validate { + +=pod + +=head2 validate + +Get or set whether to validate the parsed data. + + my $validate = $schema->validate(1); + +=cut + + 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 -#----------------------------------------------------- +# ---------------------------------------------------------------------- +# 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 (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 + validate => 1, # Validate schema object + + # 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', + # Or an arrayref of filenames, i.e. [ $file1, $file2, $file3 ] + filename => $file, + ) or die $translator->error; + + print $output; + +=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. + +=head1 CONSTRUCTOR + +The constructor is called C, and accepts a optional hash of options. +Valid options are: + +=over 4 + +=item * + +parser / from + +=item * + +parser_args + +=item * + +producer / to + +=item * + +producer_args + +=item * + +filename / file + +=item * + +data + +=item * + +debug + +=item * + +add_drop_table + +=item * + +no_comments + +=item * + +trace + +=item * + +validate + +=back + +All options are, well, optional; these attributes can be set via +instance methods. Internally, they are; no (non-syntactical) +advantage is gained by passing options to the constructor. + +=head1 METHODS + +=head2 add_drop_table + +Toggles whether or not to add "DROP TABLE" statements just before the +create definitions. + +=head2 no_comments + +Toggles whether to print comments in the output. Accepts a true or false +value, returns the current value. + +=head2 producer + +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 C instance and a +data structure. It is expected that the function transform the data +structure to a string. The C instance is provided for +informational purposes; for example, the type of the parser can be +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., 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: 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 +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; + + # This will invoke My::Groovy::Producer::produce($tr, $data) + $tr->producer("My::Groovy::Producer"); + + # This will invoke SQL::Translator::Producer::Sybase::produce($tr, $data) + $tr->producer("Sybase"); + + # This will invoke My::Groovy::Producer::transmogrify($tr, $data), + # assuming that My::Groovy::Producer::transmogrify is not a module + # on disk. + $tr->producer("My::Groovy::Producer::transmogrify"); + + # This will invoke the referenced subroutine directly, as + # $subref->($tr, $data); + $tr->producer(\&my_producer); + +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 C, which is both an +accessor and a mutator. Arbitrary data may be stored in name => value +pairs for the producer subroutine to access: + + sub My::Random::producer { + my ($tr, $data) = @_; + my $pr_args = $tr->producer_args(); + + # $pr_args is a hashref. + +Extra data passed to the C method is passed to +C: + + $tr->producer("xSV", delimiter => ',\s*'); + + # In SQL::Translator::Producer::xSV: + my $args = $tr->producer_args; + my $delimiter = $args->{'delimiter'}; # value is ,\s* + +=head2 parser + +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 +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. + + # Invokes SQL::Translator::Parser::MySQL::parse() + $tr->parser("MySQL"); + + # Invokes My::Groovy::Parser::parse() + $tr->parser("My::Groovy::Parser"); + + # Invoke an anonymous subroutine directly + $tr->parser(sub { + my $dumper = Data::Dumper->new([ $_[1] ], [ "SQL" ]); + $dumper->Purity(1)->Terse(1)->Deepcopy(1); + return $dumper->Dump; + }); + +There is also C and C, which perform +analogously to C and C + +=head2 show_warnings + +Toggles whether to print warnings of name conflicts, identifier +mutations, etc. Probably only generated by producers to let the user +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 translate + +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 +C and C methods). + +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 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). + + # Parse the file /path/to/datafile + my $output = $tr->translate("/path/to/datafile"); + + # Parse the data contained in the string $data + my $output = $tr->translate(\$data); + +=item * + +More than 1 argument means its a hash of things, and it might be +setting a parser, producer, or datasource (this key is named +"filename" or "file" if it's a file, or "data" for a SCALAR reference. + + # As above, parse /path/to/datafile, but with different producers + for my $prod ("MySQL", "XML", "Sybase") { + print $tr->translate( + producer => $prod, + filename => "/path/to/datafile", + ); + } + + # The filename hash key could also be: + datasource => \$data, + +You get the idea. + +=back + +=head2 filename, data + +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"); + +or: + + my $create_script = do { + local $/; + open CREATE, "/my/data/files/create.sql" or die $!; + ; + }; + $tr->data(\$create_script); + +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 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. + +=head2 validate + +Whether or not to validate the schema object after parsing and before +producing. =pod =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, +Sam Angiuoli Eangiuoli@users.sourceforge.netE, +Ying Zhang Ezyolive@yahoo.comE, +Mike Mellilo . =head1 COPYRIGHT @@ -852,11 +1078,18 @@ 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, L, L, -L - -=cut +L, +L, +L, +L, +L +L.