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;
36 use SQL::Translator::Utils 'parse_list_arg';
39 extends 'SQL::Translator::Schema::Object';
41 our $VERSION = '1.59';
44 has _order => (is => 'ro', default => sub { +{ map { $_ => 0 } qw/
52 # FIXME - to be removed, together with the SQL::Translator::Schema::Graph* stuff
53 # looks like a remnant of the Turnkey project integration back in 2003-4
54 # Appears to be quite dead
57 eval { require Class::MakeMethods }
58 or croak 'You need to install the CPAN dependency Class::MakeMethods to use as_graph()';
60 require SQL::Translator::Schema::Graph;
64 return SQL::Translator::Schema::Graph->new(
65 translator => $self->translator );
74 Returns a Graph::Directed object with the table names for nodes.
78 require Graph::Directed;
81 my $g = Graph::Directed->new;
83 for my $table ( $self->get_tables ) {
84 my $tname = $table->name;
85 $g->add_vertex( $tname );
87 for my $field ( $table->get_fields ) {
88 if ( $field->is_foreign_key ) {
89 my $fktable = $field->foreign_key_reference->reference_table;
91 $g->add_edge( $fktable, $tname );
99 has _tables => ( is => 'ro', init_arg => undef, default => sub { +{} } );
107 Add a table object. Returns the new SQL::Translator::Schema::Table object.
108 The "name" parameter is required. If you try to create a table with the
109 same name as an existing table, you will get an error and the table will
112 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
113 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
114 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
119 my $table_class = 'SQL::Translator::Schema::Table';
122 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
124 $table->schema($self);
127 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
128 $args{'schema'} = $self;
129 $table = $table_class->new( \%args )
130 or return $self->error( $table_class->error );
133 $table->order( ++$self->_order->{table} );
135 # We know we have a name as the Table->new above errors if none given.
136 my $table_name = $table->name;
138 if ( defined $self->_tables->{$table_name} ) {
139 return $self->error(qq[Can't use table name "$table_name": table exists]);
142 $self->_tables->{$table_name} = $table;
154 Remove a table from the schema. Returns the table object if the table was found
155 and removed, an error otherwise. The single parameter can be either a table
156 name or an C<SQL::Translator::Schema::Table> object. The "cascade" parameter
157 can be set to 1 to also drop all triggers on the table, default is 0.
159 $schema->drop_table('mytable');
160 $schema->drop_table('mytable', cascade => 1);
165 my $table_class = 'SQL::Translator::Schema::Table';
168 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
169 $table_name = shift->name;
175 my $cascade = $args{'cascade'};
177 if ( !exists $self->_tables->{$table_name} ) {
178 return $self->error(qq[Can't drop table: $table_name" doesn't exist]);
181 my $table = delete $self->_tables->{$table_name};
185 # Drop all triggers on this table
186 $self->drop_trigger()
187 for ( grep { $_->on_table eq $table_name } values %{ $self->_triggers } );
192 has _procedures => ( is => 'ro', init_arg => undef, default => sub { +{} } );
200 Add a procedure object. Returns the new SQL::Translator::Schema::Procedure
201 object. The "name" parameter is required. If you try to create a procedure
202 with the same name as an existing procedure, you will get an error and the
203 procedure will not be created.
205 my $p1 = $schema->add_procedure( name => 'foo' );
206 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
207 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
212 my $procedure_class = 'SQL::Translator::Schema::Procedure';
215 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
217 $procedure->schema($self);
220 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
221 $args{'schema'} = $self;
222 return $self->error('No procedure name') unless $args{'name'};
223 $procedure = $procedure_class->new( \%args )
224 or return $self->error( $procedure_class->error );
227 $procedure->order( ++$self->_order->{proc} );
228 my $procedure_name = $procedure->name
229 or return $self->error('No procedure name');
231 if ( defined $self->_procedures->{$procedure_name} ) {
233 qq[Can't create procedure: "$procedure_name" exists] );
236 $self->_procedures->{$procedure_name} = $procedure;
246 =head2 drop_procedure
248 Remove a procedure from the schema. Returns the procedure object if the
249 procedure was found and removed, an error otherwise. The single parameter
250 can be either a procedure name or an C<SQL::Translator::Schema::Procedure>
253 $schema->drop_procedure('myprocedure');
258 my $proc_class = 'SQL::Translator::Schema::Procedure';
261 if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
262 $proc_name = shift->name;
268 if ( !exists $self->_procedures->{$proc_name} ) {
270 qq[Can't drop procedure: $proc_name" doesn't exist]);
273 my $proc = delete $self->_procedures->{$proc_name};
278 has _triggers => ( is => 'ro', init_arg => undef, default => sub { +{} } );
286 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
287 The "name" parameter is required. If you try to create a trigger with the
288 same name as an existing trigger, you will get an error and the trigger will
291 my $t1 = $schema->add_trigger( name => 'foo' );
292 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
293 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
298 my $trigger_class = 'SQL::Translator::Schema::Trigger';
301 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
303 $trigger->schema($self);
306 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
307 $args{'schema'} = $self;
308 return $self->error('No trigger name') unless $args{'name'};
309 $trigger = $trigger_class->new( \%args )
310 or return $self->error( $trigger_class->error );
313 $trigger->order( ++$self->_order->{trigger} );
315 my $trigger_name = $trigger->name or return $self->error('No trigger name');
316 if ( defined $self->_triggers->{$trigger_name} ) {
317 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
320 $self->_triggers->{$trigger_name} = $trigger;
332 Remove a trigger from the schema. Returns the trigger object if the trigger was
333 found and removed, an error otherwise. The single parameter can be either a
334 trigger name or an C<SQL::Translator::Schema::Trigger> object.
336 $schema->drop_trigger('mytrigger');
341 my $trigger_class = 'SQL::Translator::Schema::Trigger';
344 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
345 $trigger_name = shift->name;
348 $trigger_name = shift;
351 if ( !exists $self->_triggers->{$trigger_name} ) {
353 qq[Can't drop trigger: $trigger_name" doesn't exist]);
356 my $trigger = delete $self->_triggers->{$trigger_name};
361 has _views => ( is => 'ro', init_arg => undef, default => sub { +{} } );
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};
444 Get or set the schema's database. (optional)
446 my $database = $schema->database('PostgreSQL');
450 has database => ( is => 'rw', default => sub { '' } );
458 Returns true if all the tables and views are valid.
460 my $ok = $schema->is_valid or die $schema->error;
466 return $self->error('No tables') unless $self->get_tables;
468 for my $object ( $self->get_tables, $self->get_views ) {
469 return $object->error unless $object->is_valid;
481 Returns a procedure by the name provided.
483 my $procedure = $schema->get_procedure('foo');
488 my $procedure_name = shift or return $self->error('No procedure name');
489 return $self->error(qq[Table "$procedure_name" does not exist])
490 unless exists $self->_procedures->{$procedure_name};
491 return $self->_procedures->{$procedure_name};
498 =head2 get_procedures
500 Returns all the procedures as an array or array reference.
502 my @procedures = $schema->get_procedures;
509 sort { $a->[0] <=> $b->[0] }
510 map { [ $_->order, $_ ] } values %{ $self->_procedures };
513 return wantarray ? @procedures : \@procedures;
516 $self->error('No procedures');
517 return wantarray ? () : undef;
527 Returns a table by the name provided.
529 my $table = $schema->get_table('foo');
534 my $table_name = shift or return $self->error('No table name');
535 my $case_insensitive = shift;
536 if ( $case_insensitive ) {
537 $table_name = uc($table_name);
538 foreach my $table ( keys %{$self->_tables} ) {
539 return $self->_tables->{$table} if $table_name eq uc($table);
541 return $self->error(qq[Table "$table_name" does not exist]);
543 return $self->error(qq[Table "$table_name" does not exist])
544 unless exists $self->_tables->{$table_name};
545 return $self->_tables->{$table_name};
554 Returns all the tables as an array or array reference.
556 my @tables = $schema->get_tables;
563 sort { $a->[0] <=> $b->[0] }
564 map { [ $_->order, $_ ] } values %{ $self->_tables };
567 return wantarray ? @tables : \@tables;
570 $self->error('No tables');
571 return wantarray ? () : undef;
581 Returns a trigger by the name provided.
583 my $trigger = $schema->get_trigger('foo');
588 my $trigger_name = shift or return $self->error('No trigger name');
589 return $self->error(qq[Table "$trigger_name" does not exist])
590 unless exists $self->_triggers->{$trigger_name};
591 return $self->_triggers->{$trigger_name};
600 Returns all the triggers as an array or array reference.
602 my @triggers = $schema->get_triggers;
609 sort { $a->[0] <=> $b->[0] }
610 map { [ $_->order, $_ ] } values %{ $self->_triggers };
613 return wantarray ? @triggers : \@triggers;
616 $self->error('No triggers');
617 return wantarray ? () : undef;
627 Returns a view by the name provided.
629 my $view = $schema->get_view('foo');
634 my $view_name = shift or return $self->error('No view name');
635 return $self->error('View "$view_name" does not exist')
636 unless exists $self->_views->{$view_name};
637 return $self->_views->{$view_name};
646 Returns all the views as an array or array reference.
648 my @views = $schema->get_views;
655 sort { $a->[0] <=> $b->[0] }
656 map { [ $_->order, $_ ] } values %{ $self->_views };
659 return wantarray ? @views : \@views;
662 $self->error('No views');
663 return wantarray ? () : undef;
667 sub make_natural_joins {
671 =head2 make_natural_joins
673 Creates foriegn key relationships among like-named fields in different
674 tables. Accepts the following arguments:
680 A True or False argument which determins whether or not to perform
681 the joins from primary keys to fields of the same name in other tables
685 A list of fields to skip in the joins
689 $schema->make_natural_joins(
691 skip_fields => 'name,department_id',
698 my $join_pk_only = $args{'join_pk_only'} || 0;
700 map { s/^\s+|\s+$//g; $_, 1 } @{ parse_list_arg( $args{'skip_fields'} ) };
702 my ( %common_keys, %pk );
703 for my $table ( $self->get_tables ) {
704 for my $field ( $table->get_fields ) {
705 my $field_name = $field->name or next;
706 next if $skip_fields{$field_name};
707 $pk{$field_name} = 1 if $field->is_primary_key;
708 push @{ $common_keys{$field_name} }, $table->name;
712 for my $field ( keys %common_keys ) {
713 next if $join_pk_only and !defined $pk{$field};
715 my @table_names = @{ $common_keys{$field} };
716 next unless scalar @table_names > 1;
718 for my $i ( 0 .. $#table_names ) {
719 my $table1 = $self->get_table( $table_names[$i] ) or next;
721 for my $j ( 1 .. $#table_names ) {
722 my $table2 = $self->get_table( $table_names[$j] ) or next;
723 next if $table1->name eq $table2->name;
725 $table1->add_constraint(
728 reference_table => $table2->name,
729 reference_fields => $field,
740 Get or set the schema's name. (optional)
742 my $schema_name = $schema->name('Foo Database');
746 has name => ( is => 'rw', default => sub { '' } );
752 Get the SQL::Translator instance that instantiated the parser.
756 has translator => ( is => 'rw', weak_ref => 1 );
764 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.