[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / ClassDBI.pm

package SQL::Translator::Producer::ClassDBI;

# -------------------------------------------------------------------
# $Id: ClassDBI.pm,v 1.8 2003-06-09 01:55:12 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 vars qw[ $VERSION $DEBUG ];
$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
$DEBUG   = 1 unless defined $DEBUG;

use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(header_comment);
use Data::Dumper;

sub produce {
    my ($translator, $data) = @_;
    local $DEBUG            = $translator->debug;
    my $no_comments         = $translator->no_comments;
    my $schema              = $translator->schema;
  
    my $create; 
    $create .= header_comment(__PACKAGE__, "# ") unless ($no_comments);
  
    $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" .
        $translator->format_package_name('DBI') . 
        "->set_db('Main', 'dbi:$from:_', \$USER, \$PASS);\n\n";
  
    #
    # Iterate over all tables
    #
    for my $table ( $schema->get_tables ) {
        my $table_name = $table->name or next;
        my %pk;

        unless ( $no_comments ) {
            $create .= 
                "#\n# Package: " .
                $translator->format_package_name($table_name). 
                "\n#\n" 
        }

        $create .= "package ". 
            $translator->format_package_name($table_name). ";\n";
        $create .= "use mixin 'Class::DBI::Join';\n";
        $create .= "use Class::DBI::Pager;\n\n";
    
        $create .= $translator->format_package_name($table_name). 
            "->set_up_table('$table_name');\n\n";
    
        #
        # Primary key?
        #
        foreach my $constraint ( $table->get_constraints ) {
            next unless $constraint->type eq PRIMARY_KEY;
            my $field = ($constraint->fields)[0];
      
            $pk{ $table_name } = $field;
            $create .= "sub " .$translator->format_pk_name(
                $translator->format_package_name( $table_name ),
                $field
            ) . " { shift->".$field." }\n\n";
        }
    
        #
        # Find foreign keys
        #
        foreach my $field ( $table->get_fields ) {
            if ( $field->is_foreign_key ) {
                my $field_name = $field->name;
                my $fk         = $field->foreign_key_reference;
                my $ref_table  = $fk->reference_table;
                my @ref_fields = $fk->reference_fields;
                my @fields     = $fk->fields;

              $create .= $translator->format_package_name($table_name). 
                    "->hasa(\n    " .
                    $translator->format_package_name($ref_table). 
                    " => '$field_name'\n);\n\n";
              $create .= "sub " .
                    $translator->format_fk_name($ref_table, $field_name).
                    " {\n    return shift->$field_name\n}\n\n";
            }
        }
    }

    $create .= '1;';

#    for my $table (keys %{$data}) {
#        my $table_data = $data->{$table};
#        my @fields =  keys %{$table_data->{'fields'}};
#        my %pk;
#    
#        $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?
#        #
#        foreach my $constraint ( @{ $table_data->{'constraints'} } ) {
#          my $name       = $constraint->{'name'} || '';
#          my $type       = $constraint->{'type'};
#          my $ref_table  = $constraint->{'reference_table'};
#          my $ref_fields = $constraint->{'reference_fields'};
#    
#          if ( $type eq 'primary_key') {
#            $pk{$table} = $constraint->{'fields'}->[0];
#            $create .= "sub " .$translator->format_pk_name(
#                                                           $translator->format_package_name($table),
#                                                           $constraint->{'fields'}->[0]
#                                                          ) . " { shift->".$constraint->{'fields'}->[0]." }\n\n";
#          }
#        }
#    
#        #
#        # Foreign key?
#        #
#        foreach my $field (@fields){
#          my $field_data = $table_data->{'fields'}->{$field}->{'constraints'};
#          my $type = $field_data->[1]->{'type'} || '';
#          my $ref_table = $field_data->[1]->{'reference_table'};
#          my $ref_field = $field_data->[1]->{'reference_fields'}->[0];
#          my $field = $field_data->[1]->{'fields'}->[0];
#    
#          if ($type eq 'foreign_key') {
#    
#    #THIS IS IMPOSSIBLE UNTIL WE HAVE A BETTER DATA MODEL.  THIS GIANT HASH SUCKS !!!
#    #         my $r_link     = 0; #not a link table (yet)
#    #         my $r_linkthis = 0;
#    #         my $r_linkthat = 0;
#    #         my $r_linkdata = 0;
#    #         my $r_table = $data->{$ref_table};
#    #         my @r_fields = keys %{$r_table->{'fields'}};
#    #         foreach my $r_field ( keys %{$r_table->{'fields'}} ){
#    #           $r_linkthis++ and next if $r_field eq $ref_field; #remote table links to local table
#    #           if($r_table->{'fields'}->{$r_field}->{'constraints'}){
#    
#    #             foreach my $r_constraint ($r_table->{'fields'}->{$r_field}->{'constraints'}){
#    #               $create .= Dumper($r_constraint);
#    #             }
#    
#    #           } else {
#    #             $r_linkdata++; #if not constraints, assume it's data (safe?)
#    #           }
#    #           foreach my $r_constraint ( @{ $r_table->{'fields'}->{$r_field}->{'constraints'} } ) {
#    #             next unless $r_constraint->{'constraint_type'} eq 'foreign_key';
#    
#    #             $r_linkthat++ unless $r_constraint->{'reference_table'} eq $table; #remote table links to non-local table
#    #           }
#    #         }
#    
#    #        my $link = $r_linkthis && $r_linkthat && !$r_linkdata ? '_link' : '';
#            $create .= $translator->format_package_name($table). "->hasa(" .$translator->format_package_name($ref_table). " => \'$field\');\n";
#            $create .= "sub " .$translator->format_fk_name($ref_table, $field)." { return shift->$field }\n\n";
#          }
#        }
#        
#    #THIS IS IMPOSSIBLE UNTIL WE HAVE A BETTER DATA MODEL.  THIS GIANT HASH SUCKS !!!
#    #     #
#    #     # Remote foreign key?
#    #     #
#    #     print "****$table\n";
#    #     # find tables that refer to this table
#    #     my %refers = ();
#    #     for my $remote_table (keys %{$data}){
#    #       next if $remote_table eq $table;
#    # #      print "********".$remote_table."\n";
#    #       my $remote_table_data = $data->{$remote_table};
#    
#    #       foreach my $remote_field ( keys %{$remote_table_data->{'fields'}} ){
#    #         foreach my $remote_constraint ( @{ $remote_table_data->{'fields'}->{$remote_field}->{'constraints'} } ) {
#    #           next unless $remote_constraint->{'constraint_type'} eq 'foreign_key'; #only interested in foreign keys...
#    
#    #           $refers{$remote_table} = 1 if $pk{$remote_constraint->{'reference_table'}} ;#eq $remote_constraint->{'reference_fields'}->[0];
#    #            }
#    #       }
#    #     }
#    
#    #     foreach my $refer (keys %refers){
#    #       foreach my $refer_field ( keys %{$data->{$refer}->{'fields'}} ){
#    #         foreach my $refer_constraint ( @{ $data->{$refer}->{'fields'}->{$refer_field}->{'constraints'} } ) {
#    #           next unless $refer_constraint->{'constraint_type'} eq 'foreign_key'; #only interested in foreign keys...
#    #           next if $refer_constraint->{'reference_table'} eq $table; #don't want to consider the current table vs itself
#    #           print "********".$refer."\t".$refer_field."\t****\t".$refer_constraint->{'reference_table'}."\t".$refer_constraint->{'reference_fields'}->[0]."\n";
#    
#    #           $create .= "****sub " .$translator->format_fk_name($refer_constraint->{'reference_table'}, $refer_constraint->{'reference_fields'}->[0]). " { return shift->".$refer_constraint->{'reference_fields'}->[0]." }\n\n";
#    #         }
#    #       }
#    #     }
#    
#        $create .= "1;\n\n\n";
#    }
   
    return $create;
}


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') {
        $from = 'Oracle';
    } else {
        die "__PACKAGE__ can't handle vendor $from";
    }
  
    return $from;
}

