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/
53 # FIXME - to be removed, together with the SQL::Translator::Schema::Graph* stuff
54 # looks like a remnant of the Turnkey project integration back in 2003-4
55 # Appears to be quite dead
58 eval { require Class::MakeMethods }
59 or croak 'You need to install the CPAN dependency Class::MakeMethods to use as_graph()';
61 require SQL::Translator::Schema::Graph;
65 return SQL::Translator::Schema::Graph->new(
66 translator => $self->translator );
75 Returns a Graph::Directed object with the table names for nodes.
79 require Graph::Directed;
82 my $g = Graph::Directed->new;
84 for my $table ( $self->get_tables ) {
85 my $tname = $table->name;
86 $g->add_vertex( $tname );
88 for my $field ( $table->get_fields ) {
89 if ( $field->is_foreign_key ) {
90 my $fktable = $field->foreign_key_reference->reference_table;
92 $g->add_edge( $fktable, $tname );
100 has _tables => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
108 Add a table object. Returns the new SQL::Translator::Schema::Table object.
109 The "name" parameter is required. If you try to create a table with the
110 same name as an existing table, you will get an error and the table will
113 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
114 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
115 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
120 my $table_class = 'SQL::Translator::Schema::Table';
123 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
125 $table->schema($self);
128 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
129 $args{'schema'} = $self;
130 $table = $table_class->new( \%args )
131 or return $self->error( $table_class->error );
134 $table->order( ++$self->_order->{table} );
136 # We know we have a name as the Table->new above errors if none given.
137 my $table_name = $table->name;
139 if ( defined $self->_tables->{$table_name} ) {
140 return $self->error(qq[Can't use table name "$table_name": table exists]);
143 $self->_tables->{$table_name} = $table;
155 Remove a table from the schema. Returns the table object if the table was found
156 and removed, an error otherwise. The single parameter can be either a table
157 name or an C<SQL::Translator::Schema::Table> object. The "cascade" parameter
158 can be set to 1 to also drop all triggers on the table, default is 0.
160 $schema->drop_table('mytable');
161 $schema->drop_table('mytable', cascade => 1);
166 my $table_class = 'SQL::Translator::Schema::Table';
169 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
170 $table_name = shift->name;
176 my $cascade = $args{'cascade'};
178 if ( !exists $self->_tables->{$table_name} ) {
179 return $self->error(qq[Can't drop table: $table_name" doesn't exist]);
182 my $table = delete $self->_tables->{$table_name};
186 # Drop all triggers on this table
187 $self->drop_trigger()
188 for ( grep { $_->on_table eq $table_name } values %{ $self->_triggers } );
193 has _procedures => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
201 Add a procedure object. Returns the new SQL::Translator::Schema::Procedure
202 object. The "name" parameter is required. If you try to create a procedure
203 with the same name as an existing procedure, you will get an error and the
204 procedure will not be created.
206 my $p1 = $schema->add_procedure( name => 'foo' );
207 my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' );
208 $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error;
213 my $procedure_class = 'SQL::Translator::Schema::Procedure';
216 if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
218 $procedure->schema($self);
221 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
222 $args{'schema'} = $self;
223 return $self->error('No procedure name') unless $args{'name'};
224 $procedure = $procedure_class->new( \%args )
225 or return $self->error( $procedure_class->error );
228 $procedure->order( ++$self->_order->{proc} );
229 my $procedure_name = $procedure->name
230 or return $self->error('No procedure name');
232 if ( defined $self->_procedures->{$procedure_name} ) {
234 qq[Can't create procedure: "$procedure_name" exists] );
237 $self->_procedures->{$procedure_name} = $procedure;
247 =head2 drop_procedure
249 Remove a procedure from the schema. Returns the procedure object if the
250 procedure was found and removed, an error otherwise. The single parameter
251 can be either a procedure name or an C<SQL::Translator::Schema::Procedure>
254 $schema->drop_procedure('myprocedure');
259 my $proc_class = 'SQL::Translator::Schema::Procedure';
262 if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
263 $proc_name = shift->name;
269 if ( !exists $self->_procedures->{$proc_name} ) {
271 qq[Can't drop procedure: $proc_name" doesn't exist]);
274 my $proc = delete $self->_procedures->{$proc_name};
279 has _triggers => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
287 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
288 The "name" parameter is required. If you try to create a trigger with the
289 same name as an existing trigger, you will get an error and the trigger will
292 my $t1 = $schema->add_trigger( name => 'foo' );
293 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
294 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
299 my $trigger_class = 'SQL::Translator::Schema::Trigger';
302 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
304 $trigger->schema($self);
307 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
308 $args{'schema'} = $self;
309 return $self->error('No trigger name') unless $args{'name'};
310 $trigger = $trigger_class->new( \%args )
311 or return $self->error( $trigger_class->error );
314 $trigger->order( ++$self->_order->{trigger} );
316 my $trigger_name = $trigger->name or return $self->error('No trigger name');
317 if ( defined $self->_triggers->{$trigger_name} ) {
318 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
321 $self->_triggers->{$trigger_name} = $trigger;
333 Remove a trigger from the schema. Returns the trigger object if the trigger was
334 found and removed, an error otherwise. The single parameter can be either a
335 trigger name or an C<SQL::Translator::Schema::Trigger> object.
337 $schema->drop_trigger('mytrigger');
342 my $trigger_class = 'SQL::Translator::Schema::Trigger';
345 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
346 $trigger_name = shift->name;
349 $trigger_name = shift;
352 if ( !exists $self->_triggers->{$trigger_name} ) {
354 qq[Can't drop trigger: $trigger_name" doesn't exist]);
357 my $trigger = delete $self->_triggers->{$trigger_name};
362 has _views => ( is => 'ro', init_arg => undef, default => quote_sub(q{ +{} }) );
370 Add a view object. Returns the new SQL::Translator::Schema::View object.
371 The "name" parameter is required. If you try to create a view with the
372 same name as an existing view, you will get an error and the view will
375 my $v1 = $schema->add_view( name => 'foo' );
376 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
377 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
382 my $view_class = 'SQL::Translator::Schema::View';
385 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
387 $view->schema($self);
390 my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
391 $args{'schema'} = $self;
392 return $self->error('No view name') unless $args{'name'};
393 $view = $view_class->new( \%args ) or return $view_class->error;
396 $view->order( ++$self->_order->{view} );
397 my $view_name = $view->name or return $self->error('No view name');
399 if ( defined $self->_views->{$view_name} ) {
400 return $self->error(qq[Can't create view: "$view_name" exists]);
403 $self->_views->{$view_name} = $view;
415 Remove a view from the schema. Returns the view object if the view was found
416 and removed, an error otherwise. The single parameter can be either a view
417 name or an C<SQL::Translator::Schema::View> object.
419 $schema->drop_view('myview');
424 my $view_class = 'SQL::Translator::Schema::View';
427 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
428 $view_name = shift->name;
434 if ( !exists $self->_views->{$view_name} ) {
435 return $self->error(qq[Can't drop view: $view_name" doesn't exist]);
438 my $view = delete $self->_views->{$view_name};
445 Get or set the schema's database. (optional)
447 my $database = $schema->database('PostgreSQL');
451 has database => ( is => 'rw', default => quote_sub(q{ '' }) );
459 Returns true if all the tables and views are valid.
461 my $ok = $schema->is_valid or die $schema->error;
467 return $self->error('No tables') unless $self->get_tables;
469 for my $object ( $self->get_tables, $self->get_views ) {
470 return $object->error unless $object->is_valid;
482 Returns a procedure by the name provided.
484 my $procedure = $schema->get_procedure('foo');
489 my $procedure_name = shift or return $self->error('No procedure name');
490 return $self->error(qq[Table "$procedure_name" does not exist])
491 unless exists $self->_procedures->{$procedure_name};
492 return $self->_procedures->{$procedure_name};
499 =head2 get_procedures
501 Returns all the procedures as an array or array reference.
503 my @procedures = $schema->get_procedures;
510 sort { $a->[0] <=> $b->[0] }
511 map { [ $_->order, $_ ] } values %{ $self->_procedures };
514 return wantarray ? @procedures : \@procedures;
517 $self->error('No procedures');
518 return wantarray ? () : undef;
528 Returns a table by the name provided.
530 my $table = $schema->get_table('foo');
535 my $table_name = shift or return $self->error('No table name');
536 my $case_insensitive = shift;
537 if ( $case_insensitive ) {
538 $table_name = uc($table_name);
539 foreach my $table ( keys %{$self->_tables} ) {
540 return $self->_tables->{$table} if $table_name eq uc($table);
542 return $self->error(qq[Table "$table_name" does not exist]);
544 return $self->error(qq[Table "$table_name" does not exist])
545 unless exists $self->_tables->{$table_name};
546 return $self->_tables->{$table_name};
555 Returns all the tables as an array or array reference.
557 my @tables = $schema->get_tables;
564 sort { $a->[0] <=> $b->[0] }
565 map { [ $_->order, $_ ] } values %{ $self->_tables };
568 return wantarray ? @tables : \@tables;
571 $self->error('No tables');
572 return wantarray ? () : undef;
582 Returns a trigger by the name provided.
584 my $trigger = $schema->get_trigger('foo');
589 my $trigger_name = shift or return $self->error('No trigger name');
590 return $self->error(qq[Table "$trigger_name" does not exist])
591 unless exists $self->_triggers->{$trigger_name};
592 return $self->_triggers->{$trigger_name};
601 Returns all the triggers as an array or array reference.
603 my @triggers = $schema->get_triggers;
610 sort { $a->[0] <=> $b->[0] }
611 map { [ $_->order, $_ ] } values %{ $self->_triggers };
614 return wantarray ? @triggers : \@triggers;
617 $self->error('No triggers');
618 return wantarray ? () : undef;
628 Returns a view by the name provided.
630 my $view = $schema->get_view('foo');
635 my $view_name = shift or return $self->error('No view name');
636 return $self->error('View "$view_name" does not exist')
637 unless exists $self->_views->{$view_name};
638 return $self->_views->{$view_name};
647 Returns all the views as an array or array reference.
649 my @views = $schema->get_views;
656 sort { $a->[0] <=> $b->[0] }
657 map { [ $_->order, $_ ] } values %{ $self->_views };
660 return wantarray ? @views : \@views;
663 $self->error('No views');
664 return wantarray ? () : undef;
668 sub make_natural_joins {
672 =head2 make_natural_joins
674 Creates foriegn key relationships among like-named fields in different
675 tables. Accepts the following arguments:
681 A True or False argument which determins whether or not to perform
682 the joins from primary keys to fields of the same name in other tables
686 A list of fields to skip in the joins
690 $schema->make_natural_joins(
692 skip_fields => 'name,department_id',
699 my $join_pk_only = $args{'join_pk_only'} || 0;
701 map { s/^\s+|\s+$//g; $_, 1 } @{ parse_list_arg( $args{'skip_fields'} ) };
703 my ( %common_keys, %pk );
704 for my $table ( $self->get_tables ) {
705 for my $field ( $table->get_fields ) {
706 my $field_name = $field->name or next;
707 next if $skip_fields{$field_name};
708 $pk{$field_name} = 1 if $field->is_primary_key;
709 push @{ $common_keys{$field_name} }, $table->name;
713 for my $field ( keys %common_keys ) {
714 next if $join_pk_only and !defined $pk{$field};
716 my @table_names = @{ $common_keys{$field} };
717 next unless scalar @table_names > 1;
719 for my $i ( 0 .. $#table_names ) {
720 my $table1 = $self->get_table( $table_names[$i] ) or next;
722 for my $j ( 1 .. $#table_names ) {
723 my $table2 = $self->get_table( $table_names[$j] ) or next;
724 next if $table1->name eq $table2->name;
726 $table1->add_constraint(
729 reference_table => $table2->name,
730 reference_fields => $field,
741 Get or set the schema's name. (optional)
743 my $schema_name = $schema->name('Foo Database');
747 has name => ( is => 'rw', default => quote_sub(q{ '' }) );
753 Get the SQL::Translator instance that instantiated the parser.
757 has translator => ( is => 'rw', weak_ref => 1 );
765 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.