1 package SQL::Translator::Schema;
3 # ----------------------------------------------------------------------
4 # $Id: Schema.pm,v 1.20 2004-11-05 13:19:31 grommit 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.
46 use SQL::Translator::Schema::Constants;
47 use SQL::Translator::Schema::Procedure;
48 use SQL::Translator::Schema::Table;
49 use SQL::Translator::Schema::Trigger;
50 use SQL::Translator::Schema::View;
51 use SQL::Translator::Schema::Graph;
52 use SQL::Translator::Utils 'parse_list_arg';
54 use base 'SQL::Translator::Schema::Object';
55 use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER $PROC_ORDER ];
57 $VERSION = sprintf "%d.%02d", q$Revision: 1.20 $ =~ /(\d+)\.(\d+)/;
59 # ----------------------------------------------------------------------
61 __PACKAGE__->_attributes( qw/name database translator/ );
69 my $schema = SQL::Translator::Schema->new(
78 return SQL::Translator::Schema::Graph->new(translator => $self->translator);
81 # ----------------------------------------------------------------------
88 Add a table object. Returns the new SQL::Translator::Schema::Table object.
89 The "name" parameter is required. If you try to create a table with the
90 same name as an existing table, you will get an error and the table will
93 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
94 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
95 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
100 my $table_class = 'SQL::Translator::Schema::Table';
103 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
105 $table->schema( $self );
109 $args{'schema'} = $self;
110 $table = $table_class->new( \%args ) or return
111 $self->error( $table_class->error );
114 $table->order( ++$TABLE_ORDER );
115 # We know we have a name as the Table->new above errors if none given.
116 my $table_name = $table->name;
118 if ( defined $self->{'tables'}{ $table_name } ) {
119 return $self->error(qq[Can't create table: "$table_name" exists]);
122 $self->{'tables'}{ $table_name } = $table;
128 # ----------------------------------------------------------------------
135 Add a procedure object. Returns the new
136 SQL::Translator::Schema::Procedure object. The "name" parameter is
137 required. If you try to create a procedure with the same name as an
138 existing procedure, you will get an error and the procedure will not
141 my $p1 = $schema->add_procedure( name => 'foo' );
142 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
143 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
148 my $procedure_class = 'SQL::Translator::Schema::Procedure';
151 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
153 $procedure->schema( $self );
157 $args{'schema'} = $self;
158 return $self->error('No procedure name') unless $args{'name'};
159 $procedure = $procedure_class->new( \%args ) or
160 return $self->error( $procedure_class->error );
163 $procedure->order( ++$PROC_ORDER );
164 my $procedure_name = $procedure->name or return
165 $self->error('No procedure name');
167 if ( defined $self->{'procedures'}{ $procedure_name } ) {
169 qq[Can't create procedure: "$procedure_name" exists]
173 $self->{'procedures'}{ $procedure_name } = $procedure;
179 # ----------------------------------------------------------------------
186 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
187 The "name" parameter is required. If you try to create a trigger with the
188 same name as an existing trigger, you will get an error and the trigger will
191 my $t1 = $schema->add_trigger( name => 'foo' );
192 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
193 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
198 my $trigger_class = 'SQL::Translator::Schema::Trigger';
201 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
203 $trigger->schema( $self );
207 $args{'schema'} = $self;
208 return $self->error('No trigger name') unless $args{'name'};
209 $trigger = $trigger_class->new( \%args ) or
210 return $self->error( $trigger_class->error );
213 $trigger->order( ++$TRIGGER_ORDER );
214 my $trigger_name = $trigger->name or return $self->error('No trigger name');
216 if ( defined $self->{'triggers'}{ $trigger_name } ) {
217 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
220 $self->{'triggers'}{ $trigger_name } = $trigger;
226 # ----------------------------------------------------------------------
233 Add a view object. Returns the new SQL::Translator::Schema::View object.
234 The "name" parameter is required. If you try to create a view with the
235 same name as an existing view, you will get an error and the view will
238 my $v1 = $schema->add_view( name => 'foo' );
239 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
240 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
245 my $view_class = 'SQL::Translator::Schema::View';
248 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
250 $view->schema( $self );
254 $args{'schema'} = $self;
255 return $self->error('No view name') unless $args{'name'};
256 $view = $view_class->new( \%args ) or return $view_class->error;
259 $view->order( ++$VIEW_ORDER );
260 my $view_name = $view->name or return $self->error('No view name');
262 if ( defined $self->{'views'}{ $view_name } ) {
263 return $self->error(qq[Can't create view: "$view_name" exists]);
266 $self->{'views'}{ $view_name } = $view;
272 # ----------------------------------------------------------------------
279 Get or set the schema's database. (optional)
281 my $database = $schema->database('PostgreSQL');
286 $self->{'database'} = shift if @_;
287 return $self->{'database'} || '';
290 # ----------------------------------------------------------------------
297 Returns true if all the tables and views are valid.
299 my $ok = $schema->is_valid or die $schema->error;
305 return $self->error('No tables') unless $self->get_tables;
307 for my $object ( $self->get_tables, $self->get_views ) {
308 return $object->error unless $object->is_valid;
314 # ----------------------------------------------------------------------
321 Returns a procedure by the name provided.
323 my $procedure = $schema->get_procedure('foo');
328 my $procedure_name = shift or return $self->error('No procedure name');
329 return $self->error( qq[Table "$procedure_name" does not exist] ) unless
330 exists $self->{'procedures'}{ $procedure_name };
331 return $self->{'procedures'}{ $procedure_name };
334 # ----------------------------------------------------------------------
339 =head2 get_procedures
341 Returns all the procedures as an array or array reference.
343 my @procedures = $schema->get_procedures;
350 sort { $a->[0] <=> $b->[0] }
351 map { [ $_->order, $_ ] }
352 values %{ $self->{'procedures'} };
355 return wantarray ? @procedures : \@procedures;
358 $self->error('No procedures');
359 return wantarray ? () : undef;
363 # ----------------------------------------------------------------------
370 Returns a table by the name provided.
372 my $table = $schema->get_table('foo');
377 my $table_name = shift or return $self->error('No table name');
378 return $self->error( qq[Table "$table_name" does not exist] ) unless
379 exists $self->{'tables'}{ $table_name };
380 return $self->{'tables'}{ $table_name };
383 # ----------------------------------------------------------------------
390 Returns all the tables as an array or array reference.
392 my @tables = $schema->get_tables;
399 sort { $a->[0] <=> $b->[0] }
400 map { [ $_->order, $_ ] }
401 values %{ $self->{'tables'} };
404 return wantarray ? @tables : \@tables;
407 $self->error('No tables');
408 return wantarray ? () : undef;
412 # ----------------------------------------------------------------------
419 Returns a trigger by the name provided.
421 my $trigger = $schema->get_trigger('foo');
426 my $trigger_name = shift or return $self->error('No trigger name');
427 return $self->error( qq[Table "$trigger_name" does not exist] ) unless
428 exists $self->{'triggers'}{ $trigger_name };
429 return $self->{'triggers'}{ $trigger_name };
432 # ----------------------------------------------------------------------
439 Returns all the triggers as an array or array reference.
441 my @triggers = $schema->get_triggers;
448 sort { $a->[0] <=> $b->[0] }
449 map { [ $_->order, $_ ] }
450 values %{ $self->{'triggers'} };
453 return wantarray ? @triggers : \@triggers;
456 $self->error('No triggers');
457 return wantarray ? () : undef;
461 # ----------------------------------------------------------------------
468 Returns a view by the name provided.
470 my $view = $schema->get_view('foo');
475 my $view_name = shift or return $self->error('No view name');
476 return $self->error('View "$view_name" does not exist') unless
477 exists $self->{'views'}{ $view_name };
478 return $self->{'views'}{ $view_name };
481 # ----------------------------------------------------------------------
488 Returns all the views as an array or array reference.
490 my @views = $schema->get_views;
497 sort { $a->[0] <=> $b->[0] }
498 map { [ $_->order, $_ ] }
499 values %{ $self->{'views'} };
502 return wantarray ? @views : \@views;
505 $self->error('No views');
506 return wantarray ? () : undef;
510 # ----------------------------------------------------------------------
511 sub make_natural_joins {
515 =head2 make_natural_joins
517 Creates foriegn key relationships among like-named fields in different
518 tables. Accepts the following arguments:
524 A True or False argument which determins whether or not to perform
525 the joins from primary keys to fields of the same name in other tables
529 A list of fields to skip in the joins
533 $schema->make_natural_joins(
535 skip_fields => 'name,department_id',
542 my $join_pk_only = $args{'join_pk_only'} || 0;
543 my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{
544 parse_list_arg( $args{'skip_fields'} )
547 my ( %common_keys, %pk );
548 for my $table ( $self->get_tables ) {
549 for my $field ( $table->get_fields ) {
550 my $field_name = $field->name or next;
551 next if $skip_fields{ $field_name };
552 $pk{ $field_name } = 1 if $field->is_primary_key;
553 push @{ $common_keys{ $field_name } }, $table->name;
557 for my $field ( keys %common_keys ) {
558 next if $join_pk_only and !defined $pk{ $field };
560 my @table_names = @{ $common_keys{ $field } };
561 next unless scalar @table_names > 1;
563 for my $i ( 0 .. $#table_names ) {
564 my $table1 = $self->get_table( $table_names[ $i ] ) or next;
566 for my $j ( 1 .. $#table_names ) {
567 my $table2 = $self->get_table( $table_names[ $j ] ) or next;
568 next if $table1->name eq $table2->name;
570 $table1->add_constraint(
573 reference_table => $table2->name,
574 reference_fields => $field,
583 # ----------------------------------------------------------------------
590 Get or set the schema's name. (optional)
592 my $schema_name = $schema->name('Foo Database');
597 $self->{'name'} = shift if @_;
598 return $self->{'name'} || '';
603 get the SQL::Translator instance that instatiated me
609 $self->{'translator'} = shift if @_;
610 return $self->{'translator'};
613 # ----------------------------------------------------------------------
616 undef $_ for values %{ $self->{'tables'} };
617 undef $_ for values %{ $self->{'views'} };
622 # ----------------------------------------------------------------------
628 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>