1 package SQL::Translator::Schema;
7 SQL::Translator::Schema - SQL::Translator schema object
11 use SQL::Translator::Schema;
12 my $schema = SQL::Translator::Schema->new(
16 my $table = $schema->add_table( name => 'foo' );
17 my $view = $schema->add_view( name => 'bar', sql => '...' );
22 C<SQL::Translator::Schema> is the object that accepts, validates, and
23 returns the database structure.
31 use SQL::Translator::Schema::Constants;
32 use SQL::Translator::Schema::Procedure;
33 use SQL::Translator::Schema::Table;
34 use SQL::Translator::Schema::Trigger;
35 use SQL::Translator::Schema::View;
37 use SQL::Translator::Utils 'parse_list_arg';
39 use base 'SQL::Translator::Schema::Object';
40 our $VERSION = '1.59';
42 __PACKAGE__->_attributes(qw/name database translator/);
46 my $self = $class->SUPER::new (@_)
49 $self->{_order} = { map { $_ => 0 } qw/
65 Returns the schema as an L<SQL::Translator::Schema::Graph> object.
68 require SQL::Translator::Schema::Graph;
72 return SQL::Translator::Schema::Graph->new(
73 translator => $self->translator );
82 Returns a Graph::Directed object with the table names for nodes.
86 require Graph::Directed;
89 my $g = Graph::Directed->new;
91 for my $table ( $self->get_tables ) {
92 my $tname = $table->name;
93 $g->add_vertex( $tname );
95 for my $field ( $table->get_fields ) {
96 if ( $field->is_foreign_key ) {
97 my $fktable = $field->foreign_key_reference->reference_table;
99 $g->add_edge( $fktable, $tname );
113 Add a table object. Returns the new SQL::Translator::Schema::Table object.
114 The "name" parameter is required. If you try to create a table with the
115 same name as an existing table, you will get an error and the table will
118 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
119 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
120 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
125 my $table_class = 'SQL::Translator::Schema::Table';
128 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
130 $table->schema($self);
133 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
134 $args{'schema'} = $self;
135 $table = $table_class->new( \%args )
136 or return $self->error( $table_class->error );
139 $table->order( ++$self->{_order}{table} );
141 # We know we have a name as the Table->new above errors if none given.
142 my $table_name = $table->name;
144 if ( defined $self->{'tables'}{$table_name} ) {
145 return $self->error(qq[Can't create table: "$table_name" exists]);
148 $self->{'tables'}{$table_name} = $table;
160 Remove a table from the schema. Returns the table object if the table was found
161 and removed, an error otherwise. The single parameter can be either a table
162 name or an C<SQL::Translator::Schema::Table> object. The "cascade" parameter
163 can be set to 1 to also drop all triggers on the table, default is 0.
165 $schema->drop_table('mytable');
166 $schema->drop_table('mytable', cascade => 1);
171 my $table_class = 'SQL::Translator::Schema::Table';
174 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
175 $table_name = shift->name;
181 my $cascade = $args{'cascade'};
183 if ( !exists $self->{'tables'}{$table_name} ) {
184 return $self->error(qq[Can't drop table: $table_name" doesn't exist]);
187 my $table = delete $self->{'tables'}{$table_name};
191 # Drop all triggers on this table
192 $self->drop_trigger()
193 for ( grep { $_->on_table eq $table_name } @{ $self->{'triggers'} } );
204 Add a procedure object. Returns the new SQL::Translator::Schema::Procedure
205 object. The "name" parameter is required. If you try to create a procedure
206 with the same name as an existing procedure, you will get an error and the
207 procedure will not be created.
209 my $p1 = $schema->add_procedure( name => 'foo' );
210 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
211 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
216 my $procedure_class = 'SQL::Translator::Schema::Procedure';
219 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
221 $procedure->schema($self);
224 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
225 $args{'schema'} = $self;
226 return $self->error('No procedure name') unless $args{'name'};
227 $procedure = $procedure_class->new( \%args )
228 or return $self->error( $procedure_class->error );
231 $procedure->order( ++$self->{_order}{proc} );
232 my $procedure_name = $procedure->name
233 or return $self->error('No procedure name');
235 if ( defined $self->{'procedures'}{$procedure_name} ) {
237 qq[Can't create procedure: "$procedure_name" exists] );
240 $self->{'procedures'}{$procedure_name} = $procedure;
250 =head2 drop_procedure
252 Remove a procedure from the schema. Returns the procedure object if the
253 procedure was found and removed, an error otherwise. The single parameter
254 can be either a procedure name or an C<SQL::Translator::Schema::Procedure>
257 $schema->drop_procedure('myprocedure');
262 my $proc_class = 'SQL::Translator::Schema::Procedure';
265 if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
266 $proc_name = shift->name;
272 if ( !exists $self->{'procedures'}{$proc_name} ) {
274 qq[Can't drop procedure: $proc_name" doesn't exist]);
277 my $proc = delete $self->{'procedures'}{$proc_name};
288 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
289 The "name" parameter is required. If you try to create a trigger with the
290 same name as an existing trigger, you will get an error and the trigger will
293 my $t1 = $schema->add_trigger( name => 'foo' );
294 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
295 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
300 my $trigger_class = 'SQL::Translator::Schema::Trigger';
303 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
305 $trigger->schema($self);
308 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
309 $args{'schema'} = $self;
310 return $self->error('No trigger name') unless $args{'name'};
311 $trigger = $trigger_class->new( \%args )
312 or return $self->error( $trigger_class->error );
315 $trigger->order( ++$self->{_order}{trigger} );
317 my $trigger_name = $trigger->name or return $self->error('No trigger name');
318 if ( defined $self->{'triggers'}{$trigger_name} ) {
319 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
322 $self->{'triggers'}{$trigger_name} = $trigger;
334 Remove a trigger from the schema. Returns the trigger object if the trigger was
335 found and removed, an error otherwise. The single parameter can be either a
336 trigger name or an C<SQL::Translator::Schema::Trigger> object.
338 $schema->drop_trigger('mytrigger');
343 my $trigger_class = 'SQL::Translator::Schema::Trigger';
346 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
347 $trigger_name = shift->name;
350 $trigger_name = shift;
353 if ( !exists $self->{'triggers'}{$trigger_name} ) {
355 qq[Can't drop trigger: $trigger_name" doesn't exist]);
358 my $trigger = delete $self->{'triggers'}{$trigger_name};
369 Add a view object. Returns the new SQL::Translator::Schema::View object.
370 The "name" parameter is required. If you try to create a view with the
371 same name as an existing view, you will get an error and the view will
374 my $v1 = $schema->add_view( name => 'foo' );
375 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
376 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
381 my $view_class = 'SQL::Translator::Schema::View';
384 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
386 $view->schema($self);
389 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
390 $args{'schema'} = $self;
391 return $self->error('No view name') unless $args{'name'};
392 $view = $view_class->new( \%args ) or return $view_class->error;
395 $view->order( ++$self->{_order}{view} );
396 my $view_name = $view->name or return $self->error('No view name');
398 if ( defined $self->{'views'}{$view_name} ) {
399 return $self->error(qq[Can't create view: "$view_name" exists]);
402 $self->{'views'}{$view_name} = $view;
414 Remove a view from the schema. Returns the view object if the view was found
415 and removed, an error otherwise. The single parameter can be either a view
416 name or an C<SQL::Translator::Schema::View> object.
418 $schema->drop_view('myview');
423 my $view_class = 'SQL::Translator::Schema::View';
426 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
427 $view_name = shift->name;
433 if ( !exists $self->{'views'}{$view_name} ) {
434 return $self->error(qq[Can't drop view: $view_name" doesn't exist]);
437 my $view = delete $self->{'views'}{$view_name};
448 Get or set the schema's database. (optional)
450 my $database = $schema->database('PostgreSQL');
455 $self->{'database'} = shift if @_;
456 return $self->{'database'} || '';
465 Returns true if all the tables and views are valid.
467 my $ok = $schema->is_valid or die $schema->error;
473 return $self->error('No tables') unless $self->get_tables;
475 for my $object ( $self->get_tables, $self->get_views ) {
476 return $object->error unless $object->is_valid;
488 Returns a procedure by the name provided.
490 my $procedure = $schema->get_procedure('foo');
495 my $procedure_name = shift or return $self->error('No procedure name');
496 return $self->error(qq[Table "$procedure_name" does not exist])
497 unless exists $self->{'procedures'}{$procedure_name};
498 return $self->{'procedures'}{$procedure_name};
505 =head2 get_procedures
507 Returns all the procedures as an array or array reference.
509 my @procedures = $schema->get_procedures;
516 sort { $a->[0] <=> $b->[0] }
517 map { [ $_->order, $_ ] } values %{ $self->{'procedures'} };
520 return wantarray ? @procedures : \@procedures;
523 $self->error('No procedures');
524 return wantarray ? () : undef;
534 Returns a table by the name provided.
536 my $table = $schema->get_table('foo');
541 my $table_name = shift or return $self->error('No table name');
542 my $case_insensitive = shift;
543 if ( $case_insensitive ) {
544 $table_name = uc($table_name);
545 foreach my $table ( keys %{$self->{tables}} ) {
546 return $self->{tables}{$table} if $table_name eq uc($table);
548 return $self->error(qq[Table "$table_name" does not exist]);
550 return $self->error(qq[Table "$table_name" does not exist])
551 unless exists $self->{'tables'}{$table_name};
552 return $self->{'tables'}{$table_name};
561 Returns all the tables as an array or array reference.
563 my @tables = $schema->get_tables;
570 sort { $a->[0] <=> $b->[0] }
571 map { [ $_->order, $_ ] } values %{ $self->{'tables'} };
574 return wantarray ? @tables : \@tables;
577 $self->error('No tables');
578 return wantarray ? () : undef;
588 Returns a trigger by the name provided.
590 my $trigger = $schema->get_trigger('foo');
595 my $trigger_name = shift or return $self->error('No trigger name');
596 return $self->error(qq[Table "$trigger_name" does not exist])
597 unless exists $self->{'triggers'}{$trigger_name};
598 return $self->{'triggers'}{$trigger_name};
607 Returns all the triggers as an array or array reference.
609 my @triggers = $schema->get_triggers;
616 sort { $a->[0] <=> $b->[0] }
617 map { [ $_->order, $_ ] } values %{ $self->{'triggers'} };
620 return wantarray ? @triggers : \@triggers;
623 $self->error('No triggers');
624 return wantarray ? () : undef;
634 Returns a view by the name provided.
636 my $view = $schema->get_view('foo');
641 my $view_name = shift or return $self->error('No view name');
642 return $self->error('View "$view_name" does not exist')
643 unless exists $self->{'views'}{$view_name};
644 return $self->{'views'}{$view_name};
653 Returns all the views as an array or array reference.
655 my @views = $schema->get_views;
662 sort { $a->[0] <=> $b->[0] }
663 map { [ $_->order, $_ ] } values %{ $self->{'views'} };
666 return wantarray ? @views : \@views;
669 $self->error('No views');
670 return wantarray ? () : undef;
674 sub make_natural_joins {
678 =head2 make_natural_joins
680 Creates foriegn key relationships among like-named fields in different
681 tables. Accepts the following arguments:
687 A True or False argument which determins whether or not to perform
688 the joins from primary keys to fields of the same name in other tables
692 A list of fields to skip in the joins
696 $schema->make_natural_joins(
698 skip_fields => 'name,department_id',
705 my $join_pk_only = $args{'join_pk_only'} || 0;
707 map { s/^\s+|\s+$//g; $_, 1 } @{ parse_list_arg( $args{'skip_fields'} ) };
709 my ( %common_keys, %pk );
710 for my $table ( $self->get_tables ) {
711 for my $field ( $table->get_fields ) {
712 my $field_name = $field->name or next;
713 next if $skip_fields{$field_name};
714 $pk{$field_name} = 1 if $field->is_primary_key;
715 push @{ $common_keys{$field_name} }, $table->name;
719 for my $field ( keys %common_keys ) {
720 next if $join_pk_only and !defined $pk{$field};
722 my @table_names = @{ $common_keys{$field} };
723 next unless scalar @table_names > 1;
725 for my $i ( 0 .. $#table_names ) {
726 my $table1 = $self->get_table( $table_names[$i] ) or next;
728 for my $j ( 1 .. $#table_names ) {
729 my $table2 = $self->get_table( $table_names[$j] ) or next;
730 next if $table1->name eq $table2->name;
732 $table1->add_constraint(
735 reference_table => $table2->name,
736 reference_fields => $field,
751 Get or set the schema's name. (optional)
753 my $schema_name = $schema->name('Foo Database');
758 $self->{'name'} = shift if @_;
759 return $self->{'name'} || '';
768 Get the SQL::Translator instance that instantiated the parser.
773 $self->{'translator'} = shift if @_;
774 return $self->{'translator'};
779 undef $_ for values %{ $self->{'tables'} };
780 undef $_ for values %{ $self->{'views'} };
789 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.