Various bug fixen.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / ClassDBI.pm
CommitLineData
f42e7027 1package SQL::Translator::Producer::ClassDBI;
2
3# -------------------------------------------------------------------
8b183a02 4# $Id: ClassDBI.pm,v 1.39 2003-12-04 18:48:33 kycl4rk Exp $
f42e7027 5# -------------------------------------------------------------------
5f054727 6# Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
7# Ying Zhang <zyolive@yahoo.com>
f42e7027 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
24use strict;
25use vars qw[ $VERSION $DEBUG ];
8b183a02 26$VERSION = sprintf "%d.%02d", q$Revision: 1.39 $ =~ /(\d+)\.(\d+)/;
41a7b982 27$DEBUG = 1 unless defined $DEBUG;
f42e7027 28
6c45056f 29use SQL::Translator::Schema::Constants;
5ee19df8 30use SQL::Translator::Utils qw(header_comment);
71046f4b 31use Data::Dumper;
f42e7027 32
bf4629e7 33my %CDBI_auto_pkgs = (
71046f4b 34 MySQL => 'mysql',
35 PostgreSQL => 'Pg',
36 Oracle => 'Oracle',
bf4629e7 37);
38
39# -------------------------------------------------------------------
f42e7027 40sub produce {
41a7b982 41 my $t = shift;
42 my $create = undef;
43 local $DEBUG = $t->debug;
390292d3 44 my $no_comments = $t->no_comments;
45 my $schema = $t->schema;
46 my $args = $t->producer_args;
bf4629e7 47 my $db_user = $args->{'db_user'} || '';
48 my $db_pass = $args->{'db_pass'} || '';
41a7b982 49 my $main_pkg_name = $args->{'main_pkg_name'} ||
50 $t->format_package_name('DBI');
51 my $header = header_comment( __PACKAGE__, "# " );
390292d3 52 my $parser_type = ( split /::/, $t->parser_type )[-1];
41a7b982 53 my $from = $CDBI_auto_pkgs{$parser_type} || '';
54 my $dsn = $args->{'dsn'} || sprintf( 'dbi:%s:_',
55 $CDBI_auto_pkgs{ $parser_type }
56 ? $CDBI_auto_pkgs{ $parser_type } : $parser_type
57 );
71046f4b 58 my $sep = '# ' . '-' x 67;
fe77d758 59
60 #
61 # Identify "link tables" (have only PK and FK fields).
62 #
63 my %linkable;
64 my %linktable;
65 foreach my $table ( $schema->get_tables ) {
66 my $is_link = 1;
67 foreach my $field ( $table->get_fields ) {
68 unless ( $field->is_primary_key or $field->is_foreign_key ) {
41a7b982 69 $is_link = 0;
fe77d758 70 last;
71 }
72 }
73
74 next unless $is_link;
41a7b982 75
fe77d758 76 foreach my $left ( $table->get_fields ) {
77 next unless $left->is_foreign_key;
41a7b982 78 my $lfk = $left->foreign_key_reference or next;
79 my $lr_table = $schema->get_table( $lfk->reference_table )
80 or next;
81 my $lr_field_name = ( $lfk->reference_fields )[0];
fe77d758 82 my $lr_field = $lr_table->get_field($lr_field_name);
83 next unless $lr_field->is_primary_key;
84
85 foreach my $right ( $table->get_fields ) {
86 next if $left->name eq $right->name;
41a7b982 87
88 my $rfk = $right->foreign_key_reference or next;
fe77d758 89 my $rr_table = $schema->get_table( $rfk->reference_table )
41a7b982 90 or next;
91 my $rr_field_name = ( $rfk->reference_fields )[0];
fe77d758 92 my $rr_field = $rr_table->get_field($rr_field_name);
93 next unless $rr_field->is_primary_key;
41a7b982 94
c703e51d 95 $linkable{ $lr_table->name }{ $rr_table->name } = $table;
96 $linkable{ $rr_table->name }{ $lr_table->name } = $table;
fe77d758 97 $linktable{ $table->name } = $table;
98 }
99 }
100 }
c703e51d 101
6c45056f 102 #
71046f4b 103 # Iterate over all tables
6c45056f 104 #
bf4629e7 105 my ( %packages, $order );
6c45056f 106 for my $table ( $schema->get_tables ) {
107 my $table_name = $table->name or next;
6c45056f 108
390292d3 109 my $table_pkg_name = $t->format_package_name($table_name);
41a7b982 110 $packages{$table_pkg_name} = {
111 order => ++$order,
112 pkg_name => $table_pkg_name,
113 base => $main_pkg_name,
114 table => $table_name,
bf4629e7 115 };
6c45056f 116
6c45056f 117 #
bf4629e7 118 # Primary key may have a differenct accessor method name
6c45056f 119 #
41a7b982 120 if ( my $constraint = $table->primary_key ) {
121 my $field = ( $constraint->fields )[0];
122 $packages{ $table_pkg_name }{'_columns_primary'} = $field;
d79af833 123
41a7b982 124 if ( my $pk_xform = $t->format_pk_name ) {
125 my $pk_name = $pk_xform->( $table_pkg_name, $field );
b789c790 126
41a7b982 127 $packages{$table_pkg_name}{'pk_accessor'} =
128 "#\n# Primary key accessor\n#\n"
129 . "sub $pk_name {\n shift->$field\n}\n\n";
bf4629e7 130 }
6c45056f 131 }
d79af833 132
133 my $is_data = 0;
134 foreach my $field ( $table->get_fields ) {
41a7b982 135 if ( !$field->is_foreign_key and !$field->is_primary_key ) {
136 push @{ $packages{$table_pkg_name}{'_columns_essential'} },
137 $field->name;
138 $is_data++;
139 }
140 elsif ( !$field->is_primary_key ) {
141 push @{ $packages{$table_pkg_name}{'_columns_others'} },
142 $field->name;
143 }
d79af833 144 }
145
41a7b982 146 my %linked;
147 if ($is_data) {
148 foreach my $link ( keys %{ $linkable{$table_name} } ) {
149 my $linkmethodname;
150
151 if ( my $fk_xform = $t->format_fk_name ) {
152
153 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
154 $linkmethodname = $fk_xform->(
155 $linkable{ $table_name }{ $link }->name,
156 ( $schema->get_table( $link )->primary_key->fields )[0]
157 )
158 . 's';
159 }
160 else {
161 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
162 $linkmethodname =
163 $linkable{ $table_name }{ $link }->name . '_'
164 . ( $schema->get_table( $link )->primary_key->fields )[0]
165 . 's';
166 }
167
168 my @rk_fields = ();
169 my @lk_fields = ();
170 foreach my $field ( $linkable{$table_name}{$link}->get_fields )
171 {
172 next unless $field->is_foreign_key;
173
174 next unless (
175 $field->foreign_key_reference->reference_table eq
176 $table_name
177 ||
178 $field->foreign_key_reference->reference_table eq $link
179 );
180
181 push @lk_fields,
182 ( $field->foreign_key_reference->reference_fields )[0]
183 if $field->foreign_key_reference->reference_table eq
184 $link;
185
186 push @rk_fields, $field->name
187 if $field->foreign_key_reference->reference_table eq
188 $table_name;
189 }
190
191 #
192 # If one possible traversal via link table.
193 #
194 if ( scalar(@rk_fields) == 1 and scalar(@lk_fields) == 1 ) {
195 foreach my $rk_field (@rk_fields) {
196 push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
197 "sub "
198 . $linkmethodname
199 . " { my \$self = shift; "
200 . "return map \$_->"
201 . ( $schema->get_table($link)->primary_key->fields )
202 [0]
203 . ", \$self->"
204 . $linkable{$table_name}{$link}->name . "_"
205 . $rk_field
206 . " }\n\n";
207 }
208
209 #
210 # Else there is more than one way to traverse it.
211 # ack! Let's treat these types of link tables as
212 # a many-to-one (easier)
213 #
214 # NOTE: we need to rethink the link method name,
215 # as the cardinality has shifted on us.
216 #
217 }
218 elsif ( scalar(@rk_fields) == 1 ) {
219 foreach my $rk_field (@rk_fields) {
220 #
221 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
222 #
223 push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
224 "sub "
225 . $linkable{$table_name}{$link}->name
226 . "s { my \$self = shift; return \$self->"
227 . $linkable{$table_name}{$link}->name . "_"
228 . $rk_field
229 . "(\@_) }\n\n";
230 }
231 }
232 elsif ( scalar(@lk_fields) == 1 ) {
233 #
234 # These will be taken care of on the other end...
235 #
236 }
237 else {
238 #
239 # Many many many. Need multiple iterations here,
240 # data structure revision to handle N FK sources.
241 # This code has not been tested and likely doesn't
242 # work here.
243 #
244 foreach my $rk_field (@rk_fields) {
245 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
246 push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
247 "sub "
248 . $linkable{$table_name}{$link}->name . "_"
249 . $rk_field
250 . "s { my \$self = shift; return \$self->"
251 . $linkable{$table_name}{$link}->name . "_"
252 . $rk_field
253 . "(\@_) }\n\n";
254 }
255 }
256 }
257 }
d79af833 258
6c45056f 259 #
bf4629e7 260 # Use foreign keys to set up "has_a/has_many" relationships.
6c45056f 261 #
262 foreach my $field ( $table->get_fields ) {
263 if ( $field->is_foreign_key ) {
bf4629e7 264 my $table_name = $table->name;
6c45056f 265 my $field_name = $field->name;
41a7b982 266 my $fk_method = $t->format_fk_name( $table_name, $field_name );
6c45056f 267 my $fk = $field->foreign_key_reference;
268 my $ref_table = $fk->reference_table;
390292d3 269 my $ref_pkg = $t->format_package_name($ref_table);
41a7b982 270 my $ref_field = ( $fk->reference_fields )[0];
6c45056f 271
41a7b982 272 push @{ $packages{$table_pkg_name}{'has_a'} },
273 "$table_pkg_name->has_a(\n"
274 . " $field_name => '$ref_pkg'\n);\n\n"
275 . "sub $fk_method {\n"
276 . " return shift->$field_name\n}\n\n";
52fbac6a 277
41a7b982 278 # if there weren't M-M relationships via the has_many
279 # being set up here, create nice pluralized method alias
280 # rather for user as alt. to ugly tablename_fieldname name
281 #
282 if ( !$packages{$ref_pkg}{'has_many'}{$table_name} ) {
283 #
284 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
285 #
286 push @{ $packages{$ref_pkg}{'has_many'}{$table_name} },
287 "sub ${table_name}s {\n " .
288 "return shift->$table_name\_$field_name\n}\n\n";
289 # else ugly
290 }
291 else {
292 }
293
294 push @{ $packages{$ref_pkg}{'has_many'}{$table_name} },
295 "$ref_pkg->has_many(\n '${table_name}_${field_name}', "
296 . "'$table_pkg_name' => '$field_name'\n);\n\n";
71046f4b 297
fe77d758 298 }
41a7b982 299 }
300 }
6c45056f 301
fe77d758 302 #
303 # Now build up text of package.
304 #
bf4629e7 305 my $base_pkg = sprintf( 'Class::DBI%s', $from ? "::$from" : '' );
41a7b982 306 $create .= join ( "\n",
307 "package $main_pkg_name;\n",
308 $header,
309 "use strict;",
310 "use base '$base_pkg';\n",
311 "$main_pkg_name->set_db('Main', '$dsn', '$db_user', '$db_pass');\n\n",
312 );
313
314 for my $pkg_name (
bf4629e7 315 sort { $packages{ $a }{'order'} <=> $packages{ $b }{'order'} }
316 keys %packages
317 ) {
8b183a02 318 my $pkg = $packages{$pkg_name} or next;
319 next unless $pkg->{'pkg_name'};
bf4629e7 320
41a7b982 321 $create .= join ( "\n",
bf4629e7 322 $sep,
41a7b982 323 "package " . $pkg->{'pkg_name'} . ";",
324 "use base '" . $pkg->{'base'} . "';",
bf4629e7 325 "use Class::DBI::Pager;\n\n",
41a7b982 326 );
327
9c6eb8e3 328 if ( $from ) {
329 $create .=
330 $pkg->{'pkg_name'}."->set_up_table('".$pkg->{'table'}."');\n\n";
331 }
332 else {
333 my $table = $schema->get_table( $pkg->{'table'} );
334 my @field_names = map { $_->name } $table->get_fields;
420f63c7 335
9c6eb8e3 336 $create .= join("\n",
337 $pkg_name."->table('".$pkg->{'table'}."');\n",
338 $pkg_name."->columns(All => qw/".
339 join(' ', @field_names)."/);\n\n",
340 );
341 }
b789c790 342
41a7b982 343 $create .= "\n";
b789c790 344
bf4629e7 345 if ( my $pk = $pkg->{'pk_accessor'} ) {
346 $create .= $pk;
347 }
df602cfb 348
bf4629e7 349 if ( my @has_a = @{ $pkg->{'has_a'} || [] } ) {
350 $create .= $_ for @has_a;
351 }
352
41a7b982 353 foreach my $has_many_key ( keys %{ $pkg->{'has_many'} } ) {
354 if ( my @has_many = @{ $pkg->{'has_many'}{$has_many_key} || [] } ) {
355 $create .= $_ for @has_many;
356 }
357 }
6c45056f 358 }
df602cfb 359
bf4629e7 360 $create .= "1;\n";
361
362 return $create;
f42e7027 363}
364
3651;
366
bf4629e7 367# -------------------------------------------------------------------
368
369=pod
f42e7027 370
371=head1 NAME
372
bf4629e7 373SQL::Translator::Producer::ClassDBI - create Class::DBI classes from schema
f42e7027 374
375=head1 SYNOPSIS
376
1eee27d3 377Use this producer as you would any other from SQL::Translator. See
378L<SQL::Translator> for details.
f42e7027 379
1eee27d3 380This package utilizes SQL::Translator's formatting methods
381format_package_name(), format_pk_name(), format_fk_name(), and
382format_table_name() as it creates classes, one per table in the schema
383provided. An additional base class is also created for database connectivity
384configuration. See L<Class::DBI> for details on how this works.
f42e7027 385
6c45056f 386=head1 AUTHORS
f42e7027 387
7c2e6f47 388Allen Day E<lt>allenday@ucla.eduE<gt>,
5f054727 389Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
799df8f9 390Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.