1 package SQL::Translator::Schema;
3 # ----------------------------------------------------------------------
4 # $Id: Schema.pm,v 1.9 2003-10-03 23:56:21 kycl4rk Exp $
5 # ----------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
27 SQL::Translator::Schema - SQL::Translator schema object
31 use SQL::Translator::Schema;
32 my $schema = SQL::Translator::Schema->new;
33 my $table = $schema->add_table( name => 'foo' );
34 my $view = $schema->add_view( name => 'bar', sql => '...' );
38 C<SQL::Translator::Schema> is the object that accepts, validates, and
39 returns the database structure.
47 use SQL::Translator::Schema::Constants;
48 use SQL::Translator::Schema::Table;
49 use SQL::Translator::Schema::Trigger;
50 use SQL::Translator::Schema::View;
51 use SQL::Translator::Utils 'parse_list_arg';
53 use base 'Class::Base';
54 use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER ];
56 $VERSION = sprintf "%d.%02d", q$Revision: 1.9 $ =~ /(\d+)\.(\d+)/;
58 # ----------------------------------------------------------------------
67 my $schema = SQL::Translator->new(
74 my ( $self, $config ) = @_;
75 $self->params( $config, qw[ name database ] ) || return undef;
79 # ----------------------------------------------------------------------
86 Add a table object. Returns the new SQL::Translator::Schema::Table object.
87 The "name" parameter is required. If you try to create a table with the
88 same name as an existing table, you will get an error and the table will
91 my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error;
92 my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' );
93 $t2 = $schema->add_table( $table_bar ) or die $schema->error;
98 my $table_class = 'SQL::Translator::Schema::Table';
101 if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
103 $table->schema( $self );
107 $args{'schema'} = $self;
108 $table = $table_class->new( \%args ) or return
109 $self->error( $table_class->error );
112 $table->order( ++$TABLE_ORDER );
113 my $table_name = $table->name or return $self->error('No table name');
115 if ( defined $self->{'tables'}{ $table_name } ) {
116 return $self->error(qq[Can't create table: "$table_name" exists]);
119 $self->{'tables'}{ $table_name } = $table;
125 # ----------------------------------------------------------------------
132 Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object.
133 The "name" parameter is required. If you try to create a trigger with the
134 same name as an existing trigger, you will get an error and the trigger will
137 my $t1 = $schema->add_trigger( name => 'foo' );
138 my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' );
139 $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error;
144 my $trigger_class = 'SQL::Translator::Schema::Trigger';
147 if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
152 return $self->error('No trigger name') unless $args{'name'};
153 $trigger = $trigger_class->new( \%args ) or
154 return $self->error( $trigger_class->error );
157 $trigger->order( ++$TRIGGER_ORDER );
158 my $trigger_name = $trigger->name or return $self->error('No trigger name');
160 if ( defined $self->{'triggers'}{ $trigger_name } ) {
161 return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
164 $self->{'triggers'}{ $trigger_name } = $trigger;
170 # ----------------------------------------------------------------------
177 Add a view object. Returns the new SQL::Translator::Schema::View object.
178 The "name" parameter is required. If you try to create a view with the
179 same name as an existing view, you will get an error and the view will
182 my $v1 = $schema->add_view( name => 'foo' );
183 my $v2 = SQL::Translator::Schema::View->new( name => 'bar' );
184 $v2 = $schema->add_view( $view_bar ) or die $schema->error;
189 my $view_class = 'SQL::Translator::Schema::View';
192 if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
197 return $self->error('No view name') unless $args{'name'};
198 $view = $view_class->new( \%args ) or return $view_class->error;
201 $view->order( ++$VIEW_ORDER );
202 my $view_name = $view->name or return $self->error('No view name');
204 if ( defined $self->{'views'}{ $view_name } ) {
205 return $self->error(qq[Can't create view: "$view_name" exists]);
208 $self->{'views'}{ $view_name } = $view;
214 # ----------------------------------------------------------------------
221 Get or set the schema's database. (optional)
223 my $database = $schema->database('PostgreSQL');
228 $self->{'database'} = shift if @_;
229 return $self->{'database'} || '';
232 # ----------------------------------------------------------------------
239 Returns true if all the tables and views are valid.
241 my $ok = $schema->is_valid or die $schema->error;
247 return $self->error('No tables') unless $self->get_tables;
249 for my $object ( $self->get_tables, $self->get_views ) {
250 return $object->error unless $object->is_valid;
256 # ----------------------------------------------------------------------
263 Returns a table by the name provided.
265 my $table = $schema->get_table('foo');
270 my $table_name = shift or return $self->error('No table name');
271 return $self->error( qq[Table "$table_name" does not exist] ) unless
272 exists $self->{'tables'}{ $table_name };
273 return $self->{'tables'}{ $table_name };
276 # ----------------------------------------------------------------------
283 Returns all the tables as an array or array reference.
285 my @tables = $schema->get_tables;
292 sort { $a->[0] <=> $b->[0] }
293 map { [ $_->order, $_ ] }
294 values %{ $self->{'tables'} };
297 return wantarray ? @tables : \@tables;
300 $self->error('No tables');
301 return wantarray ? () : undef;
305 # ----------------------------------------------------------------------
312 Returns a view by the name provided.
314 my $view = $schema->get_view('foo');
319 my $view_name = shift or return $self->error('No view name');
320 return $self->error('View "$view_name" does not exist') unless
321 exists $self->{'views'}{ $view_name };
322 return $self->{'views'}{ $view_name };
325 # ----------------------------------------------------------------------
332 Returns all the views as an array or array reference.
334 my @views = $schema->get_views;
341 sort { $a->[0] <=> $b->[0] }
342 map { [ $_->order, $_ ] }
343 values %{ $self->{'views'} };
346 return wantarray ? @views : \@views;
349 $self->error('No views');
350 return wantarray ? () : undef;
354 # ----------------------------------------------------------------------
355 sub make_natural_joins {
359 =head2 make_natural_joins
361 Creates foriegn key relationships among like-named fields in different
362 tables. Accepts the following arguments:
368 A True or False argument which determins whether or not to perform
369 the joins from primary keys to fields of the same name in other tables
373 A list of fields to skip in the joins
377 $schema->make_natural_joins(
379 skip_fields => 'name,department_id',
386 my $join_pk_only = $args{'join_pk_only'} || 0;
387 my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{
388 parse_list_arg( $args{'skip_fields'} )
391 my ( %common_keys, %pk );
392 for my $table ( $self->get_tables ) {
393 for my $field ( $table->get_fields ) {
394 my $field_name = $field->name or next;
395 next if $skip_fields{ $field_name };
396 $pk{ $field_name } = 1 if $field->is_primary_key;
397 push @{ $common_keys{ $field_name } }, $table->name;
401 for my $field ( keys %common_keys ) {
402 next if $join_pk_only and !defined $pk{ $field };
404 my @table_names = @{ $common_keys{ $field } };
405 next unless scalar @table_names > 1;
407 for my $i ( 0 .. $#table_names ) {
408 my $table1 = $self->get_table( $table_names[ $i ] ) or next;
410 for my $j ( 1 .. $#table_names ) {
411 my $table2 = $self->get_table( $table_names[ $j ] ) or next;
412 next if $table1->name eq $table2->name;
414 $table1->add_constraint(
417 reference_table => $table2->name,
418 reference_fields => $field,
427 # ----------------------------------------------------------------------
434 Get or set the schema's name. (optional)
436 my $schema_name = $schema->name('Foo Database');
441 $self->{'name'} = shift if @_;
442 return $self->{'name'} || '';
445 # ----------------------------------------------------------------------
448 undef $_ for values %{ $self->{'tables'} };
449 undef $_ for values %{ $self->{'views'} };
454 # ----------------------------------------------------------------------
460 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>