1 package SQL::Translator;
3 # ----------------------------------------------------------------------
4 # $Id: Translator.pm,v 1.64 2005-04-13 20:34:20 allenday Exp $
5 # ----------------------------------------------------------------------
6 # Copyright (C) 2002-4 The SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
24 use vars qw( $VERSION $REVISION $DEFAULT_SUB $DEBUG $ERROR );
25 use base 'Class::Base';
30 $REVISION = sprintf "%d.%02d", q$Revision: 1.64 $ =~ /(\d+)\.(\d+)/;
31 $DEBUG = 0 unless defined $DEBUG;
39 use File::Spec::Functions qw(catfile);
40 use File::Basename qw(dirname);
42 use SQL::Translator::Schema;
44 # ----------------------------------------------------------------------
45 # The default behavior is to "pass through" values (note that the
46 # SQL::Translator instance is the first value ($_[0]), and the stuff
47 # to be parsed is the second value ($_[1])
48 # ----------------------------------------------------------------------
49 $DEFAULT_SUB = sub { $_[0]->schema } unless defined $DEFAULT_SUB;
51 # ----------------------------------------------------------------------
55 # new takes an optional hash of arguments. These arguments may
56 # include a parser, specified with the keys "parser" or "from",
57 # and a producer, specified with the keys "producer" or "to".
59 # The values that can be passed as the parser or producer are
60 # given directly to the parser or producer methods, respectively.
61 # See the appropriate method description below for details about
62 # what each expects/accepts.
63 # ----------------------------------------------------------------------
65 my ( $self, $config ) = @_;
67 # Set the parser and producer.
69 # If a 'parser' or 'from' parameter is passed in, use that as the
70 # parser; if a 'producer' or 'to' parameter is passed in, use that
71 # as the producer; both default to $DEFAULT_SUB.
73 $self->parser ($config->{'parser'} || $config->{'from'} || $DEFAULT_SUB);
74 $self->producer($config->{'producer'} || $config->{'to'} || $DEFAULT_SUB);
77 # Set up callbacks for formatting of pk,fk,table,package names in producer
78 # MOVED TO PRODUCER ARGS
80 #$self->format_table_name($config->{'format_table_name'});
81 #$self->format_package_name($config->{'format_package_name'});
82 #$self->format_fk_name($config->{'format_fk_name'});
83 #$self->format_pk_name($config->{'format_pk_name'});
86 # Set the parser_args and producer_args
88 for my $pargs ( qw[ parser_args producer_args ] ) {
89 $self->$pargs( $config->{$pargs} ) if defined $config->{ $pargs };
93 # Initialize the filters.
95 if ( $config->{filters} && ref $config->{filters} eq "ARRAY" ) {
96 $self->filters( @{$config->{filters}} )
97 || return $self->error('Error inititializing filters: '.$self->error);
101 # Set the data source, if 'filename' or 'file' is provided.
103 $config->{'filename'} ||= $config->{'file'} || "";
104 $self->filename( $config->{'filename'} ) if $config->{'filename'};
107 # Finally, if there is a 'data' parameter, use that in
108 # preference to filename and file
110 if ( my $data = $config->{'data'} ) {
111 $self->data( $data );
115 # Set various other options.
117 $self->{'debug'} = defined $config->{'debug'} ? $config->{'debug'} : $DEBUG;
119 $self->add_drop_table( $config->{'add_drop_table'} );
121 $self->no_comments( $config->{'no_comments'} );
123 $self->show_warnings( $config->{'show_warnings'} );
125 $self->trace( $config->{'trace'} );
127 $self->validate( $config->{'validate'} );
132 # ----------------------------------------------------------------------
133 # add_drop_table([$bool])
134 # ----------------------------------------------------------------------
137 if ( defined (my $arg = shift) ) {
138 $self->{'add_drop_table'} = $arg ? 1 : 0;
140 return $self->{'add_drop_table'} || 0;
143 # ----------------------------------------------------------------------
144 # no_comments([$bool])
145 # ----------------------------------------------------------------------
149 if ( defined $arg ) {
150 $self->{'no_comments'} = $arg ? 1 : 0;
152 return $self->{'no_comments'} || 0;
156 # ----------------------------------------------------------------------
157 # producer([$producer_spec])
159 # Get or set the producer for the current translator.
160 # ----------------------------------------------------------------------
164 path => "SQL::Translator::Producer",
165 default_sub => "produce",
169 # ----------------------------------------------------------------------
172 # producer_type is an accessor that allows producer subs to get
173 # information about their origin. This is poptentially important;
174 # since all producer subs are called as subroutine references, there is
175 # no way for a producer to find out which package the sub lives in
176 # originally, for example.
177 # ----------------------------------------------------------------------
178 sub producer_type { $_[0]->{'producer_type'} }
180 # ----------------------------------------------------------------------
181 # producer_args([\%args])
183 # Arbitrary name => value pairs of paramters can be passed to a
184 # producer using this method.
186 # If the first argument passed in is undef, then the hash of arguments
187 # is cleared; all subsequent elements are added to the hash of name,
188 # value pairs stored as producer_args.
189 # ----------------------------------------------------------------------
190 sub producer_args { shift->_args("producer", @_); }
192 # ----------------------------------------------------------------------
193 # parser([$parser_spec])
194 # ----------------------------------------------------------------------
198 path => "SQL::Translator::Parser",
199 default_sub => "parse",
203 sub parser_type { $_[0]->{'parser_type'}; }
205 sub parser_args { shift->_args("parser", @_); }
207 # ----------------------------------------------------------------------
209 # $sqlt->filters => [
211 # [ "NormalizeNames", field => "lc", tabel => "ucfirst" ],
214 # "TEXT" => "BIGTEXT",
217 # ----------------------------------------------------------------------
220 my $filters = $self->{filters} ||= [];
221 return @$filters unless @_;
223 # Set. Convert args to list of [\&code,\%args]
225 $_ = [$_,{}] if not ref($_) eq "ARRAY";
226 my ($name,$args) = @$_;
227 if ( isa($name,"CODE") ) {
232 $self->debug("Adding $name filter. Args:".Dumper($args)."\n");
233 my $code = _load_sub("$name\::filter", "SQL::Translator::Filter");
234 return $self->error("ERROR:".$self->error) unless $code;
235 push @$filters, [$code,$args];
241 # ----------------------------------------------------------------------
245 if ( defined $arg ) {
246 $self->{'show_warnings'} = $arg ? 1 : 0;
248 return $self->{'show_warnings'} || 0;
252 # filename - get or set the filename
256 my $filename = shift;
258 my $msg = "Cannot use directory '$filename' as input source";
259 return $self->error($msg);
260 } elsif (ref($filename) eq 'ARRAY') {
261 $self->{'filename'} = $filename;
262 $self->debug("Got array of files: ".join(', ',@$filename)."\n");
263 } elsif (-f _ && -r _) {
264 $self->{'filename'} = $filename;
265 $self->debug("Got filename: '$self->{'filename'}'\n");
267 my $msg = "Cannot use '$filename' as input source: ".
268 "file does not exist or is not readable.";
269 return $self->error($msg);
276 # ----------------------------------------------------------------------
279 # if $self->{'data'} is not set, but $self->{'filename'} is, then
280 # $self->{'filename'} is opened and read, with the results put into
282 # ----------------------------------------------------------------------
286 # Set $self->{'data'} based on what was passed in. We will
287 # accept a number of things; do our best to get it right.
290 if (isa($data, "SCALAR")) {
291 $self->{'data'} = $data;
294 if (isa($data, 'ARRAY')) {
295 $data = join '', @$data;
297 elsif (isa($data, 'GLOB')) {
301 elsif (! ref $data && @_) {
302 $data = join '', $data, @_;
304 $self->{'data'} = \$data;
308 # If we have a filename but no data yet, populate.
309 if (not $self->{'data'} and my $filename = $self->filename) {
310 $self->debug("Opening '$filename' to get contents.\n");
315 my @files = ref($filename) eq 'ARRAY' ? @$filename : ($filename);
317 foreach my $file (@files) {
318 unless (open FH, $file) {
319 return $self->error("Can't read file '$file': $!");
325 return $self->error("Can't close file '$file': $!");
329 $self->{'data'} = \$data;
332 return $self->{'data'};
335 # ----------------------------------------------------------------------
338 # Deletes the existing Schema object so that future calls to translate
339 # don't append to the existing.
342 $self->{'schema'} = undef;
346 # ----------------------------------------------------------------------
349 # Returns the SQL::Translator::Schema object
353 unless ( defined $self->{'schema'} ) {
354 $self->{'schema'} = SQL::Translator::Schema->new(
359 return $self->{'schema'};
362 # ----------------------------------------------------------------------
366 if ( defined $arg ) {
367 $self->{'trace'} = $arg ? 1 : 0;
369 return $self->{'trace'} || 0;
372 # ----------------------------------------------------------------------
373 # translate([source], [\%args])
375 # translate does the actual translation. The main argument is the
376 # source of the data to be translated, which can be a filename, scalar
377 # reference, or glob reference.
379 # Alternatively, translate takes optional arguements, which are passed
380 # to the appropriate places. Most notable of these arguments are
381 # parser and producer, which can be used to set the parser and
382 # producer, respectively. This is the applications last chance to set
385 # translate returns a string.
386 # ----------------------------------------------------------------------
389 my ($args, $parser, $parser_type, $producer, $producer_type);
390 my ($parser_output, $producer_output);
394 # Passed a reference to a hash?
395 if (isa($_[0], 'HASH')) {
397 $self->debug("translate: Got a hashref\n");
401 # Passed a GLOB reference, i.e., filehandle
402 elsif (isa($_[0], 'GLOB')) {
403 $self->debug("translate: Got a GLOB reference\n");
407 # Passed a reference to a string containing the data
408 elsif (isa($_[0], 'SCALAR')) {
409 # passed a ref to a string
410 $self->debug("translate: Got a SCALAR reference (string)\n");
414 # Not a reference; treat it as a filename
415 elsif (! ref $_[0]) {
416 # Not a ref, it's a filename
417 $self->debug("translate: Got a filename\n");
418 $self->filename($_[0]);
421 # Passed something else entirely.
423 # We're not impressed. Take your empty string and leave.
426 # Actually, if data, parser, and producer are set, then we
427 # can continue. Too bad, because I like my comment
429 return "" unless ($self->data &&
435 # You must pass in a hash, or you get nothing.
440 # ----------------------------------------------------------------------
441 # Can specify the data to be transformed using "filename", "file",
442 # "data", or "datasource".
443 # ----------------------------------------------------------------------
444 if (my $filename = ($args->{'filename'} || $args->{'file'})) {
445 $self->filename($filename);
448 if (my $data = ($args->{'data'} || $args->{'datasource'})) {
452 # ----------------------------------------------------------------
454 # ----------------------------------------------------------------
455 my $data = $self->data;
457 # ----------------------------------------------------------------
458 # Local reference to the parser subroutine
459 # ----------------------------------------------------------------
460 if ($parser = ($args->{'parser'} || $args->{'from'})) {
461 $self->parser($parser);
463 $parser = $self->parser;
464 $parser_type = $self->parser_type;
466 # ----------------------------------------------------------------
467 # Local reference to the producer subroutine
468 # ----------------------------------------------------------------
469 if ($producer = ($args->{'producer'} || $args->{'to'})) {
470 $self->producer($producer);
472 $producer = $self->producer;
473 $producer_type = $self->producer_type;
475 # ----------------------------------------------------------------
476 # Execute the parser, the filters and then execute the producer.
477 # Allowances are made for each piece to die, or fail to compile,
478 # since the referenced subroutines could be almost anything. In
479 # the future, each of these might happen in a Safe environment,
480 # depending on how paranoid we want to be.
481 # ----------------------------------------------------------------
484 unless ( defined $self->{'schema'} ) {
485 eval { $parser_output = $parser->($self, $$data) };
486 if ($@ || ! $parser_output) {
487 my $msg = sprintf "translate: Error with parser '%s': %s",
488 $parser_type, ($@) ? $@ : " no results";
489 return $self->error($msg);
492 $self->debug("Schema =\n", Dumper($self->schema), "\n");
494 # Validate the schema if asked to.
495 if ($self->validate) {
496 my $schema = $self->schema;
497 return $self->error('Invalid schema') unless $schema->is_valid;
502 foreach ($self->filters) {
504 my ($code,$args) = @$_;
505 eval { $code->($self->schema, $args) };
506 my $err = $@ || $self->error || 0;
507 return $self->error("Error with filter $filt_num : $err") if $err;
511 eval { $producer_output = $producer->($self) };
512 if ($@ || ! $producer_output) {
513 my $err = $@ || $self->error || "no results";
514 my $msg = "translate: Error with producer '$producer_type': $err";
515 return $self->error($msg);
518 return $producer_output;
521 # ----------------------------------------------------------------------
524 # Hacky sort of method to list all available parsers. This has
527 # - Only finds things in the SQL::Translator::Parser namespace
529 # - Only finds things that are located in the same directory
530 # as SQL::Translator::Parser. Yeck.
532 # This method will fail in several very likely cases:
534 # - Parser modules in different namespaces
536 # - Parser modules in the SQL::Translator::Parser namespace that
537 # have any XS componenets will be installed in
538 # arch_lib/SQL/Translator.
540 # ----------------------------------------------------------------------
542 return shift->_list("parser");
545 # ----------------------------------------------------------------------
548 # See notes for list_parsers(), above; all the problems apply to
549 # list_producers as well.
550 # ----------------------------------------------------------------------
552 return shift->_list("producer");
556 # ======================================================================
558 # ======================================================================
560 # ----------------------------------------------------------------------
561 # _args($type, \%args);
563 # Gets or sets ${type}_args. Called by parser_args and producer_args.
564 # ----------------------------------------------------------------------
568 $type = "${type}_args" unless $type =~ /_args$/;
570 unless (defined $self->{$type} && isa($self->{$type}, 'HASH')) {
571 $self->{$type} = { };
575 # If the first argument is an explicit undef (remember, we
576 # don't get here unless there is stuff in @_), then we clear
577 # out the producer_args hash.
578 if (! defined $_[0]) {
580 %{$self->{$type}} = ();
583 my $args = isa($_[0], 'HASH') ? shift : { @_ };
584 %{$self->{$type}} = (%{$self->{$type}}, %$args);
590 # ----------------------------------------------------------------------
591 # Does the get/set work for parser and producer. e.g.
592 # return $self->_tool({
593 # name => 'producer',
594 # path => "SQL::Translator::Producer",
595 # default_sub => "produce",
597 # ----------------------------------------------------------------------
599 my ($self,$args) = (shift, shift);
600 my $name = $args->{name};
601 return $self->{$name} unless @_; # get accessor
603 my $path = $args->{path};
604 my $default_sub = $args->{default_sub};
607 # passed an anonymous subroutine reference
608 if (isa($tool, 'CODE')) {
609 $self->{$name} = $tool;
610 $self->{"$name\_type"} = "CODE";
611 $self->debug("Got $name: code ref\n");
614 # Module name was passed directly
615 # We try to load the name; if it doesn't load, there's a
616 # possibility that it has a function name attached to it,
617 # so we give it a go.
619 $tool =~ s/-/::/g if $tool !~ /::/;
621 ($code,$sub) = _load_sub("$tool\::$default_sub", $path);
623 if ( __PACKAGE__->error =~ m/Can't find module/ ) {
624 # Mod not found so try sub
625 ($code,$sub) = _load_sub("$tool", $path) unless $code;
626 die "Can't load $name subroutine '$tool' : ".__PACKAGE__->error
630 die "Can't load $name '$tool' : ".__PACKAGE__->error;
634 # get code reference and assign
635 my (undef,$module,undef) = $sub =~ m/((.*)::)?(\w+)$/;
636 $self->{$name} = $code;
637 $self->{"$name\_type"} = $sub eq "CODE" ? "CODE" : $module;
638 $self->debug("Got $name: $sub\n");
641 # At this point, $self->{$name} contains a subroutine
642 # reference that is ready to run
644 # Anything left? If so, it's args
645 my $meth = "$name\_args";
646 $self->$meth(@_) if (@_);
648 return $self->{$name};
651 # ----------------------------------------------------------------------
653 # ----------------------------------------------------------------------
656 my $type = shift || return ();
657 my $uctype = ucfirst lc $type;
660 # First find all the directories where SQL::Translator
661 # parsers or producers (the "type") appear to live.
663 load("SQL::Translator::$uctype") or return ();
664 my $path = catfile "SQL", "Translator", $uctype;
667 my $dir = catfile $_, $path;
668 $self->debug("_list_${type}s searching $dir\n");
674 # Now use File::File::find to look recursively in those
675 # directories for all the *.pm files, then present them
676 # with the slashes turned into dashes.
681 if ( -f && m/\.pm$/ ) {
684 my $cur_dir = $File::Find::dir;
685 my $base_dir = quotemeta catfile 'SQL', 'Translator', $uctype;
688 # See if the current directory is below the base directory.
690 if ( $cur_dir =~ m/$base_dir(.*)/ ) {
692 $cur_dir =~ s!^/!!; # kill leading slash
693 $cur_dir =~ s!/!-!g; # turn other slashes into dashes
699 $found{ join '-', map { $_ || () } $cur_dir, $mod } = 1;
705 return sort { lc $a cmp lc $b } keys %found;
708 # ----------------------------------------------------------------------
709 # load(MODULE [,PATH[,PATH]...])
711 # Loads a Perl module. Short circuits if a module is already loaded.
713 # MODULE - is the name of the module to load.
715 # PATH - optional list of 'package paths' to look for the module in. e.g
716 # If you called load(Bar => 'Foo', 'My::Modules') it will try to load the mod
717 # Bar then Foo::Bar then My::Modules::Bar.
719 # Returns package name of the module actually loaded or false and sets error.
721 # Note, you can't load a name from the root namespace (ie one without '::' in
722 # it), therefore a single word name without a path fails.
723 # ----------------------------------------------------------------------
727 push @path, "" if $name =~ /::/; # Empty path to check name on its own first
728 push @path, @_ if @_;
731 my $module = $_ ? "$_\::$name" : $name;
732 my $file = $module; $file =~ s[::][/]g; $file .= ".pm";
733 __PACKAGE__->debug("Loading $name as $file\n");
734 return $module if $INC{$file}; # Already loaded
736 eval { require $file };
737 next if $@ =~ /Can't locate $file in \@INC/;
738 eval { $file->import(@_) } unless $@;
739 return __PACKAGE__->error("Error loading $name as $module : $@") if $@;
741 return $module; # Module loaded ok
744 return __PACKAGE__->error("Can't find module $name. Path:".join(",",@path));
747 # ----------------------------------------------------------------------
748 # Load the sub name given (including package), optionally using a base package
749 # path. Returns code ref and name of sub loaded, including its package.
750 # (\&code, $sub) = load_sub( 'MySQL::produce', "SQL::Translator::Producer" );
751 # (\&code, $sub) = load_sub( 'MySQL::produce', @path );
752 # ----------------------------------------------------------------------
754 my ($tool, @path) = @_;
756 # Passed a module name or module and sub name
757 my (undef,$module,$func_name) = $tool =~ m/((.*)::)?(\w+)$/;
758 if ( my $module = load($module => @path) ) {
759 my $sub = "$module\::$func_name";
760 return wantarray ? ( \&{ $sub }, $sub ) : \&$sub;
765 # ----------------------------------------------------------------------
766 sub format_table_name {
767 return shift->_format_name('_format_table_name', @_);
770 # ----------------------------------------------------------------------
771 sub format_package_name {
772 return shift->_format_name('_format_package_name', @_);
775 # ----------------------------------------------------------------------
777 return shift->_format_name('_format_fk_name', @_);
780 # ----------------------------------------------------------------------
782 return shift->_format_name('_format_pk_name', @_);
785 # ----------------------------------------------------------------------
786 # The other format_*_name methods rely on this one. It optionally
787 # accepts a subroutine ref as the first argument (or uses an identity
788 # sub if one isn't provided or it doesn't already exist), and applies
789 # it to the rest of the arguments (if any).
790 # ----------------------------------------------------------------------
796 if (ref($args[0]) eq 'CODE') {
797 $self->{$field} = shift @args;
799 elsif (! exists $self->{$field}) {
800 $self->{$field} = sub { return shift };
803 return @args ? $self->{$field}->(@args) : $self->{$field};
806 # ----------------------------------------------------------------------
809 # Calls UNIVERSAL::isa($ref, $type). I think UNIVERSAL::isa is ugly,
810 # but I like function overhead.
811 # ----------------------------------------------------------------------
813 my ($ref, $type) = @_;
814 return UNIVERSAL::isa($ref, $type);
817 # ----------------------------------------------------------------------
820 # Returns the $VERSION of the main SQL::Translator package.
821 # ----------------------------------------------------------------------
827 # ----------------------------------------------------------------------
829 my ( $self, $arg ) = @_;
830 if ( defined $arg ) {
831 $self->{'validate'} = $arg ? 1 : 0;
833 return $self->{'validate'} || 0;
838 # ----------------------------------------------------------------------
839 # Who killed the pork chops?
840 # What price bananas?
843 # ----------------------------------------------------------------------
849 SQL::Translator - manipulate structured data definitions (SQL and more)
855 my $translator = SQL::Translator->new(
858 # Print Parse::RecDescent trace
860 # Don't include comments in output
862 # Print name mutations, conflicts
864 # Add "drop table" statements
866 # Validate schema object
868 # Make all table names CAPS in producers which support this option
869 format_table_name => sub {my $tablename = shift; return uc($tablename)},
870 # Null-op formatting, only here for documentation's sake
871 format_package_name => sub {return shift},
872 format_fk_name => sub {return shift},
873 format_pk_name => sub {return shift},
876 my $output = $translator->translate(
879 # Or an arrayref of filenames, i.e. [ $file1, $file2, $file3 ]
881 ) or die $translator->error;
887 This documentation covers the API for SQL::Translator. For a more general
888 discussion of how to use the modules and scripts, please see
889 L<SQL::Translator::Manual>.
891 SQL::Translator is a group of Perl modules that converts
892 vendor-specific SQL table definitions into other formats, such as
893 other vendor-specific SQL, ER diagrams, documentation (POD and HTML),
894 XML, and Class::DBI classes. The main focus of SQL::Translator is
895 SQL, but parsers exist for other structured data formats, including
896 Excel spreadsheets and arbitrarily delimited text files. Through the
897 separation of the code into parsers and producers with an object model
898 in between, it's possible to combine any parser with any producer, to
899 plug in custom parsers or producers, or to manipulate the parsed data
900 via the built-in object model. Presently only the definition parts of
901 SQL are handled (CREATE, ALTER), not the manipulation of data (INSERT,
906 The constructor is called C<new>, and accepts a optional hash of options.
961 All options are, well, optional; these attributes can be set via
962 instance methods. Internally, they are; no (non-syntactical)
963 advantage is gained by passing options to the constructor.
967 =head2 add_drop_table
969 Toggles whether or not to add "DROP TABLE" statements just before the
974 Toggles whether to print comments in the output. Accepts a true or false
975 value, returns the current value.
979 The C<producer> method is an accessor/mutator, used to retrieve or
980 define what subroutine is called to produce the output. A subroutine
981 defined as a producer will be invoked as a function (I<not a method>)
982 and passed its container C<SQL::Translator> instance, which it should
983 call the C<schema> method on, to get the C<SQL::Translator::Schema>
984 generated by the parser. It is expected that the function transform the
985 schema structure to a string. The C<SQL::Translator> instance is also useful
986 for informational purposes; for example, the type of the parser can be
987 retrieved using the C<parser_type> method, and the C<error> and
988 C<debug> methods can be called when needed.
990 When defining a producer, one of several things can be passed in: A
991 module name (e.g., C<My::Groovy::Producer>), a module name relative to
992 the C<SQL::Translator::Producer> namespace (e.g., C<MySQL>), a module
993 name and function combination (C<My::Groovy::Producer::transmogrify>),
994 or a reference to an anonymous subroutine. If a full module name is
995 passed in (for the purposes of this method, a string containing "::"
996 is considered to be a module name), it is treated as a package, and a
997 function called "produce" will be invoked: C<$modulename::produce>.
998 If $modulename cannot be loaded, the final portion is stripped off and
999 treated as a function. In other words, if there is no file named
1000 F<My/Groovy/Producer/transmogrify.pm>, C<SQL::Translator> will attempt
1001 to load F<My/Groovy/Producer.pm> and use C<transmogrify> as the name of
1002 the function, instead of the default C<produce>.
1004 my $tr = SQL::Translator->new;
1006 # This will invoke My::Groovy::Producer::produce($tr, $data)
1007 $tr->producer("My::Groovy::Producer");
1009 # This will invoke SQL::Translator::Producer::Sybase::produce($tr, $data)
1010 $tr->producer("Sybase");
1012 # This will invoke My::Groovy::Producer::transmogrify($tr, $data),
1013 # assuming that My::Groovy::Producer::transmogrify is not a module
1015 $tr->producer("My::Groovy::Producer::transmogrify");
1017 # This will invoke the referenced subroutine directly, as
1018 # $subref->($tr, $data);
1019 $tr->producer(\&my_producer);
1021 There is also a method named C<producer_type>, which is a string
1022 containing the classname to which the above C<produce> function
1023 belongs. In the case of anonymous subroutines, this method returns
1026 Finally, there is a method named C<producer_args>, which is both an
1027 accessor and a mutator. Arbitrary data may be stored in name => value
1028 pairs for the producer subroutine to access:
1030 sub My::Random::producer {
1031 my ($tr, $data) = @_;
1032 my $pr_args = $tr->producer_args();
1034 # $pr_args is a hashref.
1036 Extra data passed to the C<producer> method is passed to
1039 $tr->producer("xSV", delimiter => ',\s*');
1041 # In SQL::Translator::Producer::xSV:
1042 my $args = $tr->producer_args;
1043 my $delimiter = $args->{'delimiter'}; # value is ,\s*
1047 The C<parser> method defines or retrieves a subroutine that will be
1048 called to perform the parsing. The basic idea is the same as that of
1049 C<producer> (see above), except the default subroutine name is
1050 "parse", and will be invoked as C<$module_name::parse($tr, $data)>.
1051 Also, the parser subroutine will be passed a string containing the
1052 entirety of the data to be parsed.
1054 # Invokes SQL::Translator::Parser::MySQL::parse()
1055 $tr->parser("MySQL");
1057 # Invokes My::Groovy::Parser::parse()
1058 $tr->parser("My::Groovy::Parser");
1060 # Invoke an anonymous subroutine directly
1062 my $dumper = Data::Dumper->new([ $_[1] ], [ "SQL" ]);
1063 $dumper->Purity(1)->Terse(1)->Deepcopy(1);
1064 return $dumper->Dump;
1067 There is also C<parser_type> and C<parser_args>, which perform
1068 analogously to C<producer_type> and C<producer_args>
1072 Set or retreive the filters to run over the schema during the
1073 translation, before the producer creates its output. Filters are sub
1074 routines called, in order, with the schema object to filter as the 1st
1075 arg and a hashref of options as the 2nd. They are free to do whatever
1076 they want to the schema object, which will be handed to any following
1077 filters, then used by the producer.
1079 Filters are set as an array, which gives the order they run in.
1080 Like parsers and producers, they can be defined by a module name, a
1081 module name relative to the SQL::Translator::Filter namespace, a module
1082 name and function name together or a reference to an anonymous subroutine.
1083 When using a module name a function called C<filter> will be invoked in
1084 that package to do the work. To pass args to the filter set it as an array
1085 ref with the 1st value giving the filter and the rest being a hash of
1091 # Do stuff to schema here!
1093 [ "Foo", foo => "bar", hello => "world" ],
1097 Although you would normally set them in the constructor, which calls
1098 through to filters. i.e.
1100 my $translator = SQL::Translator->new(
1104 [ Foo, foo => "bar" ],
1109 See F<t/36-filters.t> for more examples.
1111 Multiple set calls to filters are cumulative with new filters added to
1112 the end of the current list.
1114 Returns the filters as a list of array refs, the 1st value being a
1115 reference to the filter sub routine and the 2nd a hashref its args.
1117 =head2 show_warnings
1119 Toggles whether to print warnings of name conflicts, identifier
1120 mutations, etc. Probably only generated by producers to let the user
1121 know when something won't translate very smoothly (e.g., MySQL "enum"
1122 fields into Oracle). Accepts a true or false value, returns the
1127 The C<translate> method calls the subroutine referenced by the
1128 C<parser> data member, then calls any C<filters> and finally calls
1129 the C<producer> sub routine (these members are described above).
1130 It accepts as arguments a number of things, in key => value format,
1131 including (potentially) a parser and a producer (they are passed
1132 directly to the C<parser> and C<producer> methods).
1134 Here is how the parameter list to C<translate> is parsed:
1140 1 argument means it's the data to be parsed; which could be a string
1141 (filename) or a reference to a scalar (a string stored in memory), or a
1142 reference to a hash, which is parsed as being more than one argument
1145 # Parse the file /path/to/datafile
1146 my $output = $tr->translate("/path/to/datafile");
1148 # Parse the data contained in the string $data
1149 my $output = $tr->translate(\$data);
1153 More than 1 argument means its a hash of things, and it might be
1154 setting a parser, producer, or datasource (this key is named
1155 "filename" or "file" if it's a file, or "data" for a SCALAR reference.
1157 # As above, parse /path/to/datafile, but with different producers
1158 for my $prod ("MySQL", "XML", "Sybase") {
1159 print $tr->translate(
1161 filename => "/path/to/datafile",
1165 # The filename hash key could also be:
1166 datasource => \$data,
1172 =head2 filename, data
1174 Using the C<filename> method, the filename of the data to be parsed
1175 can be set. This method can be used in conjunction with the C<data>
1176 method, below. If both the C<filename> and C<data> methods are
1177 invoked as mutators, the data set in the C<data> method is used.
1179 $tr->filename("/my/data/files/create.sql");
1183 my $create_script = do {
1185 open CREATE, "/my/data/files/create.sql" or die $!;
1188 $tr->data(\$create_script);
1190 C<filename> takes a string, which is interpreted as a filename.
1191 C<data> takes a reference to a string, which is used as the data to be
1192 parsed. If a filename is set, then that file is opened and read when
1193 the C<translate> method is called, as long as the data instance
1194 variable is not set.
1198 Returns the SQL::Translator::Schema object.
1202 Turns on/off the tracing option of Parse::RecDescent.
1206 Whether or not to validate the schema object after parsing and before
1211 Returns the version of the SQL::Translator release.
1215 The following people have contributed to the SQLFairy project:
1219 =item * Mark Addison <grommit@users.sourceforge.net>
1221 =item * Sam Angiuoli <angiuoli@users.sourceforge.net>
1223 =item * Dave Cash <dave@gnofn.org>
1225 =item * Darren Chamberlain <dlc@users.sourceforge.net>
1227 =item * Ken Y. Clark <kclark@cpan.org>
1229 =item * Allen Day <allenday@users.sourceforge.net>
1231 =item * Paul Harrington <phrrngtn@users.sourceforge.net>
1233 =item * Mikey Melillo <mmelillo@users.sourceforge.net>
1235 =item * Chris Mungall <cjm@fruitfly.org>
1237 =item * Ross Smith II <rossta@users.sf.net>
1239 =item * Gudmundur A. Thorisson <mummi@cshl.org>
1241 =item * Chris To <christot@users.sourceforge.net>
1243 =item * Jason Williams <smdwilliams@users.sourceforge.net>
1245 =item * Ying Zhang <zyolive@yahoo.com>
1249 If you would like to contribute to the project, you can send patches
1250 to the developers mailing list:
1252 sqlfairy-developers@lists.sourceforge.net
1254 Or send us a message (with your Sourceforge username) asking to be
1255 added to the project and what you'd like to contribute.
1260 This program is free software; you can redistribute it and/or modify
1261 it under the terms of the GNU General Public License as published by
1262 the Free Software Foundation; version 2.
1264 This program is distributed in the hope that it will be useful, but
1265 WITHOUT ANY WARRANTY; without even the implied warranty of
1266 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1267 General Public License for more details.
1269 You should have received a copy of the GNU General Public License
1270 along with this program; if not, write to the Free Software
1271 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
1276 Please use L<http://rt.cpan.org/> for reporting bugs.
1280 If you find this module useful, please use
1281 L<http://cpanratings.perl.org/rate/?distribution=SQL-Translator> to rate it.
1286 L<SQL::Translator::Parser>,
1287 L<SQL::Translator::Producer>,
1288 L<Parse::RecDescent>,
1291 L<Text::RecordParser>,