1 package SQL::Translator::Schema;
3 # ----------------------------------------------------------------------
4 # $Id: Schema.pm,v 1.21 2004-11-27 16:32:16 schiffbruechige 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.21 $ =~ /(\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 Remove a table from the schema. Returns the table object if the table was found
136 and removed, an error otherwise. The single parameter can be either a table
137 name or an C<SQL::Translator::Schema::Table> object. The "cascade" parameter
138 can be set to 1 to also drop all triggers on the table, default is 0.
140 $schema->drop_table('mytable');
141 $schema->drop_table('mytable', cascade => 1);
146 my $table_class = 'SQL::Translator::Schema::Table';
149 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
150 $table_name = shift->name;
156 my $cascade = $args{'cascade'};
158 if ( ! exists $self->{'tables'}{ $table_name } ) {
159 return $self->error(qq[Can't drop table: $table_name" doesn't exist]);
162 my $table = delete $self->{'tables'}{ $table_name };
165 # Drop all triggers on this table
166 $self->drop_trigger() for (grep { $_->on_table eq $table_name }
167 @{ $self->{'triggers'}}
173 # ----------------------------------------------------------------------
180 Add a procedure object. Returns the new SQL::Translator::Schema::Procedure
181 object. The "name" parameter is required. If you try to create a procedure
182 with the same name as an existing procedure, you will get an error and the
183 procedure will not be created.
185 my $p1 = $schema->add_procedure( name => 'foo' );
186 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
187 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
192 my $procedure_class = 'SQL::Translator::Schema::Procedure';
195 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
197 $procedure->schema( $self );
201 $args{'schema'} = $self;
202 return $self->error('No procedure name') unless $args{'name'};
203 $procedure = $procedure_class->new( \%args ) or
204 return $self->error( $procedure_class->error );
207 $procedure->order( ++$PROC_ORDER );
208 my $procedure_name = $procedure->name or return
209 $self->error('No procedure name');
211 if ( defined $self->{'procedures'}{ $procedure_name } ) {
213 qq[Can't create procedure: "$procedure_name" exists]
217 $self->{'procedures'}{ $procedure_name } = $procedure;
222 # ----------------------------------------------------------------------
227 =head2 drop_procedure
229 Remove a procedure from the schema. Returns the procedure object if the
230 procedure was found and removed, an error otherwise. The single parameter
231 can be either a procedure name or an C<SQL::Translator::Schema::Procedure>
234 $schema->drop_procedure('myprocedure');
239 my $proc_class = 'SQL::Translator::Schema::Procedure';
242 if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
243 $proc_name = shift->name;
249 if ( ! exists $self->{'procedures'}{ $proc_name } ) {
250 return $self->error(qq[Can't drop procedure: $proc_name" doesn't exist]);
253 my $proc = delete $self->{'procedures'}{ $proc_name };
258 # ----------------------------------------------------------------------
265 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
266 The "name" parameter is required. If you try to create a trigger with the
267 same name as an existing trigger, you will get an error and the trigger will
270 my $t1 = $schema->add_trigger( name => 'foo' );
271 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
272 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
277 my $trigger_class = 'SQL::Translator::Schema::Trigger';
280 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
282 $trigger->schema( $self );
286 $args{'schema'} = $self;
287 return $self->error('No trigger name') unless $args{'name'};
288 $trigger = $trigger_class->new( \%args ) or
289 return $self->error( $trigger_class->error );
292 $trigger->order( ++$TRIGGER_ORDER );
293 my $trigger_name = $trigger->name or return $self->error('No trigger name');
295 if ( defined $self->{'triggers'}{ $trigger_name } ) {
296 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
299 $self->{'triggers'}{ $trigger_name } = $trigger;
304 # ----------------------------------------------------------------------
311 Remove a trigger from the schema. Returns the trigger object if the trigger was
312 found and removed, an error otherwise. The single parameter can be either a
313 trigger name or an C<SQL::Translator::Schema::Trigger> object.
315 $schema->drop_trigger('mytrigger');
320 my $trigger_class = 'SQL::Translator::Schema::Trigger';
323 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
324 $trigger_name = shift->name;
327 $trigger_name = shift;
330 if ( ! exists $self->{'triggers'}{ $trigger_name } ) {
331 return $self->error(qq[Can't drop trigger: $trigger_name" doesn't exist]);
334 my $trigger = delete $self->{'triggers'}{ $trigger_name };
339 # ----------------------------------------------------------------------
346 Add a view object. Returns the new SQL::Translator::Schema::View object.
347 The "name" parameter is required. If you try to create a view with the
348 same name as an existing view, you will get an error and the view will
351 my $v1 = $schema->add_view( name => 'foo' );
352 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
353 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
358 my $view_class = 'SQL::Translator::Schema::View';
361 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
363 $view->schema( $self );
367 $args{'schema'} = $self;
368 return $self->error('No view name') unless $args{'name'};
369 $view = $view_class->new( \%args ) or return $view_class->error;
372 $view->order( ++$VIEW_ORDER );
373 my $view_name = $view->name or return $self->error('No view name');
375 if ( defined $self->{'views'}{ $view_name } ) {
376 return $self->error(qq[Can't create view: "$view_name" exists]);
379 $self->{'views'}{ $view_name } = $view;
385 # ----------------------------------------------------------------------
392 Remove a view from the schema. Returns the view object if the view was found
393 and removed, an error otherwise. The single parameter can be either a view
394 name or an C<SQL::Translator::Schema::View> object.
396 $schema->drop_view('myview');
401 my $view_class = 'SQL::Translator::Schema::View';
404 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
405 $view_name = shift->name;
411 if ( ! exists $self->{'views'}{ $view_name } ) {
412 return $self->error(qq[Can't drop view: $view_name" doesn't exist]);
415 my $view = delete $self->{'views'}{ $view_name };
420 # ----------------------------------------------------------------------
427 Get or set the schema's database. (optional)
429 my $database = $schema->database('PostgreSQL');
434 $self->{'database'} = shift if @_;
435 return $self->{'database'} || '';
438 # ----------------------------------------------------------------------
445 Returns true if all the tables and views are valid.
447 my $ok = $schema->is_valid or die $schema->error;
453 return $self->error('No tables') unless $self->get_tables;
455 for my $object ( $self->get_tables, $self->get_views ) {
456 return $object->error unless $object->is_valid;
462 # ----------------------------------------------------------------------
469 Returns a procedure by the name provided.
471 my $procedure = $schema->get_procedure('foo');
476 my $procedure_name = shift or return $self->error('No procedure name');
477 return $self->error( qq[Table "$procedure_name" does not exist] ) unless
478 exists $self->{'procedures'}{ $procedure_name };
479 return $self->{'procedures'}{ $procedure_name };
482 # ----------------------------------------------------------------------
487 =head2 get_procedures
489 Returns all the procedures as an array or array reference.
491 my @procedures = $schema->get_procedures;
498 sort { $a->[0] <=> $b->[0] }
499 map { [ $_->order, $_ ] }
500 values %{ $self->{'procedures'} };
503 return wantarray ? @procedures : \@procedures;
506 $self->error('No procedures');
507 return wantarray ? () : undef;
511 # ----------------------------------------------------------------------
518 Returns a table by the name provided.
520 my $table = $schema->get_table('foo');
525 my $table_name = shift or return $self->error('No table name');
526 return $self->error( qq[Table "$table_name" does not exist] ) unless
527 exists $self->{'tables'}{ $table_name };
528 return $self->{'tables'}{ $table_name };
531 # ----------------------------------------------------------------------
538 Returns all the tables as an array or array reference.
540 my @tables = $schema->get_tables;
547 sort { $a->[0] <=> $b->[0] }
548 map { [ $_->order, $_ ] }
549 values %{ $self->{'tables'} };
552 return wantarray ? @tables : \@tables;
555 $self->error('No tables');
556 return wantarray ? () : undef;
560 # ----------------------------------------------------------------------
567 Returns a trigger by the name provided.
569 my $trigger = $schema->get_trigger('foo');
574 my $trigger_name = shift or return $self->error('No trigger name');
575 return $self->error( qq[Table "$trigger_name" does not exist] ) unless
576 exists $self->{'triggers'}{ $trigger_name };
577 return $self->{'triggers'}{ $trigger_name };
580 # ----------------------------------------------------------------------
587 Returns all the triggers as an array or array reference.
589 my @triggers = $schema->get_triggers;
596 sort { $a->[0] <=> $b->[0] }
597 map { [ $_->order, $_ ] }
598 values %{ $self->{'triggers'} };
601 return wantarray ? @triggers : \@triggers;
604 $self->error('No triggers');
605 return wantarray ? () : undef;
609 # ----------------------------------------------------------------------
616 Returns a view by the name provided.
618 my $view = $schema->get_view('foo');
623 my $view_name = shift or return $self->error('No view name');
624 return $self->error('View "$view_name" does not exist') unless
625 exists $self->{'views'}{ $view_name };
626 return $self->{'views'}{ $view_name };
629 # ----------------------------------------------------------------------
636 Returns all the views as an array or array reference.
638 my @views = $schema->get_views;
645 sort { $a->[0] <=> $b->[0] }
646 map { [ $_->order, $_ ] }
647 values %{ $self->{'views'} };
650 return wantarray ? @views : \@views;
653 $self->error('No views');
654 return wantarray ? () : undef;
658 # ----------------------------------------------------------------------
659 sub make_natural_joins {
663 =head2 make_natural_joins
665 Creates foriegn key relationships among like-named fields in different
666 tables. Accepts the following arguments:
672 A True or False argument which determins whether or not to perform
673 the joins from primary keys to fields of the same name in other tables
677 A list of fields to skip in the joins
681 $schema->make_natural_joins(
683 skip_fields => 'name,department_id',
690 my $join_pk_only = $args{'join_pk_only'} || 0;
691 my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{
692 parse_list_arg( $args{'skip_fields'} )
695 my ( %common_keys, %pk );
696 for my $table ( $self->get_tables ) {
697 for my $field ( $table->get_fields ) {
698 my $field_name = $field->name or next;
699 next if $skip_fields{ $field_name };
700 $pk{ $field_name } = 1 if $field->is_primary_key;
701 push @{ $common_keys{ $field_name } }, $table->name;
705 for my $field ( keys %common_keys ) {
706 next if $join_pk_only and !defined $pk{ $field };
708 my @table_names = @{ $common_keys{ $field } };
709 next unless scalar @table_names > 1;
711 for my $i ( 0 .. $#table_names ) {
712 my $table1 = $self->get_table( $table_names[ $i ] ) or next;
714 for my $j ( 1 .. $#table_names ) {
715 my $table2 = $self->get_table( $table_names[ $j ] ) or next;
716 next if $table1->name eq $table2->name;
718 $table1->add_constraint(
721 reference_table => $table2->name,
722 reference_fields => $field,
731 # ----------------------------------------------------------------------
738 Get or set the schema's name. (optional)
740 my $schema_name = $schema->name('Foo Database');
745 $self->{'name'} = shift if @_;
746 return $self->{'name'} || '';
751 get the SQL::Translator instance that instatiated me
757 $self->{'translator'} = shift if @_;
758 return $self->{'translator'};
761 # ----------------------------------------------------------------------
764 undef $_ for values %{ $self->{'tables'} };
765 undef $_ for values %{ $self->{'views'} };
770 # ----------------------------------------------------------------------
776 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>