1 package SQL::Translator::Schema;
5 # ----------------------------------------------------------------------
6 # $Id: Schema.pm,v 1.27 2007-10-24 10:58:35 schiffbruechige 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.27 $ =~ /(\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 );
83 # ----------------------------------------------------------------------
90 Returns a Graph::Directed object with the table names for nodes.
94 require Graph::Directed;
97 my $g = Graph::Directed->new;
99 for my $table ( $self->get_tables ) {
100 my $tname = $table->name;
101 $g->add_vertex( $tname );
103 for my $field ( $table->get_fields ) {
104 if ( $field->is_foreign_key ) {
105 my $fktable = $field->foreign_key_reference->reference_table;
107 $g->add_edge( $fktable, $tname );
115 # ----------------------------------------------------------------------
122 Add a table object. Returns the new SQL::Translator::Schema::Table object.
123 The "name" parameter is required. If you try to create a table with the
124 same name as an existing table, you will get an error and the table will
127 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
128 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
129 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
134 my $table_class = 'SQL::Translator::Schema::Table';
137 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
139 $table->schema($self);
143 $args{'schema'} = $self;
144 $table = $table_class->new( \%args )
145 or return $self->error( $table_class->error );
148 $table->order( ++$TABLE_ORDER );
150 # We know we have a name as the Table->new above errors if none given.
151 my $table_name = $table->name;
153 if ( defined $self->{'tables'}{$table_name} ) {
154 return $self->error(qq[Can't create table: "$table_name" exists]);
157 $self->{'tables'}{$table_name} = $table;
163 # ----------------------------------------------------------------------
170 Remove a table from the schema. Returns the table object if the table was found
171 and removed, an error otherwise. The single parameter can be either a table
172 name or an C<SQL::Translator::Schema::Table> object. The "cascade" parameter
173 can be set to 1 to also drop all triggers on the table, default is 0.
175 $schema->drop_table('mytable');
176 $schema->drop_table('mytable', cascade => 1);
181 my $table_class = 'SQL::Translator::Schema::Table';
184 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
185 $table_name = shift->name;
191 my $cascade = $args{'cascade'};
193 if ( !exists $self->{'tables'}{$table_name} ) {
194 return $self->error(qq[Can't drop table: $table_name" doesn't exist]);
197 my $table = delete $self->{'tables'}{$table_name};
201 # Drop all triggers on this table
202 $self->drop_trigger()
203 for ( grep { $_->on_table eq $table_name } @{ $self->{'triggers'} } );
208 # ----------------------------------------------------------------------
215 Add a procedure object. Returns the new SQL::Translator::Schema::Procedure
216 object. The "name" parameter is required. If you try to create a procedure
217 with the same name as an existing procedure, you will get an error and the
218 procedure will not be created.
220 my $p1 = $schema->add_procedure( name => 'foo' );
221 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
222 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
227 my $procedure_class = 'SQL::Translator::Schema::Procedure';
230 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
232 $procedure->schema($self);
236 $args{'schema'} = $self;
237 return $self->error('No procedure name') unless $args{'name'};
238 $procedure = $procedure_class->new( \%args )
239 or return $self->error( $procedure_class->error );
242 $procedure->order( ++$PROC_ORDER );
243 my $procedure_name = $procedure->name
244 or return $self->error('No procedure name');
246 if ( defined $self->{'procedures'}{$procedure_name} ) {
248 qq[Can't create procedure: "$procedure_name" exists] );
251 $self->{'procedures'}{$procedure_name} = $procedure;
257 # ----------------------------------------------------------------------
262 =head2 drop_procedure
264 Remove a procedure from the schema. Returns the procedure object if the
265 procedure was found and removed, an error otherwise. The single parameter
266 can be either a procedure name or an C<SQL::Translator::Schema::Procedure>
269 $schema->drop_procedure('myprocedure');
274 my $proc_class = 'SQL::Translator::Schema::Procedure';
277 if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
278 $proc_name = shift->name;
284 if ( !exists $self->{'procedures'}{$proc_name} ) {
286 qq[Can't drop procedure: $proc_name" doesn't exist]);
289 my $proc = delete $self->{'procedures'}{$proc_name};
294 # ----------------------------------------------------------------------
301 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
302 The "name" parameter is required. If you try to create a trigger with the
303 same name as an existing trigger, you will get an error and the trigger will
306 my $t1 = $schema->add_trigger( name => 'foo' );
307 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
308 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
313 my $trigger_class = 'SQL::Translator::Schema::Trigger';
316 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
318 $trigger->schema($self);
322 $args{'schema'} = $self;
323 return $self->error('No trigger name') unless $args{'name'};
324 $trigger = $trigger_class->new( \%args )
325 or return $self->error( $trigger_class->error );
328 $trigger->order( ++$TRIGGER_ORDER );
330 my $trigger_name = $trigger->name or return $self->error('No trigger name');
331 if ( defined $self->{'triggers'}{$trigger_name} ) {
332 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
335 $self->{'triggers'}{$trigger_name} = $trigger;
341 # ----------------------------------------------------------------------
348 Remove a trigger from the schema. Returns the trigger object if the trigger was
349 found and removed, an error otherwise. The single parameter can be either a
350 trigger name or an C<SQL::Translator::Schema::Trigger> object.
352 $schema->drop_trigger('mytrigger');
357 my $trigger_class = 'SQL::Translator::Schema::Trigger';
360 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
361 $trigger_name = shift->name;
364 $trigger_name = shift;
367 if ( !exists $self->{'triggers'}{$trigger_name} ) {
369 qq[Can't drop trigger: $trigger_name" doesn't exist]);
372 my $trigger = delete $self->{'triggers'}{$trigger_name};
377 # ----------------------------------------------------------------------
384 Add a view object. Returns the new SQL::Translator::Schema::View object.
385 The "name" parameter is required. If you try to create a view with the
386 same name as an existing view, you will get an error and the view will
389 my $v1 = $schema->add_view( name => 'foo' );
390 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
391 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
396 my $view_class = 'SQL::Translator::Schema::View';
399 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
401 $view->schema($self);
405 $args{'schema'} = $self;
406 return $self->error('No view name') unless $args{'name'};
407 $view = $view_class->new( \%args ) or return $view_class->error;
410 $view->order( ++$VIEW_ORDER );
411 my $view_name = $view->name or return $self->error('No view name');
413 if ( defined $self->{'views'}{$view_name} ) {
414 return $self->error(qq[Can't create view: "$view_name" exists]);
417 $self->{'views'}{$view_name} = $view;
423 # ----------------------------------------------------------------------
430 Remove a view from the schema. Returns the view object if the view was found
431 and removed, an error otherwise. The single parameter can be either a view
432 name or an C<SQL::Translator::Schema::View> object.
434 $schema->drop_view('myview');
439 my $view_class = 'SQL::Translator::Schema::View';
442 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
443 $view_name = shift->name;
449 if ( !exists $self->{'views'}{$view_name} ) {
450 return $self->error(qq[Can't drop view: $view_name" doesn't exist]);
453 my $view = delete $self->{'views'}{$view_name};
458 # ----------------------------------------------------------------------
465 Get or set the schema's database. (optional)
467 my $database = $schema->database('PostgreSQL');
472 $self->{'database'} = shift if @_;
473 return $self->{'database'} || '';
476 # ----------------------------------------------------------------------
483 Returns true if all the tables and views are valid.
485 my $ok = $schema->is_valid or die $schema->error;
491 return $self->error('No tables') unless $self->get_tables;
493 for my $object ( $self->get_tables, $self->get_views ) {
494 return $object->error unless $object->is_valid;
500 # ----------------------------------------------------------------------
507 Returns a procedure by the name provided.
509 my $procedure = $schema->get_procedure('foo');
514 my $procedure_name = shift or return $self->error('No procedure name');
515 return $self->error(qq[Table "$procedure_name" does not exist])
516 unless exists $self->{'procedures'}{$procedure_name};
517 return $self->{'procedures'}{$procedure_name};
520 # ----------------------------------------------------------------------
525 =head2 get_procedures
527 Returns all the procedures as an array or array reference.
529 my @procedures = $schema->get_procedures;
536 sort { $a->[0] <=> $b->[0] }
537 map { [ $_->order, $_ ] } values %{ $self->{'procedures'} };
540 return wantarray ? @procedures : \@procedures;
543 $self->error('No procedures');
544 return wantarray ? () : undef;
548 # ----------------------------------------------------------------------
555 Returns a table by the name provided.
557 my $table = $schema->get_table('foo');
562 my $table_name = shift or return $self->error('No table name');
563 my $case_insensitive = shift;
564 if ( $case_insensitive ) {
565 $table_name = uc($table_name);
566 foreach my $table ( keys %{$self->{tables}} ) {
567 return $self->{tables}{$table} if $table_name eq uc($table);
569 return $self->error(qq[Table "$table_name" does not exist]);
571 return $self->error(qq[Table "$table_name" does not exist])
572 unless exists $self->{'tables'}{$table_name};
573 return $self->{'tables'}{$table_name};
576 # ----------------------------------------------------------------------
583 Returns all the tables as an array or array reference.
585 my @tables = $schema->get_tables;
592 sort { $a->[0] <=> $b->[0] }
593 map { [ $_->order, $_ ] } values %{ $self->{'tables'} };
596 return wantarray ? @tables : \@tables;
599 $self->error('No tables');
600 return wantarray ? () : undef;
604 # ----------------------------------------------------------------------
611 Returns a trigger by the name provided.
613 my $trigger = $schema->get_trigger('foo');
618 my $trigger_name = shift or return $self->error('No trigger name');
619 return $self->error(qq[Table "$trigger_name" does not exist])
620 unless exists $self->{'triggers'}{$trigger_name};
621 return $self->{'triggers'}{$trigger_name};
624 # ----------------------------------------------------------------------
631 Returns all the triggers as an array or array reference.
633 my @triggers = $schema->get_triggers;
640 sort { $a->[0] <=> $b->[0] }
641 map { [ $_->order, $_ ] } values %{ $self->{'triggers'} };
644 return wantarray ? @triggers : \@triggers;
647 $self->error('No triggers');
648 return wantarray ? () : undef;
652 # ----------------------------------------------------------------------
659 Returns a view by the name provided.
661 my $view = $schema->get_view('foo');
666 my $view_name = shift or return $self->error('No view name');
667 return $self->error('View "$view_name" does not exist')
668 unless exists $self->{'views'}{$view_name};
669 return $self->{'views'}{$view_name};
672 # ----------------------------------------------------------------------
679 Returns all the views as an array or array reference.
681 my @views = $schema->get_views;
688 sort { $a->[0] <=> $b->[0] }
689 map { [ $_->order, $_ ] } values %{ $self->{'views'} };
692 return wantarray ? @views : \@views;
695 $self->error('No views');
696 return wantarray ? () : undef;
700 # ----------------------------------------------------------------------
701 sub make_natural_joins {
705 =head2 make_natural_joins
707 Creates foriegn key relationships among like-named fields in different
708 tables. Accepts the following arguments:
714 A True or False argument which determins whether or not to perform
715 the joins from primary keys to fields of the same name in other tables
719 A list of fields to skip in the joins
723 $schema->make_natural_joins(
725 skip_fields => 'name,department_id',
732 my $join_pk_only = $args{'join_pk_only'} || 0;
734 map { s/^\s+|\s+$//g; $_, 1 } @{ parse_list_arg( $args{'skip_fields'} ) };
736 my ( %common_keys, %pk );
737 for my $table ( $self->get_tables ) {
738 for my $field ( $table->get_fields ) {
739 my $field_name = $field->name or next;
740 next if $skip_fields{$field_name};
741 $pk{$field_name} = 1 if $field->is_primary_key;
742 push @{ $common_keys{$field_name} }, $table->name;
746 for my $field ( keys %common_keys ) {
747 next if $join_pk_only and !defined $pk{$field};
749 my @table_names = @{ $common_keys{$field} };
750 next unless scalar @table_names > 1;
752 for my $i ( 0 .. $#table_names ) {
753 my $table1 = $self->get_table( $table_names[$i] ) or next;
755 for my $j ( 1 .. $#table_names ) {
756 my $table2 = $self->get_table( $table_names[$j] ) or next;
757 next if $table1->name eq $table2->name;
759 $table1->add_constraint(
762 reference_table => $table2->name,
763 reference_fields => $field,
772 # ----------------------------------------------------------------------
779 Get or set the schema's name. (optional)
781 my $schema_name = $schema->name('Foo Database');
786 $self->{'name'} = shift if @_;
787 return $self->{'name'} || '';
790 # ----------------------------------------------------------------------
797 Get the SQL::Translator instance that instantiated the parser.
802 $self->{'translator'} = shift if @_;
803 return $self->{'translator'};
806 # ----------------------------------------------------------------------
809 undef $_ for values %{ $self->{'tables'} };
810 undef $_ for values %{ $self->{'views'} };
815 # ----------------------------------------------------------------------
821 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.