1 package SQL::Translator::Producer::ClassDBI;
3 # -------------------------------------------------------------------
4 # $Id: ClassDBI.pm,v 1.13 2003-06-10 15:06:04 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
7 # Ying Zhang <zyolive@yahoo.com>
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.13 $ =~ /(\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 base ".$translator->format_package_name('DBI').";\n";
70 $create .= "use mixin 'Class::DBI::Join';\n";
71 $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";
111 # Identify link tables, defined as tables that have only PK and FK
115 foreach my $table ( $schema->get_tables) {
117 foreach my $field ($table->get_fields){
118 unless ( $field->is_primary_key or $field->is_foreign_key ) {
125 foreach my $left ( $table->get_fields ) {
126 next unless $left->is_foreign_key and
128 $left->foreign_key_reference->reference_table
130 ($left->foreign_key_reference->reference_fields)[0]
133 foreach my $right ( $table->get_fields ) {
135 next if $left->name eq $right->name;
136 next unless $right->is_foreign_key and
138 $right->foreign_key_reference->reference_table
140 ($right->foreign_key_reference->reference_fields)[0]
144 $left->foreign_key_reference->reference_table
146 $right->foreign_key_reference->reference_table
150 $right->foreign_key_reference->reference_table
152 $left->foreign_key_reference->reference_table
155 # if($left->foreign_key_reference->reference_table eq 'feature' and
156 # $right->foreign_key_reference->reference_table eq 'pub'){
157 # warn $left->foreign_key_reference->reference_table . " to " . $right->foreign_key_reference->reference_table . " via " . $table->name;
158 # warn "\tleft: ".$left->name;
159 # warn "\tright: ".$right->name;
168 # Generate many-to-many linking methods for data tables
171 for ( $table->get_fields ) {
172 $is_data++ if !$_->is_foreign_key and !$_->is_primary_key;
177 foreach my $link ( keys %{ $linkable{ $table->name } } ) {
179 "_". $translator->format_fk_name($table->name,$link)."_refs";
182 $create .= $translator->format_package_name($table->name).
183 "->has_many('$linkmethodname','".
184 $translator->format_package_name(
185 $linkable{ $table->name }{ $link }->name
186 ) . "','" . $link . "');\n";
188 $create .= "sub ". $translator->format_fk_name($table,$link).
189 # HARDCODED 's' HERE. ADD CALLBACK
190 # FOR PLURALIZATION MANGLING
191 "s {\n my \$self = shift; return map \$_->".$link.
192 ", \$self->".$linkmethodname.";\n}\n\n";
205 my @temp = split(/::/, $from);
206 $from = $temp[$#temp];
208 if ( $from eq 'MySQL') {
210 } elsif ( $from eq 'PostgreSQL') {
212 } elsif ( $from eq 'Oracle') {
215 die "__PACKAGE__ can't handle vendor $from";
227 SQL::Translator::Producer::ClassDBI -
228 Translate SQL schemata into Class::DBI classes
232 Use this producer as you would any other from SQL::Translator. See
233 L<SQL::Translator> for details.
235 This package utilizes SQL::Translator's formatting methods
236 format_package_name(), format_pk_name(), format_fk_name(), and
237 format_table_name() as it creates classes, one per table in the schema
238 provided. An additional base class is also created for database connectivity
239 configuration. See L<Class::DBI> for details on how this works.
243 Allen Day E<lt>allenday@ucla.eduE<gt>
244 Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
245 Ken Y. Clark E<lt>kclark@cpan.org<gt>.