1 package SQL::Translator::Schema;
3 # ----------------------------------------------------------------------
4 # $Id: Schema.pm,v 1.18 2004-10-15 03:52:50 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 # -------------------------------------------------------------------
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::Schema::Graph;
53 use SQL::Translator::Utils 'parse_list_arg';
55 use base 'Class::Base';
56 use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER $PROC_ORDER ];
58 $VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/;
60 # ----------------------------------------------------------------------
69 my $schema = SQL::Translator::Schema->new(
76 my ( $self, $config ) = @_;
77 $self->params( $config, qw[ name database translator ] )
84 return SQL::Translator::Schema::Graph->new(translator => $self->translator);
87 # ----------------------------------------------------------------------
94 Add a table object. Returns the new SQL::Translator::Schema::Table object.
95 The "name" parameter is required. If you try to create a table with the
96 same name as an existing table, you will get an error and the table will
99 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
100 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
101 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
106 my $table_class = 'SQL::Translator::Schema::Table';
109 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
111 $table->schema( $self );
115 $args{'schema'} = $self;
116 $table = $table_class->new( \%args ) or return
117 $self->error( $table_class->error );
120 $table->order( ++$TABLE_ORDER );
121 # We know we have a name as the Table->new above errors if none given.
122 my $table_name = $table->name;
124 if ( defined $self->{'tables'}{ $table_name } ) {
125 return $self->error(qq[Can't create table: "$table_name" exists]);
128 $self->{'tables'}{ $table_name } = $table;
134 # ----------------------------------------------------------------------
141 Add a procedure object. Returns the new
142 SQL::Translator::Schema::Procedure object. The "name" parameter is
143 required. If you try to create a procedure with the same name as an
144 existing procedure, you will get an error and the procedure will not
147 my $p1 = $schema->add_procedure( name => 'foo' );
148 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
149 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
154 my $procedure_class = 'SQL::Translator::Schema::Procedure';
157 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
159 $procedure->schema( $self );
163 $args{'schema'} = $self;
164 return $self->error('No procedure name') unless $args{'name'};
165 $procedure = $procedure_class->new( \%args ) or
166 return $self->error( $procedure_class->error );
169 $procedure->order( ++$PROC_ORDER );
170 my $procedure_name = $procedure->name or return
171 $self->error('No procedure name');
173 if ( defined $self->{'procedures'}{ $procedure_name } ) {
175 qq[Can't create procedure: "$procedure_name" exists]
179 $self->{'procedures'}{ $procedure_name } = $procedure;
185 # ----------------------------------------------------------------------
192 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
193 The "name" parameter is required. If you try to create a trigger with the
194 same name as an existing trigger, you will get an error and the trigger will
197 my $t1 = $schema->add_trigger( name => 'foo' );
198 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
199 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
204 my $trigger_class = 'SQL::Translator::Schema::Trigger';
207 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
209 $trigger->schema( $self );
213 $args{'schema'} = $self;
214 return $self->error('No trigger name') unless $args{'name'};
215 $trigger = $trigger_class->new( \%args ) or
216 return $self->error( $trigger_class->error );
219 $trigger->order( ++$TRIGGER_ORDER );
220 my $trigger_name = $trigger->name or return $self->error('No trigger name');
222 if ( defined $self->{'triggers'}{ $trigger_name } ) {
223 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
226 $self->{'triggers'}{ $trigger_name } = $trigger;
232 # ----------------------------------------------------------------------
239 Add a view object. Returns the new SQL::Translator::Schema::View object.
240 The "name" parameter is required. If you try to create a view with the
241 same name as an existing view, you will get an error and the view will
244 my $v1 = $schema->add_view( name => 'foo' );
245 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
246 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
251 my $view_class = 'SQL::Translator::Schema::View';
254 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
256 $view->schema( $self );
260 $args{'schema'} = $self;
261 return $self->error('No view name') unless $args{'name'};
262 $view = $view_class->new( \%args ) or return $view_class->error;
265 $view->order( ++$VIEW_ORDER );
266 my $view_name = $view->name or return $self->error('No view name');
268 if ( defined $self->{'views'}{ $view_name } ) {
269 return $self->error(qq[Can't create view: "$view_name" exists]);
272 $self->{'views'}{ $view_name } = $view;
278 # ----------------------------------------------------------------------
285 Get or set the schema's database. (optional)
287 my $database = $schema->database('PostgreSQL');
292 $self->{'database'} = shift if @_;
293 return $self->{'database'} || '';
296 # ----------------------------------------------------------------------
303 Returns true if all the tables and views are valid.
305 my $ok = $schema->is_valid or die $schema->error;
311 return $self->error('No tables') unless $self->get_tables;
313 for my $object ( $self->get_tables, $self->get_views ) {
314 return $object->error unless $object->is_valid;
320 # ----------------------------------------------------------------------
327 Returns a procedure by the name provided.
329 my $procedure = $schema->get_procedure('foo');
334 my $procedure_name = shift or return $self->error('No procedure name');
335 return $self->error( qq[Table "$procedure_name" does not exist] ) unless
336 exists $self->{'procedures'}{ $procedure_name };
337 return $self->{'procedures'}{ $procedure_name };
340 # ----------------------------------------------------------------------
345 =head2 get_procedures
347 Returns all the procedures as an array or array reference.
349 my @procedures = $schema->get_procedures;
356 sort { $a->[0] <=> $b->[0] }
357 map { [ $_->order, $_ ] }
358 values %{ $self->{'procedures'} };
361 return wantarray ? @procedures : \@procedures;
364 $self->error('No procedures');
365 return wantarray ? () : undef;
369 # ----------------------------------------------------------------------
376 Returns a table by the name provided.
378 my $table = $schema->get_table('foo');
383 my $table_name = shift or return $self->error('No table name');
384 return $self->error( qq[Table "$table_name" does not exist] ) unless
385 exists $self->{'tables'}{ $table_name };
386 return $self->{'tables'}{ $table_name };
389 # ----------------------------------------------------------------------
396 Returns all the tables as an array or array reference.
398 my @tables = $schema->get_tables;
405 sort { $a->[0] <=> $b->[0] }
406 map { [ $_->order, $_ ] }
407 values %{ $self->{'tables'} };
410 return wantarray ? @tables : \@tables;
413 $self->error('No tables');
414 return wantarray ? () : undef;
418 # ----------------------------------------------------------------------
425 Returns a trigger by the name provided.
427 my $trigger = $schema->get_trigger('foo');
432 my $trigger_name = shift or return $self->error('No trigger name');
433 return $self->error( qq[Table "$trigger_name" does not exist] ) unless
434 exists $self->{'triggers'}{ $trigger_name };
435 return $self->{'triggers'}{ $trigger_name };
438 # ----------------------------------------------------------------------
445 Returns all the triggers as an array or array reference.
447 my @triggers = $schema->get_triggers;
454 sort { $a->[0] <=> $b->[0] }
455 map { [ $_->order, $_ ] }
456 values %{ $self->{'triggers'} };
459 return wantarray ? @triggers : \@triggers;
462 $self->error('No triggers');
463 return wantarray ? () : undef;
467 # ----------------------------------------------------------------------
474 Returns a view by the name provided.
476 my $view = $schema->get_view('foo');
481 my $view_name = shift or return $self->error('No view name');
482 return $self->error('View "$view_name" does not exist') unless
483 exists $self->{'views'}{ $view_name };
484 return $self->{'views'}{ $view_name };
487 # ----------------------------------------------------------------------
494 Returns all the views as an array or array reference.
496 my @views = $schema->get_views;
503 sort { $a->[0] <=> $b->[0] }
504 map { [ $_->order, $_ ] }
505 values %{ $self->{'views'} };
508 return wantarray ? @views : \@views;
511 $self->error('No views');
512 return wantarray ? () : undef;
516 # ----------------------------------------------------------------------
517 sub make_natural_joins {
521 =head2 make_natural_joins
523 Creates foriegn key relationships among like-named fields in different
524 tables. Accepts the following arguments:
530 A True or False argument which determins whether or not to perform
531 the joins from primary keys to fields of the same name in other tables
535 A list of fields to skip in the joins
539 $schema->make_natural_joins(
541 skip_fields => 'name,department_id',
548 my $join_pk_only = $args{'join_pk_only'} || 0;
549 my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{
550 parse_list_arg( $args{'skip_fields'} )
553 my ( %common_keys, %pk );
554 for my $table ( $self->get_tables ) {
555 for my $field ( $table->get_fields ) {
556 my $field_name = $field->name or next;
557 next if $skip_fields{ $field_name };
558 $pk{ $field_name } = 1 if $field->is_primary_key;
559 push @{ $common_keys{ $field_name } }, $table->name;
563 for my $field ( keys %common_keys ) {
564 next if $join_pk_only and !defined $pk{ $field };
566 my @table_names = @{ $common_keys{ $field } };
567 next unless scalar @table_names > 1;
569 for my $i ( 0 .. $#table_names ) {
570 my $table1 = $self->get_table( $table_names[ $i ] ) or next;
572 for my $j ( 1 .. $#table_names ) {
573 my $table2 = $self->get_table( $table_names[ $j ] ) or next;
574 next if $table1->name eq $table2->name;
576 $table1->add_constraint(
579 reference_table => $table2->name,
580 reference_fields => $field,
589 # ----------------------------------------------------------------------
596 Get or set the schema's name. (optional)
598 my $schema_name = $schema->name('Foo Database');
603 $self->{'name'} = shift if @_;
604 return $self->{'name'} || '';
609 get the SQL::Translator instance that instatiated me
615 $self->{'translator'} = shift if @_;
616 return $self->{'translator'};
619 # ----------------------------------------------------------------------
622 undef $_ for values %{ $self->{'tables'} };
623 undef $_ for values %{ $self->{'views'} };
628 # ----------------------------------------------------------------------
634 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>