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.
30 use SQL::Translator::Schema::Constants;
31 use SQL::Translator::Schema::Procedure;
32 use SQL::Translator::Schema::Table;
33 use SQL::Translator::Schema::Trigger;
34 use SQL::Translator::Schema::View;
35 use Sub::Quote qw(quote_sub);
37 use SQL::Translator::Utils 'parse_list_arg';
40 extends 'SQL::Translator::Schema::Object';
42 our $VERSION = '1.59';
45 has _order => (is => 'ro', default => quote_sub(q{ +{ map { $_ => 0 } qw/
59 Returns a Graph::Directed object with the table names for nodes.
63 require Graph::Directed;
66 my $g = Graph::Directed->new;
68 for my $table ( $self->get_tables ) {
69 my $tname = $table->name;
70 $g->add_vertex( $tname );
72 for my $field ( $table->get_fields ) {
73 if ( $field->is_foreign_key ) {
74 my $fktable = $field->foreign_key_reference->reference_table;
76 $g->add_edge( $fktable, $tname );
84 has _tables => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
92 Add a table object. Returns the new L<SQL::Translator::Schema::Table> object.
93 The "name" parameter is required. If you try to create a table with the
94 same name as an existing table, you will get an error and the table will
97 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
98 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
99 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
104 my $table_class = 'SQL::Translator::Schema::Table';
107 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
109 $table->schema($self);
112 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
113 $args{'schema'} = $self;
114 $table = $table_class->new( \%args )
115 or return $self->error( $table_class->error );
118 $table->order( ++$self->_order->{table} );
120 # We know we have a name as the Table->new above errors if none given.
121 my $table_name = $table->name;
123 if ( defined $self->_tables->{$table_name} ) {
124 return $self->error(qq[Can't use table name "$table_name": table exists]);
127 $self->_tables->{$table_name} = $table;
139 Remove a table from the schema. Returns the table object if the table was found
140 and removed, an error otherwise. The single parameter can be either a table
141 name or an L<SQL::Translator::Schema::Table> object. The "cascade" parameter
142 can be set to 1 to also drop all triggers on the table, default is 0.
144 $schema->drop_table('mytable');
145 $schema->drop_table('mytable', cascade => 1);
150 my $table_class = 'SQL::Translator::Schema::Table';
153 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
154 $table_name = shift->name;
160 my $cascade = $args{'cascade'};
162 if ( !exists $self->_tables->{$table_name} ) {
163 return $self->error(qq[Can't drop table: "$table_name" doesn't exist]);
166 my $table = delete $self->_tables->{$table_name};
170 # Drop all triggers on this table
171 $self->drop_trigger()
172 for ( grep { $_->on_table eq $table_name } values %{ $self->_triggers } );
177 has _procedures => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
185 Add a procedure object. Returns the new L<SQL::Translator::Schema::Procedure>
186 object. The "name" parameter is required. If you try to create a procedure
187 with the same name as an existing procedure, you will get an error and the
188 procedure will not be created.
190 my $p1 = $schema->add_procedure( name => 'foo' );
191 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
192 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
197 my $procedure_class = 'SQL::Translator::Schema::Procedure';
200 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
202 $procedure->schema($self);
205 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
206 $args{'schema'} = $self;
207 return $self->error('No procedure name') unless $args{'name'};
208 $procedure = $procedure_class->new( \%args )
209 or return $self->error( $procedure_class->error );
212 $procedure->order( ++$self->_order->{proc} );
213 my $procedure_name = $procedure->name
214 or return $self->error('No procedure name');
216 if ( defined $self->_procedures->{$procedure_name} ) {
218 qq[Can't create procedure: "$procedure_name" exists] );
221 $self->_procedures->{$procedure_name} = $procedure;
231 =head2 drop_procedure
233 Remove a procedure from the schema. Returns the procedure object if the
234 procedure was found and removed, an error otherwise. The single parameter
235 can be either a procedure name or an L<SQL::Translator::Schema::Procedure>
238 $schema->drop_procedure('myprocedure');
243 my $proc_class = 'SQL::Translator::Schema::Procedure';
246 if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
247 $proc_name = shift->name;
253 if ( !exists $self->_procedures->{$proc_name} ) {
255 qq[Can't drop procedure: "$proc_name" doesn't exist]);
258 my $proc = delete $self->_procedures->{$proc_name};
263 has _triggers => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
271 Add a trigger object. Returns the new L<SQL::Translator::Schema::Trigger> object.
272 The "name" parameter is required. If you try to create a trigger with the
273 same name as an existing trigger, you will get an error and the trigger will
276 my $t1 = $schema->add_trigger( name => 'foo' );
277 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
278 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
283 my $trigger_class = 'SQL::Translator::Schema::Trigger';
286 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
288 $trigger->schema($self);
291 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
292 $args{'schema'} = $self;
293 return $self->error('No trigger name') unless $args{'name'};
294 $trigger = $trigger_class->new( \%args )
295 or return $self->error( $trigger_class->error );
298 $trigger->order( ++$self->_order->{trigger} );
300 my $trigger_name = $trigger->name or return $self->error('No trigger name');
301 if ( defined $self->_triggers->{$trigger_name} ) {
302 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
305 $self->_triggers->{$trigger_name} = $trigger;
317 Remove a trigger from the schema. Returns the trigger object if the trigger was
318 found and removed, an error otherwise. The single parameter can be either a
319 trigger name or an L<SQL::Translator::Schema::Trigger> object.
321 $schema->drop_trigger('mytrigger');
326 my $trigger_class = 'SQL::Translator::Schema::Trigger';
329 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
330 $trigger_name = shift->name;
333 $trigger_name = shift;
336 if ( !exists $self->_triggers->{$trigger_name} ) {
338 qq[Can't drop trigger: "$trigger_name" doesn't exist]);
341 my $trigger = delete $self->_triggers->{$trigger_name};
346 has _views => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
354 Add a view object. Returns the new L<SQL::Translator::Schema::View> object.
355 The "name" parameter is required. If you try to create a view with the
356 same name as an existing view, you will get an error and the view will
359 my $v1 = $schema->add_view( name => 'foo' );
360 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
361 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
366 my $view_class = 'SQL::Translator::Schema::View';
369 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
371 $view->schema($self);
374 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
375 $args{'schema'} = $self;
376 return $self->error('No view name') unless $args{'name'};
377 $view = $view_class->new( \%args ) or return $view_class->error;
380 $view->order( ++$self->_order->{view} );
381 my $view_name = $view->name or return $self->error('No view name');
383 if ( defined $self->_views->{$view_name} ) {
384 return $self->error(qq[Can't create view: "$view_name" exists]);
387 $self->_views->{$view_name} = $view;
399 Remove a view from the schema. Returns the view object if the view was found
400 and removed, an error otherwise. The single parameter can be either a view
401 name or an L<SQL::Translator::Schema::View> object.
403 $schema->drop_view('myview');
408 my $view_class = 'SQL::Translator::Schema::View';
411 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
412 $view_name = shift->name;
418 if ( !exists $self->_views->{$view_name} ) {
419 return $self->error(qq[Can't drop view: "$view_name" doesn't exist]);
422 my $view = delete $self->_views->{$view_name};
429 Get or set the schema's database. (optional)
431 my $database = $schema->database('PostgreSQL');
435 has database => ( is => 'rw', default => quote_sub(q{ '' }) );
443 Returns true if all the tables and views are valid.
445 my $ok = $schema->is_valid or die $schema->error;
451 return $self->error('No tables') unless $self->get_tables;
453 for my $object ( $self->get_tables, $self->get_views ) {
454 return $object->error unless $object->is_valid;
466 Returns a procedure by the name provided.
468 my $procedure = $schema->get_procedure('foo');
473 my $procedure_name = shift or return $self->error('No procedure name');
474 return $self->error(qq[Table "$procedure_name" does not exist])
475 unless exists $self->_procedures->{$procedure_name};
476 return $self->_procedures->{$procedure_name};
483 =head2 get_procedures
485 Returns all the procedures as an array or array reference.
487 my @procedures = $schema->get_procedures;
494 sort { $a->[0] <=> $b->[0] }
495 map { [ $_->order, $_ ] } values %{ $self->_procedures };
498 return wantarray ? @procedures : \@procedures;
501 $self->error('No procedures');
512 Returns a table by the name provided.
514 my $table = $schema->get_table('foo');
519 my $table_name = shift or return $self->error('No table name');
520 my $case_insensitive = shift;
521 if ( $case_insensitive ) {
522 $table_name = uc($table_name);
523 foreach my $table ( keys %{$self->_tables} ) {
524 return $self->_tables->{$table} if $table_name eq uc($table);
526 return $self->error(qq[Table "$table_name" does not exist]);
528 return $self->error(qq[Table "$table_name" does not exist])
529 unless exists $self->_tables->{$table_name};
530 return $self->_tables->{$table_name};
539 Returns all the tables as an array or array reference.
541 my @tables = $schema->get_tables;
548 sort { $a->[0] <=> $b->[0] }
549 map { [ $_->order, $_ ] } values %{ $self->_tables };
552 return wantarray ? @tables : \@tables;
555 $self->error('No tables');
566 Returns a trigger by the name provided.
568 my $trigger = $schema->get_trigger('foo');
573 my $trigger_name = shift or return $self->error('No trigger name');
574 return $self->error(qq[Trigger "$trigger_name" does not exist])
575 unless exists $self->_triggers->{$trigger_name};
576 return $self->_triggers->{$trigger_name};
585 Returns all the triggers as an array or array reference.
587 my @triggers = $schema->get_triggers;
594 sort { $a->[0] <=> $b->[0] }
595 map { [ $_->order, $_ ] } values %{ $self->_triggers };
598 return wantarray ? @triggers : \@triggers;
601 $self->error('No triggers');
612 Returns a view by the name provided.
614 my $view = $schema->get_view('foo');
619 my $view_name = shift or return $self->error('No view name');
620 return $self->error('View "$view_name" does not exist')
621 unless exists $self->_views->{$view_name};
622 return $self->_views->{$view_name};
631 Returns all the views as an array or array reference.
633 my @views = $schema->get_views;
640 sort { $a->[0] <=> $b->[0] }
641 map { [ $_->order, $_ ] } values %{ $self->_views };
644 return wantarray ? @views : \@views;
647 $self->error('No views');
652 sub make_natural_joins {
656 =head2 make_natural_joins
658 Creates foreign key relationships among like-named fields in different
659 tables. Accepts the following arguments:
665 A True or False argument which determines whether or not to perform
666 the joins from primary keys to fields of the same name in other tables
670 A list of fields to skip in the joins
674 $schema->make_natural_joins(
676 skip_fields => 'name,department_id',
683 my $join_pk_only = $args{'join_pk_only'} || 0;
685 map { s/^\s+|\s+$//g; $_, 1 } @{ parse_list_arg( $args{'skip_fields'} ) };
687 my ( %common_keys, %pk );
688 for my $table ( $self->get_tables ) {
689 for my $field ( $table->get_fields ) {
690 my $field_name = $field->name or next;
691 next if $skip_fields{$field_name};
692 $pk{$field_name} = 1 if $field->is_primary_key;
693 push @{ $common_keys{$field_name} }, $table->name;
697 for my $field ( keys %common_keys ) {
698 next if $join_pk_only and !defined $pk{$field};
700 my @table_names = @{ $common_keys{$field} };
701 next unless scalar @table_names > 1;
703 for my $i ( 0 .. $#table_names ) {
704 my $table1 = $self->get_table( $table_names[$i] ) or next;
706 for my $j ( 1 .. $#table_names ) {
707 my $table2 = $self->get_table( $table_names[$j] ) or next;
708 next if $table1->name eq $table2->name;
710 $table1->add_constraint(
713 reference_table => $table2->name,
714 reference_fields => $field,
725 Get or set the schema's name. (optional)
727 my $schema_name = $schema->name('Foo Database');
731 has name => ( is => 'rw', default => quote_sub(q{ '' }) );
737 Get the SQL::Translator instance that instantiated the parser.
741 has translator => ( is => 'rw', weak_ref => 1 );
749 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.