package SQL::Translator;
# ----------------------------------------------------------------------
-# $Id: Translator.pm,v 1.35 2003-06-26 14:29:47 dlc Exp $
+# $Id$
# ----------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>,
-# Chris Mungall <cjm@fruitfly.org>
+# Copyright (C) 2002-2009 The SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# -------------------------------------------------------------------
use strict;
-use vars qw( $VERSION $REVISION $DEFAULT_SUB $DEBUG $ERROR );
+use vars qw( $VERSION $DEFAULT_SUB $DEBUG $ERROR );
use base 'Class::Base';
-$VERSION = '0.02';
-$REVISION = sprintf "%d.%02d", q$Revision: 1.35 $ =~ /(\d+)\.(\d+)/;
+require 5.004;
+
+$VERSION = '0.09002';
$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;
+use SQL::Translator::Producer;
use SQL::Translator::Schema;
# ----------------------------------------------------------------------
# ----------------------------------------------------------------------
sub init {
my ( $self, $config ) = @_;
-
#
# Set the parser and producer.
#
$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
+ # MOVED TO PRODUCER ARGS
+ #
+ #$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
}
#
+ # Initialize the filters.
+ #
+ if ( $config->{filters} && ref $config->{filters} eq "ARRAY" ) {
+ $self->filters( @{$config->{filters}} )
+ || return $self->error('Error inititializing filters: '.$self->error);
+ }
+
+ #
# Set the data source, if 'filename' or 'file' is provided.
#
$config->{'filename'} ||= $config->{'file'} || "";
$self->filename( $config->{'filename'} ) if $config->{'filename'};
#
- # Finally, if there is a 'data' parameter, use that in
+ # Finally, if there is a 'data' parameter, use that in
# preference to filename and file
#
if ( my $data = $config->{'data'} ) {
$self->{'debug'} = defined $config->{'debug'} ? $config->{'debug'} : $DEBUG;
$self->add_drop_table( $config->{'add_drop_table'} );
-
+
$self->no_comments( $config->{'no_comments'} );
$self->show_warnings( $config->{'show_warnings'} );
$self->trace( $config->{'trace'} );
$self->validate( $config->{'validate'} );
+
+ $self->quote_table_names( (defined $config->{'quote_table_names'}
+ ? $config->{'quote_table_names'} : 1) );
+ $self->quote_field_names( (defined $config->{'quote_field_names'}
+ ? $config->{'quote_field_names'} : 1) );
return $self;
}
# ----------------------------------------------------------------------
-# producer([$producer_spec])
-#
-# Get or set the producer for the current translator.
+# quote_table_names([$bool])
# ----------------------------------------------------------------------
-sub producer {
+sub quote_table_names {
my $self = shift;
+ if ( defined (my $arg = shift) ) {
+ $self->{'quote_table_names'} = $arg ? 1 : 0;
+ }
+ return $self->{'quote_table_names'} || 0;
+}
- # producer as a mutator
- if (@_) {
- my $producer = shift;
-
- # Passed a module name (string containing "::")
- if ($producer =~ /::/) {
- my $func_name;
-
- # Module name was passed directly
- # We try to load the name; if it doesn't load, there's
- # a possibility that it has a function name attached to
- # it.
- if (load($producer)) {
- $func_name = "produce";
- }
-
- # Module::function was passed
- else {
- # Passed Module::Name::function; try to recover
- my @func_parts = split /::/, $producer;
- $func_name = pop @func_parts;
- $producer = join "::", @func_parts;
-
- # If this doesn't work, then we have a legitimate
- # problem.
- load($producer) or die "Can't load $producer: $@";
- }
-
- # get code reference and assign
- $self->{'producer'} = \&{ "$producer\::$func_name" };
- $self->{'producer_type'} = $producer;
- $self->debug("Got producer: $producer\::$func_name\n");
- }
-
- # passed an anonymous subroutine reference
- elsif (isa($producer, 'CODE')) {
- $self->{'producer'} = $producer;
- $self->{'producer_type'} = "CODE";
- $self->debug("Got producer: code ref\n");
- }
-
- # passed a string containing no "::"; relative package name
- else {
- my $Pp = sprintf "SQL::Translator::Producer::$producer";
- load($Pp) or die "Can't load $Pp: $@";
- $self->{'producer'} = \&{ "$Pp\::produce" };
- $self->{'producer_type'} = $Pp;
- $self->debug("Got producer: $Pp\n");
- }
-
- # At this point, $self->{'producer'} contains a subroutine
- # reference that is ready to run
-
- # Anything left? If so, it's producer_args
- $self->producer_args(@_) if (@_);
+# ----------------------------------------------------------------------
+# quote_field_names([$bool])
+# ----------------------------------------------------------------------
+sub quote_field_names {
+ my $self = shift;
+ if ( defined (my $arg = shift) ) {
+ $self->{'quote_field_names'} = $arg ? 1 : 0;
}
+ return $self->{'quote_field_names'} || 0;
+}
- return $self->{'producer'};
-};
+# ----------------------------------------------------------------------
+# producer([$producer_spec])
+#
+# Get or set the producer for the current translator.
+# ----------------------------------------------------------------------
+sub producer {
+ shift->_tool({
+ name => 'producer',
+ path => "SQL::Translator::Producer",
+ default_sub => "produce",
+ }, @_);
+}
# ----------------------------------------------------------------------
# producer_type()
# is cleared; all subsequent elements are added to the hash of name,
# value pairs stored as producer_args.
# ----------------------------------------------------------------------
-sub producer_args {
- my $self = shift;
- return $self->_args("producer", @_);
-}
+sub producer_args { shift->_args("producer", @_); }
# ----------------------------------------------------------------------
# parser([$parser_spec])
# ----------------------------------------------------------------------
sub parser {
- my $self = shift;
-
- # parser as a mutator
- if (@_) {
- my $parser = shift;
-
- # Passed a module name (string containing "::")
- if ($parser =~ /::/) {
- my $func_name;
-
- # Module name was passed directly
- # We try to load the name; if it doesn't load, there's
- # a possibility that it has a function name attached to
- # it.
- if (load($parser)) {
- $func_name = "parse";
- }
+ shift->_tool({
+ name => 'parser',
+ path => "SQL::Translator::Parser",
+ default_sub => "parse",
+ }, @_);
+}
- # Module::function was passed
- else {
- # Passed Module::Name::function; try to recover
- my @func_parts = split /::/, $parser;
- $func_name = pop @func_parts;
- $parser = join "::", @func_parts;
-
- # If this doesn't work, then we have a legitimate
- # problem.
- load($parser) or die "Can't load $parser: $@";
- }
-
- # get code reference and assign
- $self->{'parser'} = \&{ "$parser\::$func_name" };
- $self->{'parser_type'} = $parser;
- $self->debug("Got parser: $parser\::$func_name\n");
- }
+sub parser_type { $_[0]->{'parser_type'}; }
- # passed an anonymous subroutine reference
- elsif ( isa( $parser, 'CODE' ) ) {
- $self->{'parser'} = $parser;
- $self->{'parser_type'} = "CODE";
- $self->debug("Got parser: code ref\n");
- }
+sub parser_args { shift->_args("parser", @_); }
- # passed a string containing no "::"; relative package name
+# ----------------------------------------------------------------------
+# e.g.
+# $sqlt->filters => [
+# sub { },
+# [ "NormalizeNames", field => "lc", tabel => "ucfirst" ],
+# [
+# "DataTypeMap",
+# "TEXT" => "BIGTEXT",
+# ],
+# ],
+# ----------------------------------------------------------------------
+sub filters {
+ my $self = shift;
+ my $filters = $self->{filters} ||= [];
+ return @$filters unless @_;
+
+ # Set. Convert args to list of [\&code,@args]
+ foreach (@_) {
+ my ($filt,@args) = ref($_) eq "ARRAY" ? @$_ : $_;
+ if ( isa($filt,"CODE") ) {
+ push @$filters, [$filt,@args];
+ next;
+ }
else {
- my $Pp = "SQL::Translator::Parser::$parser";
- load( $Pp ) or die "Can't load $Pp: $@";
- $self->{'parser'} = \&{ "$Pp\::parse" };
- $self->{'parser_type'} = $Pp;
- $self->debug("Got parser: $Pp\n");
- }
-
- #
- # At this point, $self->{'parser'} contains a subroutine
- # reference that is ready to run
- #
- $self->parser_args( @_ ) if (@_);
+ $self->debug("Adding $filt filter. Args:".Dumper(\@args)."\n");
+ $filt = _load_sub("$filt\::filter", "SQL::Translator::Filter")
+ || return $self->error(__PACKAGE__->error);
+ push @$filters, [$filt,@args];
+ }
}
-
- return $self->{'parser'};
+ return @$filters;
}
# ----------------------------------------------------------------------
-sub parser_type { $_[0]->{'parser_type'} }
-
-sub parser_args {
- my $self = shift;
- return $self->_args("parser", @_);
-}
-
sub show_warnings {
my $self = shift;
my $arg = shift;
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");
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 .= <FH>;
+ $data .= <FH>;
- 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
my $self = shift;
unless ( defined $self->{'schema'} ) {
- $self->{'schema'} = SQL::Translator::Schema->new;
+ $self->{'schema'} = SQL::Translator::Schema->new(
+ translator => $self,
+ );
}
return $self->{'schema'};
sub translate {
my $self = shift;
my ($args, $parser, $parser_type, $producer, $producer_type);
- my ($parser_output, $producer_output);
+ my ($parser_output, $producer_output, @producer_output);
# Parse arguments
- if (@_ == 1) {
+ if (@_ == 1) {
# Passed a reference to a hash?
if (isa($_[0], 'HASH')) {
# yep, a hashref
# 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
$producer_type = $self->producer_type;
# ----------------------------------------------------------------
- # Execute the parser, then execute the producer with that output.
+ # Execute the parser, the filters and then execute the producer.
# Allowances are made for each piece to die, or fail to compile,
# since the referenced subroutines could be almost anything. In
# the future, each of these might happen in a Safe environment,
# depending on how paranoid we want to be.
# ----------------------------------------------------------------
- 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);
+
+ # Run parser
+ 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 ) {
+ # Validate the schema if asked to.
+ 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";
+ # Run filters
+ my $filt_num = 0;
+ foreach ($self->filters) {
+ $filt_num++;
+ my ($code,@args) = @$_;
+ eval { $code->($self->schema, @args) };
+ my $err = $@ || $self->error || 0;
+ return $self->error("Error with filter $filt_num : $err") if $err;
+ }
+
+ # Run producer
+ # Calling wantarray in the eval no work, wrong scope.
+ my $wantarray = wantarray ? 1 : 0;
+ eval {
+ if ($wantarray) {
+ @producer_output = $producer->($self);
+ } else {
+ $producer_output = $producer->($self);
+ }
+ };
+ if ($@ || !( $producer_output || @producer_output)) {
+ my $err = $@ || $self->error || "no results";
+ my $msg = "translate: Error with producer '$producer_type': $err";
return $self->error($msg);
}
- return $producer_output;
+ return wantarray ? @producer_output : $producer_output;
}
# ----------------------------------------------------------------------
}
# ----------------------------------------------------------------------
+# Does the get/set work for parser and producer. e.g.
+# return $self->_tool({
+# name => 'producer',
+# path => "SQL::Translator::Producer",
+# default_sub => "produce",
+# }, @_);
+# ----------------------------------------------------------------------
+sub _tool {
+ my ($self,$args) = (shift, shift);
+ my $name = $args->{name};
+ return $self->{$name} unless @_; # get accessor
+
+ my $path = $args->{path};
+ my $default_sub = $args->{default_sub};
+ my $tool = shift;
+
+ # passed an anonymous subroutine reference
+ if (isa($tool, 'CODE')) {
+ $self->{$name} = $tool;
+ $self->{"$name\_type"} = "CODE";
+ $self->debug("Got $name: code ref\n");
+ }
+
+ # Module name was passed directly
+ # We try to load the name; if it doesn't load, there's a
+ # possibility that it has a function name attached to it,
+ # so we give it a go.
+ else {
+ $tool =~ s/-/::/g if $tool !~ /::/;
+ my ($code,$sub);
+ ($code,$sub) = _load_sub("$tool\::$default_sub", $path);
+ unless ($code) {
+ if ( __PACKAGE__->error =~ m/Can't find module/ ) {
+ # Mod not found so try sub
+ ($code,$sub) = _load_sub("$tool", $path) unless $code;
+ die "Can't load $name subroutine '$tool' : ".__PACKAGE__->error
+ unless $code;
+ }
+ else {
+ die "Can't load $name '$tool' : ".__PACKAGE__->error;
+ }
+ }
+
+ # get code reference and assign
+ my (undef,$module,undef) = $sub =~ m/((.*)::)?(\w+)$/;
+ $self->{$name} = $code;
+ $self->{"$name\_type"} = $sub eq "CODE" ? "CODE" : $module;
+ $self->debug("Got $name: $sub\n");
+ }
+
+ # At this point, $self->{$name} contains a subroutine
+ # reference that is ready to run
+
+ # Anything left? If so, it's args
+ my $meth = "$name\_args";
+ $self->$meth(@_) if (@_);
+
+ return $self->{$name};
+}
+
+# ----------------------------------------------------------------------
# _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 = quotemeta 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;
}
# ----------------------------------------------------------------------
-# load($module)
+# load(MODULE [,PATH[,PATH]...])
#
# Loads a Perl module. Short circuits if a module is already loaded.
+#
+# MODULE - is the name of the module to load.
+#
+# PATH - optional list of 'package paths' to look for the module in. e.g
+# If you called load('Super::Foo' => 'My', 'Other') it will
+# try to load the mod Super::Foo then My::Super::Foo then Other::Super::Foo.
+#
+# Returns package name of the module actually loaded or false and sets error.
+#
+# Note, you can't load a name from the root namespace (ie one without '::' in
+# it), therefore a single word name without a path fails.
# ----------------------------------------------------------------------
sub load {
- my $module = do { my $m = shift; $m =~ s[::][/]g; "$m.pm" };
- return 1 if $INC{$module};
+ my $name = shift;
+ my @path;
+ push @path, "" if $name =~ /::/; # Empty path to check name on its own first
+ push @path, @_ if @_;
+
+ foreach (@path) {
+ my $module = $_ ? "$_\::$name" : $name;
+ my $file = $module; $file =~ s[::][/]g; $file .= ".pm";
+ __PACKAGE__->debug("Loading $name as $file\n");
+ return $module if $INC{$file}; # Already loaded
+
+ eval { require $file };
+ next if $@ =~ /Can't locate $file in \@INC/;
+ eval { $module->import() } unless $@;
+ return __PACKAGE__->error("Error loading $name as $module : $@")
+ if $@ && $@ !~ /"SQL::Translator::Producer" is not exported/;
+
+ return $module; # Module loaded ok
+ }
- eval {
- require $module;
- $module->import(@_);
- };
+ return __PACKAGE__->error("Can't find module $name. Path:".join(",",@path));
+}
- return __PACKAGE__->error($@) if ($@);
- return 1;
+# ----------------------------------------------------------------------
+# Load the sub name given (including package), optionally using a base package
+# path. Returns code ref and name of sub loaded, including its package.
+# (\&code, $sub) = load_sub( 'MySQL::produce', "SQL::Translator::Producer" );
+# (\&code, $sub) = load_sub( 'MySQL::produce', @path );
+# ----------------------------------------------------------------------
+sub _load_sub {
+ my ($tool, @path) = @_;
+
+ my (undef,$module,$func_name) = $tool =~ m/((.*)::)?(\w+)$/;
+ if ( my $module = load($module => @path) ) {
+ my $sub = "$module\::$func_name";
+ return wantarray ? ( \&{ $sub }, $sub ) : \&$sub;
+ }
+ return undef;
}
# ----------------------------------------------------------------------
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 $field = shift;
+ my @args = @_;
- if ( ref $_[0] eq 'CODE' ) {
- $self->{'_format_pk_name'} = shift;
+ if (ref($args[0]) eq 'CODE') {
+ $self->{$field} = shift @args;
}
-
- if ( @_ ) {
- if ( defined $self->{'_format_pk_name'} ) {
- return $self->{'_format_pk_name'}->( @_ );
- }
- else {
- return '';
- }
+ elsif (! exists $self->{$field}) {
+ $self->{$field} = sub { return shift };
}
- return $self->{'_format_pk_name'};
+ return @args ? $self->{$field}->(@args) : $self->{$field};
}
# ----------------------------------------------------------------------
}
# ----------------------------------------------------------------------
+# version
+#
+# Returns the $VERSION of the main SQL::Translator package.
+# ----------------------------------------------------------------------
+sub version {
+ my $self = shift;
+ return $VERSION;
+}
+
+# ----------------------------------------------------------------------
sub validate {
my ( $self, $arg ) = @_;
if ( defined $arg ) {
# Print debug info
debug => 1,
# Print Parse::RecDescent trace
- trace => 0,
+ trace => 0,
# Don't include comments in output
- no_comments => 0,
+ no_comments => 0,
# Print name mutations, conflicts
- show_warnings => 0,
+ show_warnings => 0,
# Add "drop table" statements
- add_drop_table => 1,
+ add_drop_table => 1,
+ # to quote or not to quote, thats the question
+ quote_table_names => 1,
+ quote_field_names => 1,
# Validate schema object
- validate => 1,
+ validate => 1,
# 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
from => 'MySQL',
to => 'Oracle',
# Or an arrayref of filenames, i.e. [ $file1, $file2, $file3 ]
- filename => $file,
+ filename => $file,
) or die $translator->error;
print $output;
=head1 DESCRIPTION
+This documentation covers the API for SQL::Translator. For a more general
+discussion of how to use the modules and scripts, please see
+L<SQL::Translator::Manual>.
+
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),
=item *
+filters
+
+=item *
+
filename / file
=item *
=item *
+quote_table_names
+
+=item *
+
+quote_field_names
+
+=item *
+
no_comments
=item *
Toggles whether or not to add "DROP TABLE" statements just before the
create definitions.
+=head2 quote_table_names
+
+Toggles whether or not to quote table names with " in DROP and CREATE
+statements. The default (true) is to quote them.
+
+=head2 quote_field_names
+
+Toggles whether or not to quote field names with " in most
+statements. The default (true), is to quote them.
+
=head2 no_comments
Toggles whether to print comments in the output. Accepts a true or false
The C<producer> 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<not a method>)
-and passed 2 parameters: its container C<SQL::Translator> instance and a
-data structure. It is expected that the function transform the data
-structure to a string. The C<SQL::Transformer> instance is provided for
-informational purposes; for example, the type of the parser can be
+and passed its container C<SQL::Translator> instance, which it should
+call the C<schema> method on, to get the C<SQL::Translator::Schema>
+generated by the parser. It is expected that the function transform the
+schema structure to a string. The C<SQL::Translator> instance is also useful
+for informational purposes; for example, the type of the parser can be
retrieved using the C<parser_type> method, and the C<error> and
C<debug> methods can be called when needed.
There is also C<parser_type> and C<parser_args>, which perform
analogously to C<producer_type> and C<producer_args>
+=head2 filters
+
+Set or retreive the filters to run over the schema during the
+translation, before the producer creates its output. Filters are sub
+routines called, in order, with the schema object to filter as the 1st
+arg and a hash of options (passed as a list) for the rest of the args.
+They are free to do whatever they want to the schema object, which will be
+handed to any following filters, then used by the producer.
+
+Filters are set as an array, which gives the order they run in.
+Like parsers and producers, they can be defined by a module name, a
+module name relative to the SQL::Translator::Filter namespace, a module
+name and function name together or a reference to an anonymous subroutine.
+When using a module name a function called C<filter> will be invoked in
+that package to do the work.
+
+To pass args to the filter set it as an array ref with the 1st value giving
+the filter (name or sub) and the rest its args. e.g.
+
+ $tr->filters(
+ sub {
+ my $schema = shift;
+ # Do stuff to schema here!
+ },
+ DropFKeys,
+ [ "Names", table => 'lc' ],
+ [ "Foo", foo => "bar", hello => "world" ],
+ [ "Filter5" ],
+ );
+
+Although you normally set them in the constructor, which calls
+through to filters. i.e.
+
+ my $translator = SQL::Translator->new(
+ ...
+ filters => [
+ sub { ... },
+ [ "Names", table => 'lc' ],
+ ],
+ ...
+ );
+
+See F<t/36-filters.t> for more examples.
+
+Multiple set calls to filters are cumulative with new filters added to
+the end of the current list.
+
+Returns the filters as a list of array refs, the 1st value being a
+reference to the filter sub and the rest its args.
+
=head2 show_warnings
Toggles whether to print warnings of name conflicts, identifier
=head2 translate
-The C<translate> method calls the subroutines referenced by the
-C<parser> and C<producer> 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<parser> and C<producer> methods).
+The C<translate> method calls the subroutine referenced by the
+C<parser> data member, then calls any C<filters> and finally calls
+the C<producer> sub routine (these members are 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<parser> and C<producer> methods).
Here is how the parameter list to C<translate> is parsed:
Whether or not to validate the schema object after parsing and before
producing.
+=head2 version
+
+Returns the version of the SQL::Translator release.
+
=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>,
-Sam Angiuoli E<lt>angiuoli@users.sourceforge.netE<gt>,
-Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
-Mike Mellilo <mmelillo@users.sourceforge.net>.
+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 * Anders Nor Berle <berle@cpan.org>
+
+=item * Dave Cash <dave@gnofn.org>
+
+=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>
+
+=item * Daniel Ruoso <daniel@ruoso.com>
+
+=item * Ryan D Johnson <ryan@innerfence.com>
+
+=item * Jonathan Yu <frequency@cpan.org>
+
+=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<GD>,
L<GraphViz>,
L<Text::RecordParser>,
-L<Class::DBI>
+L<Class::DBI>,
L<XML::Writer>.
projects / dbsrgits/SQL-Translator.git / blobdiff