package SQL::Translator::Producer::ClassDBI;
# -------------------------------------------------------------------
-# $Id: ClassDBI.pm,v 1.30 2003-08-12 23:21:54 kycl4rk Exp $
+# $Id$
# -------------------------------------------------------------------
-# Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
-# Ying Zhang <zyolive@yahoo.com>
+# Copyright (C) 2002-2009 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 $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.30 $ =~ /(\d+)\.(\d+)/;
+$VERSION = '1.99';
$DEBUG = 1 unless defined $DEBUG;
use SQL::Translator::Schema::Constants;
-use SQL::Translator::Utils qw(header_comment);
+use SQL::Translator::Utils qw(debug header_comment);
use Data::Dumper;
my %CDBI_auto_pkgs = (
- MySQL => 'mysql',
- PostgreSQL => 'Pg',
- Oracle => 'Oracle',
+ MySQL => 'mysql',
+ PostgreSQL => 'Pg',
+ Oracle => 'Oracle',
);
# -------------------------------------------------------------------
my $no_comments = $t->no_comments;
my $schema = $t->schema;
my $args = $t->producer_args;
+ 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_pass'} || '';
- my $main_pkg_name = $t->format_package_name('DBI');
+ 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;
+ 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;
- foreach my $table ( $schema->get_tables ) {
+ for my $table ( $schema->get_tables ) {
+ debug("PKG: Table = ", $table->name, "\n");
my $is_link = 1;
- foreach my $field ( $table->get_fields ) {
+ for my $field ( $table->get_fields ) {
unless ( $field->is_primary_key or $field->is_foreign_key ) {
$is_link = 0;
last;
for my $table ( $schema->get_tables ) {
my $table_name = $table->name or next;
- my $table_pkg_name = $t->format_package_name($table_name);
- $packages{$table_pkg_name} = {
+ 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,
#
# 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";
- }
- }
+# 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 ) {
# ADD CALLBACK FOR PLURALIZATION MANGLING HERE
$linkmethodname = $fk_xform->(
- $linkable{$table_name}{$link}->name,
- ( $schema->get_table($link)->primary_key->fields )[0]
+ $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]
+ $linkable{ $table_name }{ $link }->name . '_'
+ . ( $schema->get_table( $link )->primary_key->fields )[0]
. 's';
}
{
next unless $field->is_foreign_key;
- next
- unless ( $field->foreign_key_reference->reference_table eq
+ next unless (
+ $field->foreign_key_reference->reference_table eq
$table_name
- || $field->foreign_key_reference->reference_table eq
- $link );
+ ||
+ $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 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} },
. " }\n\n";
}
- # else there is more than one way to traverse it.
- # ack! let's treat these types of link tables as
+ #
+ # 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
}
}
elsif ( scalar(@lk_fields) == 1 ) {
- # these will be taken care of on the other end...
+ #
+ # These will be taken care of on the other end...
+ #
}
else {
- # many many many. need multiple iterations here,
+ #
+ # 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
+ # work here.
+ #
foreach my $rk_field (@rk_fields) {
-
# ADD CALLBACK FOR PLURALIZATION MANGLING HERE
push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
"sub "
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 = $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 this table "has a" to the other, then it follows
- # that the other table "has many" of this one, right?
- #
- # No... there is the possibility of 1-1 cardinality
+ . " 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 {
- }
+ #
+# 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}', "
sort { $packages{ $a }{'order'} <=> $packages{ $b }{'order'} }
keys %packages
) {
- my $pkg = $packages{ $pkg_name };
+ my $pkg = $packages{$pkg_name} or next;
+ next unless $pkg->{'pkg_name'};
$create .= join ( "\n",
$sep,
"use Class::DBI::Pager;\n\n",
);
- #if ( $from ) {
- # $create .=
- # $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;
- #
- # $create .= join("\n",
- # $pkg_name."->table('".$pkg->{'table'}."');\n",
- # $pkg_name."->columns(All => qw/".
- # join(' ', @field_names)."/);\n\n",
- # );
- #}
-
- # the approach here is to do lazy loading on the expensive
- # columns (expensive defined as those columns which require
- # construction of a referenced object) fields which are
- # strictly data (ie, not references) are treated as essential
- # b/c they don't require much time to set up.
-
- $create .= $pkg_name . "->table('" . $pkg->{'table'} . "');\n";
-
- # set up primary key field
- if ( $pkg->{'_columns_primary'} ) {
- $create .= $pkg_name
- . "->columns(Primary => qw/"
- . $pkg->{'_columns_primary'} . "/);\n";
- }
- else {
- die "Class::DBI isn't going to like that you don't have".
- " a primary key field for table " . $pkg->{'table'} .
- " in package '$pkg_name'";
- }
-
- # set up non-FK fields to be populated at construction
- if ( $pkg->{'_columns_essential'} ) {
- $create .= $pkg_name
- . "->columns(Essential => qw/"
- . join ( ' ', @{ $pkg->{'_columns_essential'} } ) . "/);\n";
- }
-
- # set up FK fields for lazy loading on request
- if ( $pkg->{'_columns_others'} ) {
- $create .= $pkg_name
- . "->columns(Others => qw/"
- . join ( ' ', @{ $pkg->{'_columns_others'} } ) . "/);\n";
- }
+ if ( $from ) {
+ $create .=
+ $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;
+
+ $create .= join("\n",
+ $pkg_name."->table('".$pkg->{'table'}."');\n",
+ $pkg_name."->columns(All => qw/".
+ join(' ', @field_names)."/);\n\n",
+ );
+ }
$create .= "\n";
=head1 AUTHORS
-Allen Day E<lt>allenday@ucla.eduE<gt>
+Allen Day E<lt>allenday@ucla.eduE<gt>,
Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
-Ken Y. Clark E<lt>kclark@cpan.org<gt>.
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
projects / dbsrgits/SQL-Translator.git / blobdiff