1 package SQL::Translator::Producer::ClassDBI;
3 # -------------------------------------------------------------------
4 # $Id: ClassDBI.pm,v 1.8 2003-06-09 01:55:12 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ying Zhang <zyolive@yahoo.com>,
7 # Allen Day <allenday@ucla.edu>,
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.
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.
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
22 # -------------------------------------------------------------------
25 use vars qw[ $VERSION $DEBUG ];
26 $VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
27 $DEBUG = 1 unless defined $DEBUG;
29 use SQL::Translator::Schema::Constants;
30 use SQL::Translator::Utils qw(header_comment);
34 my ($translator, $data) = @_;
35 local $DEBUG = $translator->debug;
36 my $no_comments = $translator->no_comments;
37 my $schema = $translator->schema;
40 $create .= header_comment(__PACKAGE__, "# ") unless ($no_comments);
42 $create .= "package " . $translator->format_package_name('DBI'). ";\n\n";
44 $create .= "my \$USER = '';\n";
45 $create .= "my \$PASS = '';\n\n";
47 my $from = _from($translator->parser_type());
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";
54 # Iterate over all tables
56 for my $table ( $schema->get_tables ) {
57 my $table_name = $table->name or next;
60 unless ( $no_comments ) {
63 $translator->format_package_name($table_name).
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";
72 $create .= $translator->format_package_name($table_name).
73 "->set_up_table('$table_name');\n\n";
78 foreach my $constraint ( $table->get_constraints ) {
79 next unless $constraint->type eq PRIMARY_KEY;
80 my $field = ($constraint->fields)[0];
82 $pk{ $table_name } = $field;
83 $create .= "sub " .$translator->format_pk_name(
84 $translator->format_package_name( $table_name ),
86 ) . " { shift->".$field." }\n\n";
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;
100 $create .= $translator->format_package_name($table_name).
102 $translator->format_package_name($ref_table).
103 " => '$field_name'\n);\n\n";
105 $translator->format_fk_name($ref_table, $field_name).
106 " {\n return shift->$field_name\n}\n\n";
113 # for my $table (keys %{$data}) {
114 # my $table_data = $data->{$table};
115 # my @fields = keys %{$table_data->{'fields'}};
118 # $create .= "##\n## Package: " .$translator->format_package_name($table). "\n##\n" unless $no_comments;
119 # $create .= "package ". $translator->format_package_name($table). ";\n";
121 # $create .= "use base \'Chado::DBI\';\n";
122 # $create .= "use mixin \'Class::DBI::Join\';\n";
123 # $create .= "use Class::DBI::Pager;\n\n";
125 # $create .= $translator->format_package_name($table). "->set_up_table('$table');\n\n";
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'};
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";
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];
155 # if ($type eq 'foreign_key') {
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'}){
168 # # foreach my $r_constraint ($r_table->{'fields'}->{$r_field}->{'constraints'}){
169 # # $create .= Dumper($r_constraint);
173 # # $r_linkdata++; #if not constraints, assume it's data (safe?)
175 # # foreach my $r_constraint ( @{ $r_table->{'fields'}->{$r_field}->{'constraints'} } ) {
176 # # next unless $r_constraint->{'constraint_type'} eq 'foreign_key';
178 # # $r_linkthat++ unless $r_constraint->{'reference_table'} eq $table; #remote table links to non-local table
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";
188 # #THIS IS IMPOSSIBLE UNTIL WE HAVE A BETTER DATA MODEL. THIS GIANT HASH SUCKS !!!
190 # # # Remote foreign key?
192 # # print "****$table\n";
193 # # # find tables that refer to this table
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};
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...
204 # # $refers{$remote_table} = 1 if $pk{$remote_constraint->{'reference_table'}} ;#eq $remote_constraint->{'reference_fields'}->[0];
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";
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";
221 # $create .= "1;\n\n\n";
230 my @temp = split(/::/, $from);
231 $from = $temp[$#temp];
233 if ( $from eq 'MySQL') {
235 } elsif ( $from eq 'PostgreSQL') {
237 } elsif ( $from eq 'Oracle') {
240 die "__PACKAGE__ can't handle vendor $from";
252 SQL::Translator::Producer::ClassDBI -
253 Translate SQL schemata into Class::DBI classes
257 Use this producer as you would any other from SQL::Translator. See
258 L<SQL::Translator> for details.
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.
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>.