1;

__END__

=head1 NAME

SQL::Translator::Producer::ClassDBI - 
    Translate SQL schemata into Class::DBI classes

=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
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 AUTHORS

Ying Zhang E<lt>zyolive@yahoo.comE<gt>, 
Allen Day E<lt>allenday@ucla.eduE<gt>
Ken Y. Clark E<lt>kclark@cpan.org<gt>.
Commit	Line	Data
f42e7027	1	package SQL::Translator::Producer::ClassDBI;
	2
	3	# -------------------------------------------------------------------
6c45056f	4	# $Id: ClassDBI.pm,v 1.8 2003-06-09 01:55:12 kycl4rk Exp $
f42e7027	5	# -------------------------------------------------------------------
	6	# Copyright (C) 2003 Ying Zhang <zyolive@yahoo.com>,
	7	# Allen Day <allenday@ucla.edu>,
	8	#
	9	# This program is free software; you can redistribute it and/or
	10	# modify it under the terms of the GNU General Public License as
	11	# published by the Free Software Foundation; version 2.
	12	#
	13	# This program is distributed in the hope that it will be useful, but
	14	# WITHOUT ANY WARRANTY; without even the implied warranty of
	15	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	# General Public License for more details.
	17	#
	18	# You should have received a copy of the GNU General Public License
	19	# along with this program; if not, write to the Free Software
	20	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	21	# 02111-1307 USA
	22	# -------------------------------------------------------------------
	23
	24	use strict;
	25	use vars qw[ $VERSION $DEBUG ];
