1 package SQL::Translator::Producer::ClassDBI;
3 # -------------------------------------------------------------------
4 # $Id: ClassDBI.pm,v 1.43 2005-07-07 22:37:19 allenday Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
24 use vars qw[ $VERSION $DEBUG ];
25 $VERSION = sprintf "%d.%02d", q$Revision: 1.43 $ =~ /(\d+)\.(\d+)/;
26 $DEBUG = 1 unless defined $DEBUG;
28 use SQL::Translator::Schema::Constants;
29 use SQL::Translator::Utils qw(debug header_comment);
32 my %CDBI_auto_pkgs = (
38 # -------------------------------------------------------------------
42 local $DEBUG = $t->debug;
43 my $no_comments = $t->no_comments;
44 my $schema = $t->schema;
45 my $args = $t->producer_args;
46 if ( my $fmt = $args->{'format_pkg_name'} ) {
47 $t->format_package_name( $fmt );
49 if ( my $fmt = $args->{'format_fk_name'} ) {
50 $t->format_fk_name( $fmt );
52 my $db_user = $args->{'db_user'} || '';
53 my $db_pass = $args->{'db_pass'} || '';
54 my $main_pkg_name = $args->{'main_pkg_name'} ||
55 $t->format_package_name('DBI');
56 my $header = header_comment( __PACKAGE__, "# " );
57 my $parser_type = ( split /::/, $t->parser_type )[-1];
58 my $from = $CDBI_auto_pkgs{$parser_type} || '';
59 my $dsn = $args->{'dsn'} || sprintf( 'dbi:%s:_',
60 $CDBI_auto_pkgs{ $parser_type }
61 ? $CDBI_auto_pkgs{ $parser_type } : $parser_type
63 my $sep = '# ' . '-' x 67;
67 # Identify "link tables" (have only PK and FK fields).
71 for my $table ( $schema->get_tables ) {
72 debug("PKG: Table = ", $table->name, "\n");
74 for my $field ( $table->get_fields ) {
75 unless ( $field->is_primary_key or $field->is_foreign_key ) {
83 foreach my $left ( $table->get_fields ) {
84 next unless $left->is_foreign_key;
85 my $lfk = $left->foreign_key_reference or next;
86 my $lr_table = $schema->get_table( $lfk->reference_table )
88 my $lr_field_name = ( $lfk->reference_fields )[0];
89 my $lr_field = $lr_table->get_field($lr_field_name);
90 next unless $lr_field->is_primary_key;
92 foreach my $right ( $table->get_fields ) {
93 next if $left->name eq $right->name;
95 my $rfk = $right->foreign_key_reference or next;
96 my $rr_table = $schema->get_table( $rfk->reference_table )
98 my $rr_field_name = ( $rfk->reference_fields )[0];
99 my $rr_field = $rr_table->get_field($rr_field_name);
100 next unless $rr_field->is_primary_key;
102 $linkable{ $lr_table->name }{ $rr_table->name } = $table;
103 $linkable{ $rr_table->name }{ $lr_table->name } = $table;
104 $linktable{ $table->name } = $table;
110 # Iterate over all tables
112 my ( %packages, $order );
113 for my $table ( $schema->get_tables ) {
114 my $table_name = $table->name or next;
116 my $table_pkg_name = $t->format_package_name($table_name);
117 $packages{ $table_pkg_name } = {
119 pkg_name => $table_pkg_name,
120 base => $main_pkg_name,
121 table => $table_name,
125 # Primary key may have a differenct accessor method name
127 # if ( my $constraint = $table->primary_key ) {
128 # my $field = ( $constraint->fields )[0];
129 # $packages{ $table_pkg_name }{'_columns_primary'} = $field;
131 # if ( my $pk_xform = $t->format_pk_name ) {
132 # my $pk_name = $pk_xform->( $table_pkg_name, $field );
134 # $packages{$table_pkg_name}{'pk_accessor'} =
135 # "#\n# Primary key accessor\n#\n"
136 # . "sub $pk_name {\n shift->$field\n}\n\n";
141 foreach my $field ( $table->get_fields ) {
142 if ( !$field->is_foreign_key and !$field->is_primary_key ) {
143 push @{ $packages{$table_pkg_name}{'_columns_essential'} },
147 elsif ( !$field->is_primary_key ) {
148 push @{ $packages{$table_pkg_name}{'_columns_others'} },
155 foreach my $link ( keys %{ $linkable{$table_name} } ) {
158 if ( my $fk_xform = $t->format_fk_name ) {
160 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
161 $linkmethodname = $fk_xform->(
162 $linkable{ $table_name }{ $link }->name,
163 ( $schema->get_table( $link )->primary_key->fields )[0]
168 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
170 $linkable{ $table_name }{ $link }->name . '_'
171 . ( $schema->get_table( $link )->primary_key->fields )[0]
177 foreach my $field ( $linkable{$table_name}{$link}->get_fields )
179 next unless $field->is_foreign_key;
182 $field->foreign_key_reference->reference_table eq
185 $field->foreign_key_reference->reference_table eq $link
189 ( $field->foreign_key_reference->reference_fields )[0]
190 if $field->foreign_key_reference->reference_table eq
193 push @rk_fields, $field->name
194 if $field->foreign_key_reference->reference_table eq
199 # If one possible traversal via link table.
201 if ( scalar(@rk_fields) == 1 and scalar(@lk_fields) == 1 ) {
202 foreach my $rk_field (@rk_fields) {
203 push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
206 . " { my \$self = shift; "
208 . ( $schema->get_table($link)->primary_key->fields )
211 . $linkable{$table_name}{$link}->name . "_"
217 # Else there is more than one way to traverse it.
218 # ack! Let's treat these types of link tables as
219 # a many-to-one (easier)
221 # NOTE: we need to rethink the link method name,
222 # as the cardinality has shifted on us.
225 elsif ( scalar(@rk_fields) == 1 ) {
226 foreach my $rk_field (@rk_fields) {
228 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
230 push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
232 . $linkable{$table_name}{$link}->name
233 . "s { my \$self = shift; return \$self->"
234 . $linkable{$table_name}{$link}->name . "_"
239 elsif ( scalar(@lk_fields) == 1 ) {
241 # These will be taken care of on the other end...
246 # Many many many. Need multiple iterations here,
247 # data structure revision to handle N FK sources.
248 # This code has not been tested and likely doesn't
251 foreach my $rk_field (@rk_fields) {
252 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
253 push @{ $packages{$table_pkg_name}{'has_many'}{$link} },
255 . $linkable{$table_name}{$link}->name . "_"
257 . "s { my \$self = shift; return \$self->"
258 . $linkable{$table_name}{$link}->name . "_"
267 # Use foreign keys to set up "has_a/has_many" relationships.
269 foreach my $field ( $table->get_fields ) {
270 if ( $field->is_foreign_key ) {
271 my $table_name = $table->name;
272 my $field_name = $field->name;
273 # my $fk_method = $t->format_fk_name( $table_name, $field_name );
274 my $fk_method = join('::', $table_pkg_name,
275 $t->format_fk_name( $table_name, $field_name )
277 my $fk = $field->foreign_key_reference;
278 my $ref_table = $fk->reference_table;
279 my $ref_pkg = $t->format_package_name($ref_table);
280 my $ref_field = ( $fk->reference_fields )[0];
281 # my $fk_method = join('::',
282 # $table_pkg_name, $t->format_fk_name( $ref_table )
285 push @{ $packages{$table_pkg_name}{'has_a'} },
286 "$table_pkg_name->has_a(\n"
287 . " $field_name => '$ref_pkg'\n);\n\n"
288 . "sub $fk_method {\n"
289 . " return shift->$field_name\n}\n\n"
292 # if there weren't M-M relationships via the has_many
293 # being set up here, create nice pluralized method alias
294 # rather for user as alt. to ugly tablename_fieldname name
296 # if ( !$packages{$ref_pkg}{'has_many'}{$table_name} ) {
298 # # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
300 # push @{ $packages{$ref_pkg}{'has_many'}{$table_name} },
301 # "sub ${table_name}s {\n " .
302 # "return shift->$table_name\_$field_name\n}\n\n";
308 push @{ $packages{$ref_pkg}{'has_many'}{$table_name} },
309 "$ref_pkg->has_many(\n '${table_name}_${field_name}', "
310 . "'$table_pkg_name' => '$field_name'\n);\n\n";
317 # Now build up text of package.
319 my $base_pkg = sprintf( 'Class::DBI%s', $from ? "::$from" : '' );
320 $create .= join ( "\n",
321 "package $main_pkg_name;\n",
324 "use base '$base_pkg';\n",
325 "$main_pkg_name->set_db('Main', '$dsn', '$db_user', '$db_pass');\n\n",
329 sort { $packages{ $a }{'order'} <=> $packages{ $b }{'order'} }
332 my $pkg = $packages{$pkg_name} or next;
333 next unless $pkg->{'pkg_name'};
335 $create .= join ( "\n",
337 "package " . $pkg->{'pkg_name'} . ";",
338 "use base '" . $pkg->{'base'} . "';",
339 "use Class::DBI::Pager;\n\n",
344 $pkg->{'pkg_name'}."->set_up_table('".$pkg->{'table'}."');\n\n";
347 my $table = $schema->get_table( $pkg->{'table'} );
348 my @field_names = map { $_->name } $table->get_fields;
350 $create .= join("\n",
351 $pkg_name."->table('".$pkg->{'table'}."');\n",
352 $pkg_name."->columns(All => qw/".
353 join(' ', @field_names)."/);\n\n",
359 if ( my $pk = $pkg->{'pk_accessor'} ) {
363 if ( my @has_a = @{ $pkg->{'has_a'} || [] } ) {
364 $create .= $_ for @has_a;
367 foreach my $has_many_key ( keys %{ $pkg->{'has_many'} } ) {
368 if ( my @has_many = @{ $pkg->{'has_many'}{$has_many_key} || [] } ) {
369 $create .= $_ for @has_many;
381 # -------------------------------------------------------------------
387 SQL::Translator::Producer::ClassDBI - create Class::DBI classes from schema
391 Use this producer as you would any other from SQL::Translator. See
392 L<SQL::Translator> for details.
394 This package utilizes SQL::Translator's formatting methods
395 format_package_name(), format_pk_name(), format_fk_name(), and
396 format_table_name() as it creates classes, one per table in the schema
397 provided. An additional base class is also created for database connectivity
398 configuration. See L<Class::DBI> for details on how this works.
402 Allen Day E<lt>allenday@ucla.eduE<gt>,
403 Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
404 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.