1 package SQL::Translator::Schema;
5 # ----------------------------------------------------------------------
6 # $Id: Schema.pm,v 1.22 2005-06-07 16:55:41 kycl4rk Exp $
7 # ----------------------------------------------------------------------
8 # Copyright (C) 2002-4 SQLFairy Authors
10 # This program is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU General Public License as
12 # published by the Free Software Foundation; version 2.
14 # This program is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program; if not, write to the Free Software
21 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
23 # -------------------------------------------------------------------
29 SQL::Translator::Schema - SQL::Translator schema object
33 use SQL::Translator::Schema;
34 my $schema = SQL::Translator::Schema->new(
38 my $table = $schema->add_table( name => 'foo' );
39 my $view = $schema->add_view( name => 'bar', sql => '...' );
44 C<SQL::Translator::Schema> is the object that accepts, validates, and
45 returns the database structure.
52 use SQL::Translator::Schema::Constants;
53 use SQL::Translator::Schema::Procedure;
54 use SQL::Translator::Schema::Table;
55 use SQL::Translator::Schema::Trigger;
56 use SQL::Translator::Schema::View;
57 use SQL::Translator::Schema::Graph;
58 use SQL::Translator::Utils 'parse_list_arg';
60 use base 'SQL::Translator::Schema::Object';
61 use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER $PROC_ORDER ];
63 $VERSION = sprintf "%d.%02d", q$Revision: 1.22 $ =~ /(\d+)\.(\d+)/;
65 __PACKAGE__->_attributes( qw/name database translator/ );
67 # ----------------------------------------------------------------------
74 Returns the schema as an L<SQL::Translator::Schema::Graph> object.
79 return SQL::Translator::Schema::Graph->new(
80 translator => $self->translator
84 # ----------------------------------------------------------------------
91 Add a table object. Returns the new SQL::Translator::Schema::Table object.
92 The "name" parameter is required. If you try to create a table with the
93 same name as an existing table, you will get an error and the table will
96 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
97 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
98 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
103 my $table_class = 'SQL::Translator::Schema::Table';
106 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
108 $table->schema( $self );
112 $args{'schema'} = $self;
113 $table = $table_class->new( \%args ) or return
114 $self->error( $table_class->error );
117 $table->order( ++$TABLE_ORDER );
118 # We know we have a name as the Table->new above errors if none given.
119 my $table_name = $table->name;
121 if ( defined $self->{'tables'}{ $table_name } ) {
122 return $self->error(qq[Can't create table: "$table_name" exists]);
125 $self->{'tables'}{ $table_name } = $table;
131 # ----------------------------------------------------------------------
138 Remove a table from the schema. Returns the table object if the table was found
139 and removed, an error otherwise. The single parameter can be either a table
140 name or an C<SQL::Translator::Schema::Table> object. The "cascade" parameter
141 can be set to 1 to also drop all triggers on the table, default is 0.
143 $schema->drop_table('mytable');
144 $schema->drop_table('mytable', cascade => 1);
149 my $table_class = 'SQL::Translator::Schema::Table';
152 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
153 $table_name = shift->name;
159 my $cascade = $args{'cascade'};
161 if ( ! exists $self->{'tables'}{ $table_name } ) {
162 return $self->error(qq[Can't drop table: $table_name" doesn't exist]);
165 my $table = delete $self->{'tables'}{ $table_name };
168 # Drop all triggers on this table
169 $self->drop_trigger() for (grep { $_->on_table eq $table_name }
170 @{ $self->{'triggers'}}
176 # ----------------------------------------------------------------------
183 Add a procedure object. Returns the new SQL::Translator::Schema::Procedure
184 object. The "name" parameter is required. If you try to create a procedure
185 with the same name as an existing procedure, you will get an error and the
186 procedure will not be created.
188 my $p1 = $schema->add_procedure( name => 'foo' );
189 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
190 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
195 my $procedure_class = 'SQL::Translator::Schema::Procedure';
198 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
200 $procedure->schema( $self );
204 $args{'schema'} = $self;
205 return $self->error('No procedure name') unless $args{'name'};
206 $procedure = $procedure_class->new( \%args ) or
207 return $self->error( $procedure_class->error );
210 $procedure->order( ++$PROC_ORDER );
211 my $procedure_name = $procedure->name or return
212 $self->error('No procedure name');
214 if ( defined $self->{'procedures'}{ $procedure_name } ) {
216 qq[Can't create procedure: "$procedure_name" exists]
220 $self->{'procedures'}{ $procedure_name } = $procedure;
225 # ----------------------------------------------------------------------
230 =head2 drop_procedure
232 Remove a procedure from the schema. Returns the procedure object if the
233 procedure was found and removed, an error otherwise. The single parameter
234 can be either a procedure name or an C<SQL::Translator::Schema::Procedure>
237 $schema->drop_procedure('myprocedure');
242 my $proc_class = 'SQL::Translator::Schema::Procedure';
245 if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
246 $proc_name = shift->name;
252 if ( ! exists $self->{'procedures'}{ $proc_name } ) {
253 return $self->error(qq[Can't drop procedure: $proc_name" doesn't exist]);
256 my $proc = delete $self->{'procedures'}{ $proc_name };
261 # ----------------------------------------------------------------------
268 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
269 The "name" parameter is required. If you try to create a trigger with the
270 same name as an existing trigger, you will get an error and the trigger will
273 my $t1 = $schema->add_trigger( name => 'foo' );
274 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
275 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
280 my $trigger_class = 'SQL::Translator::Schema::Trigger';
283 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
285 $trigger->schema( $self );
289 $args{'schema'} = $self;
290 return $self->error('No trigger name') unless $args{'name'};
291 $trigger = $trigger_class->new( \%args ) or
292 return $self->error( $trigger_class->error );
295 $trigger->order( ++$TRIGGER_ORDER );
296 my $trigger_name = $trigger->name or return $self->error('No trigger name');
298 if ( defined $self->{'triggers'}{ $trigger_name } ) {
299 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
302 $self->{'triggers'}{ $trigger_name } = $trigger;
307 # ----------------------------------------------------------------------
314 Remove a trigger from the schema. Returns the trigger object if the trigger was
315 found and removed, an error otherwise. The single parameter can be either a
316 trigger name or an C<SQL::Translator::Schema::Trigger> object.
318 $schema->drop_trigger('mytrigger');
323 my $trigger_class = 'SQL::Translator::Schema::Trigger';
326 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
327 $trigger_name = shift->name;
330 $trigger_name = shift;
333 if ( ! exists $self->{'triggers'}{ $trigger_name } ) {
334 return $self->error(qq[Can't drop trigger: $trigger_name" doesn't exist]);
337 my $trigger = delete $self->{'triggers'}{ $trigger_name };
342 # ----------------------------------------------------------------------
349 Add a view object. Returns the new SQL::Translator::Schema::View object.
350 The "name" parameter is required. If you try to create a view with the
351 same name as an existing view, you will get an error and the view will
354 my $v1 = $schema->add_view( name => 'foo' );
355 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
356 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
361 my $view_class = 'SQL::Translator::Schema::View';
364 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
366 $view->schema( $self );
370 $args{'schema'} = $self;
371 return $self->error('No view name') unless $args{'name'};
372 $view = $view_class->new( \%args ) or return $view_class->error;
375 $view->order( ++$VIEW_ORDER );
376 my $view_name = $view->name or return $self->error('No view name');
378 if ( defined $self->{'views'}{ $view_name } ) {
379 return $self->error(qq[Can't create view: "$view_name" exists]);
382 $self->{'views'}{ $view_name } = $view;
388 # ----------------------------------------------------------------------
395 Remove a view from the schema. Returns the view object if the view was found
396 and removed, an error otherwise. The single parameter can be either a view
397 name or an C<SQL::Translator::Schema::View> object.
399 $schema->drop_view('myview');
404 my $view_class = 'SQL::Translator::Schema::View';
407 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
408 $view_name = shift->name;
414 if ( ! exists $self->{'views'}{ $view_name } ) {
415 return $self->error(qq[Can't drop view: $view_name" doesn't exist]);
418 my $view = delete $self->{'views'}{ $view_name };
423 # ----------------------------------------------------------------------
430 Get or set the schema's database. (optional)
432 my $database = $schema->database('PostgreSQL');
437 $self->{'database'} = shift if @_;
438 return $self->{'database'} || '';
441 # ----------------------------------------------------------------------
448 Returns true if all the tables and views are valid.
450 my $ok = $schema->is_valid or die $schema->error;
456 return $self->error('No tables') unless $self->get_tables;
458 for my $object ( $self->get_tables, $self->get_views ) {
459 return $object->error unless $object->is_valid;
465 # ----------------------------------------------------------------------
472 Returns a procedure by the name provided.
474 my $procedure = $schema->get_procedure('foo');
479 my $procedure_name = shift or return $self->error('No procedure name');
480 return $self->error( qq[Table "$procedure_name" does not exist] ) unless
481 exists $self->{'procedures'}{ $procedure_name };
482 return $self->{'procedures'}{ $procedure_name };
485 # ----------------------------------------------------------------------
490 =head2 get_procedures
492 Returns all the procedures as an array or array reference.
494 my @procedures = $schema->get_procedures;
501 sort { $a->[0] <=> $b->[0] }
502 map { [ $_->order, $_ ] }
503 values %{ $self->{'procedures'} };
506 return wantarray ? @procedures : \@procedures;
509 $self->error('No procedures');
510 return wantarray ? () : undef;
514 # ----------------------------------------------------------------------
521 Returns a table by the name provided.
523 my $table = $schema->get_table('foo');
528 my $table_name = shift or return $self->error('No table name');
529 return $self->error( qq[Table "$table_name" does not exist] ) unless
530 exists $self->{'tables'}{ $table_name };
531 return $self->{'tables'}{ $table_name };
534 # ----------------------------------------------------------------------
541 Returns all the tables as an array or array reference.
543 my @tables = $schema->get_tables;
550 sort { $a->[0] <=> $b->[0] }
551 map { [ $_->order, $_ ] }
552 values %{ $self->{'tables'} };
555 return wantarray ? @tables : \@tables;
558 $self->error('No tables');
559 return wantarray ? () : undef;
563 # ----------------------------------------------------------------------
570 Returns a trigger by the name provided.
572 my $trigger = $schema->get_trigger('foo');
577 my $trigger_name = shift or return $self->error('No trigger name');
578 return $self->error( qq[Table "$trigger_name" does not exist] ) unless
579 exists $self->{'triggers'}{ $trigger_name };
580 return $self->{'triggers'}{ $trigger_name };
583 # ----------------------------------------------------------------------
590 Returns all the triggers as an array or array reference.
592 my @triggers = $schema->get_triggers;
599 sort { $a->[0] <=> $b->[0] }
600 map { [ $_->order, $_ ] }
601 values %{ $self->{'triggers'} };
604 return wantarray ? @triggers : \@triggers;
607 $self->error('No triggers');
608 return wantarray ? () : undef;
612 # ----------------------------------------------------------------------
619 Returns a view by the name provided.
621 my $view = $schema->get_view('foo');
626 my $view_name = shift or return $self->error('No view name');
627 return $self->error('View "$view_name" does not exist') unless
628 exists $self->{'views'}{ $view_name };
629 return $self->{'views'}{ $view_name };
632 # ----------------------------------------------------------------------
639 Returns all the views as an array or array reference.
641 my @views = $schema->get_views;
648 sort { $a->[0] <=> $b->[0] }
649 map { [ $_->order, $_ ] }
650 values %{ $self->{'views'} };
653 return wantarray ? @views : \@views;
656 $self->error('No views');
657 return wantarray ? () : undef;
661 # ----------------------------------------------------------------------
662 sub make_natural_joins {
666 =head2 make_natural_joins
668 Creates foriegn key relationships among like-named fields in different
669 tables. Accepts the following arguments:
675 A True or False argument which determins whether or not to perform
676 the joins from primary keys to fields of the same name in other tables
680 A list of fields to skip in the joins
684 $schema->make_natural_joins(
686 skip_fields => 'name,department_id',
693 my $join_pk_only = $args{'join_pk_only'} || 0;
694 my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{
695 parse_list_arg( $args{'skip_fields'} )
698 my ( %common_keys, %pk );
699 for my $table ( $self->get_tables ) {
700 for my $field ( $table->get_fields ) {
701 my $field_name = $field->name or next;
702 next if $skip_fields{ $field_name };
703 $pk{ $field_name } = 1 if $field->is_primary_key;
704 push @{ $common_keys{ $field_name } }, $table->name;
708 for my $field ( keys %common_keys ) {
709 next if $join_pk_only and !defined $pk{ $field };
711 my @table_names = @{ $common_keys{ $field } };
712 next unless scalar @table_names > 1;
714 for my $i ( 0 .. $#table_names ) {
715 my $table1 = $self->get_table( $table_names[ $i ] ) or next;
717 for my $j ( 1 .. $#table_names ) {
718 my $table2 = $self->get_table( $table_names[ $j ] ) or next;
719 next if $table1->name eq $table2->name;
721 $table1->add_constraint(
724 reference_table => $table2->name,
725 reference_fields => $field,
734 # ----------------------------------------------------------------------
741 Get or set the schema's name. (optional)
743 my $schema_name = $schema->name('Foo Database');
748 $self->{'name'} = shift if @_;
749 return $self->{'name'} || '';
752 # ----------------------------------------------------------------------
759 Get the SQL::Translator instance that instantiated the parser.
764 $self->{'translator'} = shift if @_;
765 return $self->{'translator'};
768 # ----------------------------------------------------------------------
771 undef $_ for values %{ $self->{'tables'} };
772 undef $_ for values %{ $self->{'views'} };
777 # ----------------------------------------------------------------------
783 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.