6c45056f	26	$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
f42e7027	27	$DEBUG = 1 unless defined $DEBUG;
f42e7027	28
6c45056f	29	use SQL::Translator::Schema::Constants;
5ee19df8	30	use SQL::Translator::Utils qw(header_comment);
f42e7027	31	use Data::Dumper;
	32
	33	sub produce {
6c45056f	34	my ($translator, $data) = @_;
	35	local $DEBUG = $translator->debug;
	36	my $no_comments = $translator->no_comments;
	37	my $schema = $translator->schema;
	38
	39	my $create;
	40	$create .= header_comment(__PACKAGE__, "# ") unless ($no_comments);
	41
	42	$create .= "package " . $translator->format_package_name('DBI'). ";\n\n";
	43
	44	$create .= "my \$USER = '';\n";
	45	$create .= "my \$PASS = '';\n\n";
	46
	47	my $from = _from($translator->parser_type());
	48
	49	$create .= "use base 'Class::DBI::$from';\n\n" .
	50	$translator->format_package_name('DBI') .
	51	"->set_db('Main', 'dbi:$from:_', \$USER, \$PASS);\n\n";
	52
	53	#
	54	# Iterate over all tables
	55	#
	56	for my $table ( $schema->get_tables ) {
	57	my $table_name = $table->name or next;
	58	my %pk;
	59
	60	unless ( $no_comments ) {
	61	$create .=
	62	"#\n# Package: " .
	63	$translator->format_package_name($table_name).
	64	"\n#\n"
	65	}
	66
	67	$create .= "package ".
	68	$translator->format_package_name($table_name). ";\n";
	69	$create .= "use mixin 'Class::DBI::Join';\n";
	70	$create .= "use Class::DBI::Pager;\n\n";
	71
	72	$create .= $translator->format_package_name($table_name).
	73	"->set_up_table('$table_name');\n\n";
	74
	75	#
	76	# Primary key?
	77	#
	78	foreach my $constraint ( $table->get_constraints ) {
	79	next unless $constraint->type eq PRIMARY_KEY;
	80	my $field = ($constraint->fields)[0];
	81
	82	$pk{ $table_name } = $field;
	83	$create .= "sub " .$translator->format_pk_name(
	84	$translator->format_package_name( $table_name ),
	85	$field
	86	) . " { shift->".$field." }\n\n";
	87	}
	88
	89	#
	90	# Find foreign keys
	91	#
	92	foreach my $field ( $table->get_fields ) {
	93	if ( $field->is_foreign_key ) {
	94	my $field_name = $field->name;
	95	my $fk = $field->foreign_key_reference;
	96	my $ref_table = $fk->reference_table;
	97	my @ref_fields = $fk->reference_fields;
98	my @fields = $fk->fields;
99
100	$create .= $translator->format_package_name($table_name).
101	"->hasa(\n " .
102	$translator->format_package_name($ref_table).
103	" => '$field_name'\n);\n\n";
104	$create .= "sub " .
105	$translator->format_fk_name($ref_table, $field_name).
106	" {\n return shift->$field_name\n}\n\n";
107	}
108	}
109	}
110
111	$create .= '1;';
112
113	# for my $table (keys %{$data}) {
114	# my $table_data = $data->{$table};
115	# my @fields = keys %{$table_data->{'fields'}};
116	# my %pk;
117	#
118	# $create .= "##\n## Package: " .$translator->format_package_name($table). "\n##\n" unless $no_comments;
119	# $create .= "package ". $translator->format_package_name($table). ";\n";
120	#
121	# $create .= "use base \'Chado::DBI\';\n";
122	# $create .= "use mixin \'Class::DBI::Join\';\n";
123	# $create .= "use Class::DBI::Pager;\n\n";
124	#
125	# $create .= $translator->format_package_name($table). "->set_up_table('$table');\n\n";
126	#
127	# #
128	# # Primary key?
129	# #
130	# foreach my $constraint ( @{ $table_data->{'constraints'} } ) {
131	# my $name = $constraint->{'name'} \|\| '';
132	# my $type = $constraint->{'type'};
133	# my $ref_table = $constraint->{'reference_table'};
134	# my $ref_fields = $constraint->{'reference_fields'};
135	#
136	# if ( $type eq 'primary_key') {
137	# $pk{$table} = $constraint->{'fields'}->[0];
138	# $create .= "sub " .$translator->format_pk_name(
139	# $translator->format_package_name($table),
140	# $constraint->{'fields'}->[0]
141	# ) . " { shift->".$constraint->{'fields'}->[0]." }\n\n";
142	# }
143	# }
144	#
145	# #
146	# # Foreign key?
147	# #
148	# foreach my $field (@fields){
149	# my $field_data = $table_data->{'fields'}->{$field}->{'constraints'};
150	# my $type = $field_data->[1]->{'type'} \|\| '';
151	# my $ref_table = $field_data->[1]->{'reference_table'};
152	# my $ref_field = $field_data->[1]->{'reference_fields'}->[0];
153	# my $field = $field_data->[1]->{'fields'}->[0];
154	#
155	# if ($type eq 'foreign_key') {
156	#
157	# #THIS IS IMPOSSIBLE UNTIL WE HAVE A BETTER DATA MODEL. THIS GIANT HASH SUCKS !!!
158	# # my $r_link = 0; #not a link table (yet)
159	# # my $r_linkthis = 0;
160	# # my $r_linkthat = 0;
161	# # my $r_linkdata = 0;
162	# # my $r_table = $data->{$ref_table};
163	# # my @r_fields = keys %{$r_table->{'fields'}};
164	# # foreach my $r_field ( keys %{$r_table->{'fields'}} ){
165	# # $r_linkthis++ and next if $r_field eq $ref_field; #remote table links to local table
166	# # if($r_table->{'fields'}->{$r_field}->{'constraints'}){
167	#
168	# # foreach my $r_constraint ($r_table->{'fields'}->{$r_field}->{'constraints'}){
169	# # $create .= Dumper($r_constraint);
170	# # }
171	#
172	# # } else {
173	# # $r_linkdata++; #if not constraints, assume it's data (safe?)
174	# # }
175	# # foreach my $r_constraint ( @{ $r_table->{'fields'}->{$r_field}->{'constraints'} } ) {
176	# # next unless $r_constraint->{'constraint_type'} eq 'foreign_key';
177	#
178	# # $r_linkthat++ unless $r_constraint->{'reference_table'} eq $table; #remote table links to non-local table
179	# # }
180	# # }
181	#
182	# # my $link = $r_linkthis && $r_linkthat && !$r_linkdata ? '_link' : '';
183	# $create .= $translator->format_package_name($table). "->hasa(" .$translator->format_package_name($ref_table). " => \'$field\');\n";
184	# $create .= "sub " .$translator->format_fk_name($ref_table, $field)." { return shift->$field }\n\n";
185	# }
186	# }
187	#
188	# #THIS IS IMPOSSIBLE UNTIL WE HAVE A BETTER DATA MODEL. THIS GIANT HASH SUCKS !!!
189	# # #
190	# # # Remote foreign key?
191	# # #
192	# # print "****$table\n";
193	# # # find tables that refer to this table
194	# # my %refers = ();
195	# # for my $remote_table (keys %{$data}){
196	# # next if $remote_table eq $table;
197	# # # print "********".$remote_table."\n";
198	# # my $remote_table_data = $data->{$remote_table};
199	#
200	# # foreach my $remote_field ( keys %{$remote_table_data->{'fields'}} ){
201	# # foreach my $remote_constraint ( @{ $remote_table_data->{'fields'}->{$remote_field}->{'constraints'} } ) {
202	# # next unless $remote_constraint->{'constraint_type'} eq 'foreign_key'; #only interested in foreign keys...
203	#
204	# # $refers{$remote_table} = 1 if $pk{$remote_constraint->{'reference_table'}} ;#eq $remote_constraint->{'reference_fields'}->[0];
205	# # }
206	# # }
207	# # }
208	#
209	# # foreach my $refer (keys %refers){
210	# # foreach my $refer_field ( keys %{$data->{$refer}->{'fields'}} ){
211	# # foreach my $refer_constraint ( @{ $data->{$refer}->{'fields'}->{$refer_field}->{'constraints'} } ) {
212	# # next unless $refer_constraint->{'constraint_type'} eq 'foreign_key'; #only interested in foreign keys...
213	# # next if $refer_constraint->{'reference_table'} eq $table; #don't want to consider the current table vs itself
214	# # print "******".$refer."\t".$refer_field."\t**\t".$refer_constraint->{'reference_table'}."\t".$refer_constraint->{'reference_fields'}->[0]."\n";
215	#
216	# # $create .= "****sub " .$translator->format_fk_name($refer_constraint->{'reference_table'}, $refer_constraint->{'reference_fields'}->[0]). " { return shift->".$refer_constraint->{'reference_fields'}->[0]." }\n\n";
217	# # }
218	# # }
219	# # }
220	#
221	# $create .= "1;\n\n\n";
222	# }
223
224	return $create;
f42e7027	225	}
	226
	227
	228	sub _from {
6c45056f	229	my $from = shift;
	230	my @temp = split(/::/, $from);
	231	$from = $temp[$#temp];
	232
	233	if ( $from eq 'MySQL') {
	234	$from = lc($from);
	235	} elsif ( $from eq 'PostgreSQL') {
	236	$from = 'Pg';
	237	} elsif ( $from eq 'Oracle') {
	238	$from = 'Oracle';
	239	} else {
	240	die "__PACKAGE__ can't handle vendor $from";
	241	}
	242
	243	return $from;
f42e7027	244	}
	245
	246	1;
	247
	248	__END__
	249
	250	=head1 NAME
	251
6c45056f	252	SQL::Translator::Producer::ClassDBI -
6c45056f	253	Translate SQL schemata into Class::DBI classes
f42e7027	254
	255	=head1 SYNOPSIS
	256
1eee27d3	257	Use this producer as you would any other from SQL::Translator. See
1eee27d3	258	L<SQL::Translator> for details.
f42e7027	259
1eee27d3	260	This package utilizes SQL::Translator's formatting methods
	261	format_package_name(), format_pk_name(), format_fk_name(), and
	262	format_table_name() as it creates classes, one per table in the schema
	263	provided. An additional base class is also created for database connectivity
	264	configuration. See L<Class::DBI> for details on how this works.
f42e7027	265
6c45056f	266	=head1 AUTHORS
f42e7027	267
6c45056f	268	Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
	269	Allen Day E<lt>allenday@ucla.eduE<gt>
	270	Ken Y. Clark E<lt>kclark@cpan.org<gt>.