1 package SQL::Translator::Schema;
3 # ----------------------------------------------------------------------
4 # $Id: Schema.pm,v 1.15 2004-07-26 13:55:51 kycl4rk 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 # -------------------------------------------------------------------
27 SQL::Translator::Schema - SQL::Translator schema object
31 use SQL::Translator::Schema;
32 my $schema = SQL::Translator::Schema->new;
33 my $table = $schema->add_table( name => 'foo' );
34 my $view = $schema->add_view( name => 'bar', sql => '...' );
38 C<SQL::Translator::Schema> is the object that accepts, validates, and
39 returns the database structure.
47 use SQL::Translator::Schema::Constants;
48 use SQL::Translator::Schema::Procedure;
49 use SQL::Translator::Schema::Table;
50 use SQL::Translator::Schema::Trigger;
51 use SQL::Translator::Schema::View;
52 use SQL::Translator::Utils 'parse_list_arg';
54 use base 'Class::Base';
55 use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER $PROC_ORDER ];
57 $VERSION = sprintf "%d.%02d", q$Revision: 1.15 $ =~ /(\d+)\.(\d+)/;
59 # ----------------------------------------------------------------------
68 my $schema = SQL::Translator::Schema->new(
75 my ( $self, $config ) = @_;
76 $self->params( $config, qw[ name database ] ) || return undef;
80 # ----------------------------------------------------------------------
87 Add a table object. Returns the new SQL::Translator::Schema::Table object.
88 The "name" parameter is required. If you try to create a table with the
89 same name as an existing table, you will get an error and the table will
92 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
93 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
94 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
99 my $table_class = 'SQL::Translator::Schema::Table';
102 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
104 $table->schema( $self );
108 $args{'schema'} = $self;
109 $table = $table_class->new( \%args ) or return
110 $self->error( $table_class->error );
113 $table->order( ++$TABLE_ORDER );
114 # We know we have a name as the Table->new above errors if none given.
115 my $table_name = $table->name;
117 if ( defined $self->{'tables'}{ $table_name } ) {
118 return $self->error(qq[Can't create table: "$table_name" exists]);
121 $self->{'tables'}{ $table_name } = $table;
127 # ----------------------------------------------------------------------
134 Add a procedure object. Returns the new
135 SQL::Translator::Schema::Procedure object. The "name" parameter is
136 required. If you try to create a procedure with the same name as an
137 existing procedure, you will get an error and the procedure will not
140 my $p1 = $schema->add_procedure( name => 'foo' );
141 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
142 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
147 my $procedure_class = 'SQL::Translator::Schema::Procedure';
150 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
152 $procedure->schema( $self );
156 $args{'schema'} = $self;
157 return $self->error('No procedure name') unless $args{'name'};
158 $procedure = $procedure_class->new( \%args ) or
159 return $self->error( $procedure_class->error );
162 $procedure->order( ++$PROC_ORDER );
163 my $procedure_name = $procedure->name or return
164 $self->error('No procedure name');
166 if ( defined $self->{'procedures'}{ $procedure_name } ) {
168 qq[Can't create procedure: "$procedure_name" exists]
172 $self->{'procedures'}{ $procedure_name } = $procedure;
178 # ----------------------------------------------------------------------
185 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
186 The "name" parameter is required. If you try to create a trigger with the
187 same name as an existing trigger, you will get an error and the trigger will
190 my $t1 = $schema->add_trigger( name => 'foo' );
191 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
192 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
197 my $trigger_class = 'SQL::Translator::Schema::Trigger';
200 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
202 $trigger->schema( $self );
206 $args{'schema'} = $self;
207 return $self->error('No trigger name') unless $args{'name'};
208 $trigger = $trigger_class->new( \%args ) or
209 return $self->error( $trigger_class->error );
212 $trigger->order( ++$TRIGGER_ORDER );
213 my $trigger_name = $trigger->name or return $self->error('No trigger name');
215 if ( defined $self->{'triggers'}{ $trigger_name } ) {
216 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
219 $self->{'triggers'}{ $trigger_name } = $trigger;
225 # ----------------------------------------------------------------------
232 Add a view object. Returns the new SQL::Translator::Schema::View object.
233 The "name" parameter is required. If you try to create a view with the
234 same name as an existing view, you will get an error and the view will
237 my $v1 = $schema->add_view( name => 'foo' );
238 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
239 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
244 my $view_class = 'SQL::Translator::Schema::View';
247 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
249 $view->schema( $self );
253 $args{'schema'} = $self;
254 return $self->error('No view name') unless $args{'name'};
255 $view = $view_class->new( \%args ) or return $view_class->error;
258 $view->order( ++$VIEW_ORDER );
259 my $view_name = $view->name or return $self->error('No view name');
261 if ( defined $self->{'views'}{ $view_name } ) {
262 return $self->error(qq[Can't create view: "$view_name" exists]);
265 $self->{'views'}{ $view_name } = $view;
271 # ----------------------------------------------------------------------
278 Get or set the schema's database. (optional)
280 my $database = $schema->database('PostgreSQL');
285 $self->{'database'} = shift if @_;
286 return $self->{'database'} || '';
289 # ----------------------------------------------------------------------
296 Returns true if all the tables and views are valid.
298 my $ok = $schema->is_valid or die $schema->error;
304 return $self->error('No tables') unless $self->get_tables;
306 for my $object ( $self->get_tables, $self->get_views ) {
307 return $object->error unless $object->is_valid;
313 # ----------------------------------------------------------------------
320 Returns a procedure by the name provided.
322 my $procedure = $schema->get_procedure('foo');
327 my $procedure_name = shift or return $self->error('No procedure name');
328 return $self->error( qq[Table "$procedure_name" does not exist] ) unless
329 exists $self->{'procedures'}{ $procedure_name };
330 return $self->{'procedures'}{ $procedure_name };
333 # ----------------------------------------------------------------------
338 =head2 get_procedures
340 Returns all the procedures as an array or array reference.
342 my @procedures = $schema->get_procedures;
349 sort { $a->[0] <=> $b->[0] }
350 map { [ $_->order, $_ ] }
351 values %{ $self->{'procedures'} };
354 return wantarray ? @procedures : \@procedures;
357 $self->error('No procedures');
358 return wantarray ? () : undef;
362 # ----------------------------------------------------------------------
369 Returns a table by the name provided.
371 my $table = $schema->get_table('foo');
376 my $table_name = shift or return $self->error('No table name');
377 return $self->error( qq[Table "$table_name" does not exist] ) unless
378 exists $self->{'tables'}{ $table_name };
379 return $self->{'tables'}{ $table_name };
382 # ----------------------------------------------------------------------
389 Returns all the tables as an array or array reference.
391 my @tables = $schema->get_tables;
398 sort { $a->[0] <=> $b->[0] }
399 map { [ $_->order, $_ ] }
400 values %{ $self->{'tables'} };
403 return wantarray ? @tables : \@tables;
406 $self->error('No tables');
407 return wantarray ? () : undef;
411 # ----------------------------------------------------------------------
418 Returns a trigger by the name provided.
420 my $trigger = $schema->get_trigger('foo');
425 my $trigger_name = shift or return $self->error('No trigger name');
426 return $self->error( qq[Table "$trigger_name" does not exist] ) unless
427 exists $self->{'triggers'}{ $trigger_name };
428 return $self->{'triggers'}{ $trigger_name };
431 # ----------------------------------------------------------------------
438 Returns all the triggers as an array or array reference.
440 my @triggers = $schema->get_triggers;
447 sort { $a->[0] <=> $b->[0] }
448 map { [ $_->order, $_ ] }
449 values %{ $self->{'triggers'} };
452 return wantarray ? @triggers : \@triggers;
455 $self->error('No triggers');
456 return wantarray ? () : undef;
460 # ----------------------------------------------------------------------
467 Returns a view by the name provided.
469 my $view = $schema->get_view('foo');
474 my $view_name = shift or return $self->error('No view name');
475 return $self->error('View "$view_name" does not exist') unless
476 exists $self->{'views'}{ $view_name };
477 return $self->{'views'}{ $view_name };
480 # ----------------------------------------------------------------------
487 Returns all the views as an array or array reference.
489 my @views = $schema->get_views;
496 sort { $a->[0] <=> $b->[0] }
497 map { [ $_->order, $_ ] }
498 values %{ $self->{'views'} };
501 return wantarray ? @views : \@views;
504 $self->error('No views');
505 return wantarray ? () : undef;
509 # ----------------------------------------------------------------------
510 sub make_natural_joins {
514 =head2 make_natural_joins
516 Creates foriegn key relationships among like-named fields in different
517 tables. Accepts the following arguments:
523 A True or False argument which determins whether or not to perform
524 the joins from primary keys to fields of the same name in other tables
528 A list of fields to skip in the joins
532 $schema->make_natural_joins(
534 skip_fields => 'name,department_id',
541 my $join_pk_only = $args{'join_pk_only'} || 0;
542 my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{
543 parse_list_arg( $args{'skip_fields'} )
546 my ( %common_keys, %pk );
547 for my $table ( $self->get_tables ) {
548 for my $field ( $table->get_fields ) {
549 my $field_name = $field->name or next;
550 next if $skip_fields{ $field_name };
551 $pk{ $field_name } = 1 if $field->is_primary_key;
552 push @{ $common_keys{ $field_name } }, $table->name;
556 for my $field ( keys %common_keys ) {
557 next if $join_pk_only and !defined $pk{ $field };
559 my @table_names = @{ $common_keys{ $field } };
560 next unless scalar @table_names > 1;
562 for my $i ( 0 .. $#table_names ) {
563 my $table1 = $self->get_table( $table_names[ $i ] ) or next;
565 for my $j ( 1 .. $#table_names ) {
566 my $table2 = $self->get_table( $table_names[ $j ] ) or next;
567 next if $table1->name eq $table2->name;
569 $table1->add_constraint(
572 reference_table => $table2->name,
573 reference_fields => $field,
582 # ----------------------------------------------------------------------
589 Get or set the schema's name. (optional)
591 my $schema_name = $schema->name('Foo Database');
596 $self->{'name'} = shift if @_;
597 return $self->{'name'} || '';
600 # ----------------------------------------------------------------------
603 undef $_ for values %{ $self->{'tables'} };
604 undef $_ for values %{ $self->{'views'} };
609 # ----------------------------------------------------------------------
615 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>