package SQL::Translator::Producer::ClassDBI;
-# -------------------------------------------------------------------
-# $Id: ClassDBI.pm,v 1.2 2003-04-19 01:32:27 kycl4rk Exp $
-# -------------------------------------------------------------------
-# Copyright (C) 2003 Ying Zhang <zyolive@yahoo.com>,
-# Allen Day <allenday@ucla.edu>,
-#
-# 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 warnings;
use vars qw[ $VERSION $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.2 $ =~ /(\d+)\.(\d+)/;
-$DEBUG = 1 unless defined $DEBUG;
+$VERSION = '1.59';
+$DEBUG = 1 unless defined $DEBUG;
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Utils qw(debug header_comment);
use Data::Dumper;
-sub produce {
- my ($translator, $data) = @_;
- $DEBUG = $translator->debug;
- my $no_comments = $translator->no_comments;
-
- my $create;
- unless ( $no_comments ) {
- $create .= sprintf "##\n## Created by %s\n## Created on %s\n##\n\n",
- __PACKAGE__, scalar localtime;
- }
-
- $create .= "package " . $translator->format_package_name('DBI'). ";\n\n";
-
- $create .= "my \$USER = \'\';\n";
- $create .= "my \$PASS = \'\';\n\n";
-
- my $from = _from($translator->parser_type());
-
- $create .= "use base \'Class::DBI::" .$from. "\';\n\n";
-
- $create .= $translator->format_package_name('DBI'). "->set_db(\'Main', \'dbi:" .$from. ":_\', \$USER,\$PASS,);\n\n";
- $create .= "1;\n\n\n";
-
- for my $table (keys %{$data}) {
- my $table_data = $data->{$table};
- my @fields = keys %{$table_data->{'fields'}};
-
-
- $create .= "##\n## Package:" .$translator->format_package_name($table). "\n##\n" unless $no_comments;
- $create .= "package ". $translator->format_package_name($table). ";\n";
-
- $create .= "use base \'Chado::DBI\';\n";
- $create .= "use mixin \'Class::DBI::Join\';\n";
- $create .= "use Class::DBI::Pager;\n\n";
-
- $create .= $translator->format_package_name($table). " -> set_up_table('$table');\n\n";
-
-
-
- #
- # Primary key?
- #
- my @constraints;
-
- for my $constraint ( @{ $table_data->{'constraints'} } ) {
- #my $name = $constraint->{'name'} || '';
- my $type = $constraint->{'type'};
- my $fields = $constraint->{'fields'};
- my $ref_table = $constraint->{'reference_table'};
- my $ref_fields = $constraint->{'reference_fields'};
-
- if ( $type eq 'primary_key') {
- $create .= "sub " .$translator->format_pk_name($translator->format_package_name($table), $fields[0]). "{ shift -> $fields[0] }\n\n";
- }
-
- }
-
- #
- # Foreign key?
- #
- for (my $i = 0; $i < scalar(@fields); $i++) {
- my $field = $fields[$i];
- my $field_data = $table_data->{'fields'}->{$field}->{'constraints'};
- my $type = $field_data->[1]->{'type'} || '';
- my $ref_table = $field_data->[1]->{'reference_table'};
- my $ref_fields = $field_data->[1]->{'reference_fields'};
-
- if ($type eq 'foreign_key') {
- $create .= $translator->format_package_name($table). " -> hasa(" .$translator->format_package_name($ref_table). " => \'@$ref_fields\');\n";
- $create .= "sub " .$translator->format_fk_name($ref_table, @$ref_fields). "{ return shift -> @$ref_fields }\n\n";
- }
- }
-
- $create .= "1;\n\n\n";
- }
-
- open( FILE, '>DBI.pm') or die( "Can't open file : $!");
- print ( FILE $create);
- close ( FILE ) or die( "Can't close file : $!");
-
-}
-
-
-sub _from {
- my $from = shift;
- my @temp = split(/::/, $from);
- $from = $temp[$#temp];
-
- if ( $from eq 'MySQL') {
- $from = lc($from);
- } elsif ( $from eq 'PostgreSQL') {
- $from = 'Pg';
- } elsif ( $from eq 'Oracle') {
-
- } else {
- print "Eoorr\n";
- }
+my %CDBI_auto_pkgs = (
+ MySQL => 'mysql',
+ PostgreSQL => 'Pg',
+ Oracle => 'Oracle',
+);
- return $from;
+sub produce {
+ my $t = shift;
+ local $DEBUG = $t->debug;
+ my $no_comments = $t->no_comments;
+ my $schema = $t->schema;
+ my $args = $t->producer_args;
+ my @create;
+
+ if ( my $fmt = $args->{'format_pkg_name'} ) {
+ $t->format_package_name( $fmt );
+ }
+
+ if ( my $fmt = $args->{'format_fk_name'} ) {
+ $t->format_fk_name( $fmt );
+ }
+
+ my $db_user = $args->{'db_user'} || '';
+ my $db_pass = $args->{'db_password'} || '';
+ my $main_pkg_name = $args->{'package_name'} ||
+ # $args->{'main_pkg_name'} || # keep this? undocumented
+ $t->format_package_name('DBI');
+ my $header = header_comment( __PACKAGE__, "# " );
+ my $parser_type = ( split /::/, $t->parser_type )[-1];
+ my $from = $CDBI_auto_pkgs{$parser_type} || '';
+ my $dsn = $args->{'dsn'} || sprintf( 'dbi:%s:_',
+ $CDBI_auto_pkgs{ $parser_type }
+ ? $CDBI_auto_pkgs{ $parser_type } : $parser_type
+ );
+ my $sep = '# ' . '-' x 67;
+
+
+ #
+ # Identify "link tables" (have only PK and FK fields).
+ #
+ my %linkable;
+ my %linktable;
+ for my $table ( $schema->get_tables ) {
+ debug("PKG: Table = ", $table->name, "\n");
+ my $is_link = 1;
+ for my $field ( $table->get_fields ) {
+ unless ( $field->is_primary_key or $field->is_foreign_key ) {
+ $is_link = 0;
+ last;
+ }
+ }
+
+ next unless $is_link;
+
+ foreach my $left ( $table->get_fields ) {
+ next unless $left->is_foreign_key;
+ my $lfk = $left->foreign_key_reference or next;
+ my $lr_table = $schema->get_table( $lfk->reference_table )
+ or next;
+ my $lr_field_name = ( $lfk->reference_fields )[0];
+ my $lr_field = $lr_table->get_field($lr_field_name);
+ next unless $lr_field->is_primary_key;
+
+ foreach my $right ( $table->get_fields ) {
+ next if $left->name eq $right->name;
+
+ my $rfk = $right->foreign_key_reference or next;
+ my $rr_table = $schema->get_table( $rfk->reference_table )
+ or next;
+ my $rr_field_name = ( $rfk->reference_fields )[0];
+ my $rr_field = $rr_table->get_field($rr_field_name);
+ next unless $rr_field->is_primary_key;
+
+ $linkable{ $lr_table->name }{ $rr_table->name } = $table;
+ $linkable{ $rr_table->name }{ $lr_table->name } = $table;
+ $linktable{ $table->name } = $table;
+ }
+ }
+ }
+
+ #
+ # Iterate over all tables
+ #
+ my ( %packages, $order );
+ for my $table ( $schema->get_tables ) {
+ my $table_name = $table->name or next;
+
+ my $table_pkg_name = join '::', $main_pkg_name, $t->format_package_name($table_name);
+ $packages{ $table_pkg_name } = {
+ order => ++$order,
+ pkg_name => $table_pkg_name,
+ base => $main_pkg_name,
+ table => $table_name,
+ };
+
+ #
+ # Primary key may have a differenct accessor method name
+ #
+# if ( my $constraint = $table->primary_key ) {
+# my $field = ( $constraint->fields )[0];
+# $packages{ $table_pkg_name }{'_columns_primary'} = $field;
+#
+# if ( my $pk_xform = $t->format_pk_name ) {
+# my $pk_name = $pk_xform->( $table_pkg_name, $field );
+#
+# $packages{$table_pkg_name}{'pk_accessor'} =
+# "#\n# Primary key accessor\n#\n"
+# . "sub $pk_name {\n shift->$field\n}\n\n";
+# }
+# }
+
+ my $is_data = 0;
+ foreach my $field ( $table->get_fields ) {
+ if ( !$field->is_foreign_key and !$field->is_primary_key ) {
+ push @{ $packages{$table_pkg_name}{'_columns_essential'} },
+ $field->name;
+ $is_data++;
+ }
+ elsif ( !$field->is_primary_key ) {
+ push @{ $packages{$table_pkg_name}{'_columns_others'} },
+ $field->name;
+ }
+ }
+
+ my %linked;
+ if ($is_data) {
+ foreach my $link ( keys %{ $linkable{$table_name} } ) {
+ my $linkmethodname;
+
+ if ( my $fk_xform = $t->format_fk_name ) {
+
+ # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+ $linkmethodname = $fk_xform->(
+ $linkable{ $table_name }{ $link }->name,
+ ( $schema->get_table( $link )->primary_key->fields )[0]
+ )
+ . 's';
+ }
+ else {
+ # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+ $linkmethodname =
+ $linkable{ $table_name }{ $link }->name . '_'
+ . ( $schema->get_table( $link )->primary_key->fields )[0]
+ . 's';
+ }
+
+ my @rk_fields = ();
+ my @lk_fields = ();
+ foreach my $field ( $linkable{$table_name}{$link}->get_fields )
+ {
+ next unless $field->is_foreign_key;
+
+ next unless (
+ $field->foreign_key_reference->reference_table eq
+ $table_name
+ ||
+ $field->foreign_key_reference->reference_table eq $link
+ );
+
+ push @lk_fields,
+ ( $field->foreign_key_reference->reference_fields )[0]
+ if $field->foreign_key_reference->reference_table eq
+ $link;
+
+ push @rk_fields, $field->name
+ if $field->foreign_key_reference->reference_table eq
+ $table_name;
+ }
+
+ #
+ # If one possible traversal via link table.
+ #
+ if ( scalar(@rk_fields) == 1 and scalar(@lk_fields) == 1 ) {
+ foreach my $rk_field (@rk_fields) {
+ push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
+ "sub "
+ . $linkmethodname
+ . " { my \$self = shift; "
+ . "return map \$_->"
+ . ( $schema->get_table($link)->primary_key->fields )
+ [0]
+ . ", \$self->"
+ . $linkable{$table_name}{$link}->name . "_"
+ . $rk_field
+ . " }\n\n";
+ }
+
+ #
+ # Else there is more than one way to traverse it.
+ # ack! Let's treat these types of link tables as
+ # a many-to-one (easier)
+ #
+ # NOTE: we need to rethink the link method name,
+ # as the cardinality has shifted on us.
+ #
+ }
+ elsif ( scalar(@rk_fields) == 1 ) {
+ foreach my $rk_field (@rk_fields) {
+ #
+ # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+ #
+ push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
+ "sub "
+ . $linkable{$table_name}{$link}->name
+ . "s { my \$self = shift; return \$self->"
+ . $linkable{$table_name}{$link}->name . "_"
+ . $rk_field
+ . "(\@_) }\n\n";
+ }
+ }
+ elsif ( scalar(@lk_fields) == 1 ) {
+ #
+ # These will be taken care of on the other end...
+ #
+ }
+ else {
+ #
+ # Many many many. Need multiple iterations here,
+ # data structure revision to handle N FK sources.
+ # This code has not been tested and likely doesn't
+ # work here.
+ #
+ foreach my $rk_field (@rk_fields) {
+ # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+ push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
+ "sub "
+ . $linkable{$table_name}{$link}->name . "_"
+ . $rk_field
+ . "s { my \$self = shift; return \$self->"
+ . $linkable{$table_name}{$link}->name . "_"
+ . $rk_field
+ . "(\@_) }\n\n";
+ }
+ }
+ }
+ }
+
+ #
+ # Use foreign keys to set up "has_a/has_many" relationships.
+ #
+ foreach my $field ( $table->get_fields ) {
+ if ( $field->is_foreign_key ) {
+ my $table_name = $table->name;
+ my $field_name = $field->name;
+# my $fk_method = $t->format_fk_name( $table_name, $field_name );
+ my $fk_method = join('::', $table_pkg_name,
+ $t->format_fk_name( $table_name, $field_name )
+ );
+ my $fk = $field->foreign_key_reference;
+ my $ref_table = $fk->reference_table;
+ my $ref_pkg = $t->format_package_name($ref_table);
+ my $ref_field = ( $fk->reference_fields )[0];
+# my $fk_method = join('::',
+# $table_pkg_name, $t->format_fk_name( $ref_table )
+# );
+
+ push @{ $packages{$table_pkg_name}{'has_a'} },
+ "$table_pkg_name->has_a(\n"
+ . " $field_name => '$ref_pkg'\n);\n\n"
+ . "sub $fk_method {\n"
+ . " return shift->$field_name\n}\n\n"
+ ;
+
+ # if there weren't M-M relationships via the has_many
+ # being set up here, create nice pluralized method alias
+ # rather for user as alt. to ugly tablename_fieldname name
+ #
+# if ( !$packages{$ref_pkg}{'has_many'}{$table_name} ) {
+# #
+# # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+# #
+# push @{ $packages{$ref_pkg}{'has_many'}{$table_name} },
+# "sub ${table_name}s {\n " .
+# "return shift->$table_name\_$field_name\n}\n\n";
+# # else ugly
+# }
+# else {
+# }
+
+ push @{ $packages{$ref_pkg}{'has_many'}{$table_name} },
+ "$ref_pkg->has_many(\n '${table_name}_${field_name}', "
+ . "'$table_pkg_name' => '$field_name'\n);\n\n";
+
+ }
+ }
+ }
+
+ #
+ # Now build up text of package.
+ #
+ my $base_pkg = sprintf( 'Class::DBI%s', $from ? "::$from" : '' );
+ push @create, join ( "\n",
+ "package $main_pkg_name;\n",
+ $header,
+ "use strict;",
+ "use base '$base_pkg';\n",
+ "$main_pkg_name->set_db('Main', '$dsn', '$db_user', '$db_pass');\n\n",
+ );
+
+ for my $pkg_name (
+ sort { $packages{ $a }{'order'} <=> $packages{ $b }{'order'} }
+ keys %packages
+ ) {
+ my $pkg = $packages{$pkg_name} or next;
+ next unless $pkg->{'pkg_name'};
+
+ push @create, join ( "\n",
+ $sep,
+ "package " . $pkg->{'pkg_name'} . ";",
+ "use base '" . $pkg->{'base'} . "';",
+ "use Class::DBI::Pager;\n\n",
+ );
+
+ if ( $from ) {
+ push @create, join('',
+ $pkg->{'pkg_name'},
+ "->set_up_table('",
+ $pkg->{'table'},
+ "');\n\n"
+ );
+ }
+ else {
+ my $table = $schema->get_table( $pkg->{'table'} );
+ my @field_names = map { $_->name } $table->get_fields;
+
+ push @create, join("\n",
+ $pkg_name."->table('".$pkg->{'table'}."');\n",
+ $pkg_name."->columns(All => qw/".
+ join(' ', @field_names)."/);\n\n",
+ );
+ }
+
+ push @create, "\n";
+
+ if ( my $pk = $pkg->{'pk_accessor'} ) {
+ push @create, $pk;
+ }
+
+ if ( my @has_a = @{ $pkg->{'has_a'} || [] } ) {
+ push @create, $_ for @has_a;
+ }
+
+ foreach my $has_many_key ( keys %{ $pkg->{'has_many'} } ) {
+ if ( my @has_many = @{ $pkg->{'has_many'}{$has_many_key} || [] } ) {
+ push @create, $_ for @has_many;
+ }
+ }
+ }
+
+ push @create, "1;\n";
+
+ return wantarray
+ ? @create
+ : join('', @create);
}
1;
-__END__
+=pod
=head1 NAME
-SQL::Translator::Producer::ClassDBI - Translate SQL schemata into Class::DBI classes
+SQL::Translator::Producer::ClassDBI - create Class::DBI classes from schema
=head1 SYNOPSIS
Use this producer as you would any other from SQL::Translator. See
L<SQL::Translator> for details.
-This package utilizes SQL::Translator's formatting methods
+This package uses SQL::Translator's formatting methods
format_package_name(), format_pk_name(), format_fk_name(), and
format_table_name() as it creates classes, one per table in the schema
provided. An additional base class is also created for database connectivity
configuration. See L<Class::DBI> for details on how this works.
-=head1 AUTHOR
+=head1 AUTHORS
-Ying Zhang <zyolive@yahoo.com>, Allen Day <allenday@ucla.edu>
+Allen Day E<lt>allenday@ucla.eduE<gt>,
+Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
projects / dbsrgits/SQL-Translator.git / blobdiff