package SQL::Translator;
#-----------------------------------------------------
-# $Id: Translator.pm,v 1.3.2.1 2002-03-07 14:14:48 dlc Exp $
+# $Id: Translator.pm,v 1.3.2.2 2002-03-15 20:13:46 dlc Exp $
#-----------------------------------------------------
-# Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
-# darren chamberlain <darren@cpan.org>
+# Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
+# darren chamberlain <darren@cpan.org>
#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as
-# published by the Free Software Foundation; version 2.
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2.
#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# 02111-1307 USA
# -------------------------------------------------------------------
=head1 NAME
use SQL::Translator;
my $translator = SQL::Translator->new;
- my $output = $translator->translate(
- parser => 'mysql',
- producer => 'oracle',
- file => $file,
- ) or die $translator->error;
+ $translator->parser("MySQL");
+ $translator->producer("Oracle");
+
+ my $output = $translator->translate($file) or die $translator->error;
print $output;
=head1 DESCRIPTION
conversion process. So, if you wanted PostgreSQL-to-Oracle, you could
just write the PostgreSQL parser and use an existing Oracle producer.
-Currently, the existing parsers use Parse::RecDescent, and the
-producers are just printing formatted output of the parsed data
-structure. New parsers don't necessarily have to use
-Parse::RecDescent, however, as long as the data structure conforms to
-what the producers are expecting. With this separation of code, it is
+Currently, the existing parsers use Parse::RecDescent, but this not
+a requirement, or even a recommendation. New parser modules don't
+necessarily have to use Parse::RecDescent, as long as the module
+implements the appropriate API. With this separation of code, it is
hoped that developers will find it easy to add more database dialects
by using what's written, writing only what they need, and then
contributing their parsers or producers back to the project.
use strict;
use vars qw($VERSION $DEFAULT_SUB $DEBUG);
-$VERSION = sprintf "%d.%02d", q$Revision: 1.3.2.1 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.3.2.2 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 1 unless defined $DEBUG;
$DEFAULT_SUB = sub { $_[0] } unless defined $DEFAULT_SUB;
+
+*can = \&UNIVERSAL::can;
*isa = \&UNIVERSAL::isa;
=head1 CONSTRUCTOR
-The constructor is called B<new>, and accepts a hash of options.
+The constructor is called B<new>, and accepts a optional hash of options.
Valid options are:
=over 4
The B<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 subroutine will be invoked as a function (not a
-method) and passed a data structure as its only argument. It is
-expected that the function transform the data structure to the output
-format, and return a string.
+method) and passed 2 parameters: its encompassing SQL::Translator
+instance and a data structure. It is expected that the function
+transform the data structure to the output format, and return a
+string. The SQL::Transformer instance is provided for informational
+purposes; the type of the parser, for example, can be retrieved using
+the B<parser_type> method, and the B<error> and B<debug> methods can
+be called when needed.
When defining a producer, one of three things can be passed
in: A full module name (e.g., My::Groovy::Parser), a module name
relative to the SQL::Translator::Producer namespace (e.g., MySQL), or
a reference to an anonymous subroutine. If a full module name is
passed in, it is treated as a package, and a function called
-"transform" will be invoked as $modulename::transform.
+"produce" will be invoked as $modulename::produce.
my $tr = SQL::Translator->new;
- # This will invoke My::Groovy::Producer::transform($data)
+ # This will invoke My::Groovy::Producer::produce($tr, $data)
$tr->producer("My::Groovy::Producer");
- # This will invoke SQL::Translator::Producer::Sybase::transform($data)
+ # This will invoke SQL::Translator::Producer::Sybase::produce($tr, $data)
$tr->producer("Sybase");
- # This will inoke the referenced subroutine directly
+ # This will invoke the referenced subroutine directly, as
+ # $subref->($tr, $data);
$tr->producer(\&my_producer);
+There is also a method named B<producer_type>, which is a string
+containing the classname to which the above B<produce> function
+belongs. In the case of anonymous subroutines, this method returns
+the string "CODE".
+
=cut
-# TODO Make mod_perl-like assumptions about the name being passed in:
-# try to load the module; if that fails, pop off the last piece
-# (everything after the last ::) and try to load that; if that loads,
-# use the popped off piece as the function name, and not transform.
-# {{{ producer
+# {{{ producer and producer_type
sub producer {
my $self = shift;
if (@_) {
my $producer = shift;
if ($producer =~ /::/) {
- load($producer) or die "Can't load $producer: $@";
- $self->{'producer'} = \&{ "$producer\::'producer'" };
- $self->debug("Got 'producer': $producer\::'producer'");
+ my $func_name;
+ if (load($producer)) {
+ $func_name = "produce";
+ } else {
+ # Oops! Passed Module::Name::function; try to recover
+ my @func_parts = split /::/, $producer;
+ $func_name = pop @func_parts;
+ $producer = join "::", @func_parts;
+ load($producer) or die "Can't load $producer: $@";
+ }
+
+ $self->{'producer'} = \&{ "$producer\::$func_name" };
+ $self->{'producer_type'} = $producer;
+ $self->debug("Got 'producer': $producer\::$func_name");
} elsif (isa($producer, 'CODE')) {
$self->{'producer'} = $producer;
+ $self->{'producer_type'} = "CODE";
$self->debug("Got 'producer': code ref");
} else {
my $Pp = sprintf "SQL::Translator::Producer::$producer";
load($Pp) or die "Can't load $Pp: $@";
- $self->{'producer'} = \&{ "$Pp\::translate" };
+ $self->{'producer'} = \&{ "$Pp\::produce" };
+ $self->{'producer_type'} = $Pp;
$self->debug("Got producer: $Pp");
}
# At this point, $self->{'producer'} contains a subroutine
}
return $self->{'producer'};
};
+
+sub producer_type { $_[0]->{'producer_type'} }
# }}}
=head2 B<parser>
The B<parser> method defines or retrieves a subroutine that will be
called to perform the parsing. The basic idea is the same as that of
B<producer> (see above), except the default subroutine name is
-"parse", and will be invoked as $module_name::parse. Also, the parser
-subroutine will be passed a string containing the entirety of the data
-to be parsed.
+"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 (or possibly a reference to a string?).
# Invokes SQL::Translator::Parser::MySQL::parse()
$tr->parser("MySQL");
# Invoke an anonymous subroutine directly
$tr->parser(sub {
- my $dumper = Data::Dumper->new([ $_[0] ], [ "SQL" ]);
+ my $dumper = Data::Dumper->new([ $_[1] ], [ "SQL" ]);
$dumper->Purity(1)->Terse(1)->Deepcopy(1);
return $dumper->Dump;
});
=cut
-# {{{ parser
+# {{{ parser and parser_type
sub parser {
my $self = shift;
if (@_) {
if ($parser =~ /::/) {
load($parser) or die "Can't load $parser: $@";
$self->{'parser'} = \&{ "$parser\::parse" };
+ $self->{'parser_type'} = $parser;
$self->debug("Got parser: $parser\::parse");
} elsif (isa($parser, 'CODE')) {
$self->{'parser'} = $parser;
+ $self->{'parser_type'} = "CODE";
$self->debug("Got parser: code ref");
} 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");
}
# At this point, $self->{$pp} contains a subroutine
}
return $self->{'parser'};
}
+
+sub parser_type { $_[0]->{'parser_type'} }
# }}}
=head2 B<translate>
=item *
-> 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 GLOB or SCALAR reference).
+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 GLOB or
+SCALAR reference).
# As above, parse /path/to/datafile, but with different producers
for my $prod ("MySQL", "XML", "Sybase") {
if (@_ == 1) {
if (isa($_[0], 'HASH')) {
# Passed a hashref
+ $self->debug("translate: Got a hashref");
$args = $_[0];
}
+ elsif (my $getlines = can($_[0], "getlines")) {
+ # passed a IO::Handle derivative
+ # XXX Something about this does not work!
+ # XXX look into how Template does this.
+ $self->debug("translate: Got a IO::Handle subclass (can getlines)");
+ my $fh = $_[0];
+ $fh->setpos(0);
+ my $data = join '', $fh->$getlines;
+ $args = { data => $data };
+ }
elsif (isa($_[0], 'GLOB')) {
# passed a filehandle; slurp it
+ $self->debug("translate: Got a GLOB");
local $/;
$args = { data => <$_[0]> };
}
elsif (isa($_[0], 'SCALAR')) {
# passed a ref to a string; deref it
+ $self->debug("translate: Got a SCALAR reference (string)");
$args = { data => ${$_[0]} };
}
else {
# Not a ref, it's a filename
+ $self->debug("translate: Got a filename");
$args = { filename => $_[0] };
}
}
local *FH;
local $/;
- open FH, $args->{'filename'} or die $!;
+ open FH, $args->{'filename'} or die "Can't open $args->{'filename'}: $!";
$args->{'data'} = <FH>;
close FH or die $!;
}
#
return unless defined $args->{'data'};
+ use Data::Dumper;
+ warn Dumper($args);
+
#
# Local reference to the parser subroutine
#
#
# Execute the parser, then execute the producer with that output
#
- my $translated = $parser->($args->{'data'});
+ my $translated = $parser->($self, $args->{'data'});
- return $producer->($translated);
+ return $producer->($self, $translated);
}
# }}}
package SQL::Translator::Parser;
-#-----------------------------------------------------
-# $Id: Parser.pm,v 1.1.1.1 2002-03-01 02:26:25 kycl4rk Exp $
+# ----------------------------------------------------------------------
+# $Id: Parser.pm,v 1.1.1.1.2.1 2002-03-15 20:13:46 dlc Exp $
+# ----------------------------------------------------------------------
+# Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
+# darren chamberlain <darren@cpan.org>
#
-# File : SQL/Translator/Parser.pm
-# Programmer : Ken Y. Clark, kclark@logsoft.com
-# Created : 2002/02/27
-# Purpose : base object for parsers
-#-----------------------------------------------------
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# 02111-1307 USA
+# ----------------------------------------------------------------------
use strict;
use vars qw( $VERSION );
-$VERSION = (qw$Revision: 1.1.1.1 $)[-1];
-
-use Parse::RecDescent;
-use SQL::Translator;
-use base qw[ SQL::Translator ];
+$VERSION = sprintf "%d.%02d", q$Revision: 1.1.1.1.2.1 $ =~ /(\d+)\.(\d+)/;
-sub parse {
-#
-# Override this method if you intend not to use Parse::RecDescent
-#
- my $self = shift;
- return $self->parser->file( shift() );
-}
-
-sub parser {
- my $self = shift;
- unless ( $self->{'parser'} ) {
- $self->{'parser'} = Parse::RecDescent->new( $self->grammar );
- }
- return $self->{'parser'};
-}
+sub parse { "" }
1;
SQL::Translator::Parser - base object for parsers
-=head1 SYNOPSIS
-
- package SQL::Translator::Parser::Foo;
- use SQL::Translator::Parser;
- use base( 'SQL::Translator::Parser' );
- 1;
-
=head1 DESCRIPTION
-Blah blah blah.
+Parser modules that get invoked by SQL::Translator need to implement
+a single function: B<parse>. This function will be called by the
+SQL::Translator instance as $class::parse($data_as_string). Other
+than that, the classes are free to define any helper functions, or
+use any design pattern internally that make the most sense.
=head1 AUTHOR
package SQL::Translator::Parser::MySQL;
#-----------------------------------------------------
-# $Id: MySQL.pm,v 1.1.1.1 2002-03-01 02:26:25 kycl4rk Exp $
-#
-# File : SQL::Translator::Parser::MySQL
-# Programmer : Ken Y. Clark, kclark@logsoft.com
-# Created : 2002/02/27
-# Purpose : parser for MySQL
+# $Id: MySQL.pm,v 1.1.1.1.2.1 2002-03-15 20:13:46 dlc Exp $
#-----------------------------------------------------
+# Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
+# darren chamberlain <darren@cpan.org>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# 02111-1307 USA
+# -------------------------------------------------------------------
use strict;
-use vars qw( $VERSION );
-$VERSION = (qw$Revision: 1.1.1.1 $)[-1];
-
-use SQL::Translator::Parser;
-use base qw[ SQL::Translator::Parser ];
+use vars qw($VERSION $GRAMMAR @EXPORT_OK);
+$VERSION = sprintf "%d.%02d", q$Revision: 1.1.1.1.2.1 $ =~ /(\d+)\.(\d+)/;
+
+#use SQL::Translator::Parser; # This is not necessary!
+use Parse::RecDescent;
+use Exporter;
+use base qw(Exporter);
+
+@EXPORT_OK = qw(parse);
+
+my $parser; # should we do this? There's no programmic way to
+ # change the grammar, so I think this is safe.
+sub parse {
+ my ( $translator, $data ) = @_;
+ $parser ||= Parse::RecDescent->new($GRAMMAR);
+
+ unless (defined $parser) {
+ $translator->error_out("Error instantiating Parse::RecDescent ".
+ "instance: Bad grammer");
+ return;
+ }
+
+ # Is this right? It was $parser->parse before, but that didn't
+ # work; Parse::RecDescent appears to need the name of a rule
+ # with which to begin, so I chose the first rule in the grammar.
+ return $parser->file($data);
+}
-sub grammar {
- q{
+$GRAMMAR =
+ q!
{ our ( %tables ) }
file : statement(s) { \%tables }
COMMA : ','
- };
-}
+ !;
1;
=head1 SYNOPSIS
+ use SQL::Translator;
use SQL::Translator::Parser::MySQL;
+ my $translator = SQL::Translator->new;
+ $translator->parser("SQL::Translator::Parser::MySQL");
+
=head1 DESCRIPTION
Blah blah blah.
package SQL::Translator::Producer::Oracle;
-#-----------------------------------------------------
-# $Id: Oracle.pm,v 1.1.1.1 2002-03-01 02:26:25 kycl4rk Exp $
+# -------------------------------------------------------------------
+# $Id: Oracle.pm,v 1.1.1.1.2.1 2002-03-15 20:13:46 dlc Exp $
+# -------------------------------------------------------------------
+# Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
+# darren chamberlain <darren@cpan.org>
#
-# File : SQL/Translator/Producer/Oracle.pm
-# Programmer : Ken Y. Clark, kclark@logsoft.com
-# Created : 2002/02/27
-# Purpose : Oracle SQL producer
-#-----------------------------------------------------
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# 02111-1307 USA
+# -------------------------------------------------------------------
+
use strict;
-use SQL::Translator::Producer;
use vars qw( $VERSION );
-$VERSION = (qw$Revision: 1.1.1.1 $)[-1];
-
-use base qw[ SQL::Translator::Producer ];
+$VERSION = sprintf "%d.%02d", q$Revision: 1.1.1.1.2.1 $ =~ /(\d+)\.(\d+)/;
my $max_identifier_length = 30;
my %used_identifiers = ();
year => 'date',
);
-sub to { 'Oracle' }
+# This is for testing only, and probably needs to be removed
+*translate = *produce;
-sub translate {
- my ( $self, $data ) = @_;
+sub produce {
+ my ( $translator, $data ) = @_;
#print "got ", scalar keys %$data, " tables:\n";
#print join(', ', keys %$data), "\n";
#
# Output
#
- my $output = $self->header;
+ my $output = sprintf "
+#
+# Created by %s, version %s
+# Datasource: %s
+#
+
+", __PACKAGE__, $VERSION, $translator->parser_type;
#
# Print create for each table
=head1 SYNOPSIS
+ use SQL::Translator::Parser::MySQL;
use SQL::Translator::Producer::Oracle;
+ my $original_create = ""; # get this from somewhere...
+ my $translator = SQL::Translator->new;
+
+ $translator->parser("SQL::Translator::Parser::MySQL");
+ $translator->producer("SQL::Translator::Producer::Oracle");
+
+ my $new_create = $translator->translate($original_create);
+
=head1 DESCRIPTION
-Blah blah blah.
+SQL::Translator::Producer::Oracle takes a parsed data structure,
+created by a SQL::Translator::Parser subclass, and turns it into a
+create string suitable for use with an Oracle database.
=head1 AUTHOR
projects / dbsrgits/SQL-Translator.git / commitdiff