X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FSchema.pm;h=1880d6e018b2d53fe0bf812765a0751eb25757e2;hb=2e8dfb7635467806b90243dbb73d6b873e3175a5;hp=a3c173f96b37f709f22760c58ff7d86eb0e7727e;hpb=76dce61949ca8ff78599980aa638088751cd521e;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Schema.pm b/lib/SQL/Translator/Schema.pm index a3c173f..1880d6e 100644 --- a/lib/SQL/Translator/Schema.pm +++ b/lib/SQL/Translator/Schema.pm @@ -1,7 +1,7 @@ package SQL::Translator::Schema; # ---------------------------------------------------------------------- -# $Id: Schema.pm,v 1.2 2003-05-03 04:07:38 kycl4rk Exp $ +# $Id: Schema.pm,v 1.8 2003-06-18 23:14:31 kycl4rk Exp $ # ---------------------------------------------------------------------- # Copyright (C) 2003 Ken Y. Clark # @@ -44,13 +44,15 @@ returns the database structure. use strict; use Class::Base; +use SQL::Translator::Schema::Constants; use SQL::Translator::Schema::Table; +use SQL::Translator::Utils 'parse_list_arg'; use SQL::Translator::Schema::View; use base 'Class::Base'; use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER ]; -$VERSION = 1.00; +$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/; # ---------------------------------------------------------------------- sub init { @@ -61,12 +63,15 @@ sub init { Object constructor. - my $schema = SQL::Translator->new; + my $schema = SQL::Translator->new( + name => 'Foo', + database => 'MySQL', + ); =cut my ( $self, $config ) = @_; - # empty for now + $self->params( $config, qw[ name database ] ) || return undef; return $self; } @@ -78,19 +83,40 @@ sub add_table { =head2 add_table Add a table object. Returns the new SQL::Translator::Schema::Table object. +The "name" parameter is required. If you try to create a table with the +same name as an existing table, you will get an error and the table will +not be created. - my $table = $schema->add_table( name => 'foo' ); + my $t1 = $schema->add_table( name => 'foo' ) or die $schema->error; + my $t2 = SQL::Translator::Schema::Table->new( name => 'bar' ); + $t2 = $schema->add_table( $table_bar ) or die $schema->error; =cut - my $self = shift; - my %args = @_; - return $self->error('No table name') unless $args{'name'}; - my $table = SQL::Translator::Schema::Table->new( \%args ) or return - SQL::Translator::Schema::Table->error; + my $self = shift; + my $table_class = 'SQL::Translator::Schema::Table'; + my $table; + + if ( UNIVERSAL::isa( $_[0], $table_class ) ) { + $table = shift; + $table->schema( $self ); + } + else { + my %args = @_; + $args{'schema'} = $self; + $table = $table_class->new( \%args ) or return + $self->error( $table_class->error ); + } - $self->{'tables'}{ $table->name } = $table; - $self->{'tables'}{ $table->name }{'order'} = ++$TABLE_ORDER; + $table->order( ++$TABLE_ORDER ); + my $table_name = $table->name or return $self->error('No table name'); + + if ( defined $self->{'tables'}{ $table_name } ) { + return $self->error(qq[Can't create table: "$table_name" exists]); + } + else { + $self->{'tables'}{ $table_name } = $table; + } return $table; } @@ -103,24 +129,61 @@ sub add_view { =head2 add_view Add a view object. Returns the new SQL::Translator::Schema::View object. +The "name" parameter is required. If you try to create a view with the +same name as an existing view, you will get an error and the view will +not be created. - my $view = $schema->add_view( name => 'foo' ); + my $v1 = $schema->add_view( name => 'foo' ); + my $v2 = SQL::Translator::Schema::View->new( name => 'bar' ); + $v2 = $schema->add_view( $view_bar ) or die $schema->error; =cut - my $self = shift; - my %args = @_; - return $self->error('No view name') unless $args{'name'}; - my $view = SQL::Translator::Schema::View->new( @_ ) or return - SQL::Translator::Schema::View->error; + my $self = shift; + my $view_class = 'SQL::Translator::Schema::View'; + my $view; + + if ( UNIVERSAL::isa( $_[0], $view_class ) ) { + $view = shift; + } + else { + my %args = @_; + return $self->error('No view name') unless $args{'name'}; + $view = $view_class->new( \%args ) or return $view_class->error; + } - $self->{'views'}{ $view->name } = $view; - $self->{'views'}{ $view->name }{'order'} = ++$VIEW_ORDER; + $view->order( ++$VIEW_ORDER ); + my $view_name = $view->name or return $self->error('No view name'); + + if ( defined $self->{'views'}{ $view_name } ) { + return $self->error(qq[Can't create view: "$view_name" exists]); + } + else { + $self->{'views'}{ $view_name } = $view; + } return $view; } # ---------------------------------------------------------------------- +sub database { + +=pod + +=head2 database + +Get or set the schema's database. (optional) + + my $database = $schema->database('PostgreSQL'); + +=cut + + my $self = shift; + $self->{'database'} = shift if @_; + return $self->{'database'} || ''; +} + +# ---------------------------------------------------------------------- sub is_valid { =pod @@ -159,7 +222,7 @@ Returns a table by the name provided. my $self = shift; my $table_name = shift or return $self->error('No table name'); - return $self->error('Table "$table_name" does not exist') unless + return $self->error( qq[Table "$table_name" does not exist] ) unless exists $self->{'tables'}{ $table_name }; return $self->{'tables'}{ $table_name }; } @@ -179,7 +242,9 @@ Returns all the tables as an array or array reference. my $self = shift; my @tables = - sort { $a->{'order'} <=> $b->{'order'} } + map { $_->[1] } + sort { $a->[0] <=> $b->[0] } + map { [ $_->order, $_ ] } values %{ $self->{'tables'} }; if ( @tables ) { @@ -226,7 +291,10 @@ Returns all the views as an array or array reference. my $self = shift; my @views = - sort { $a->{'order'} <=> $b->{'order'} } values %{ $self->{'views'} }; + map { $_->[1] } + sort { $a->[0] <=> $b->[0] } + map { [ $_->order, $_ ] } + values %{ $self->{'views'} }; if ( @views ) { return wantarray ? @views : \@views; @@ -237,6 +305,104 @@ Returns all the views as an array or array reference. } } +# ---------------------------------------------------------------------- +sub make_natural_joins { + +=pod + +=head2 make_natural_joins + +Creates foriegn key relationships among like-named fields in different +tables. Accepts the following arguments: + +=over 4 + +=item * join_pk_only + +A True or False argument which determins whether or not to perform +the joins from primary keys to fields of the same name in other tables + +=item * skip_fields + +A list of fields to skip in the joins + +=back 4 + + $schema->make_natural_joins( + join_pk_only => 1, + skip_fields => 'name,department_id', + ); + +=cut + + my $self = shift; + my %args = @_; + my $join_pk_only = $args{'join_pk_only'} || 0; + my %skip_fields = map { s/^\s+|\s+$//g; $_, 1 } @{ + parse_list_arg( $args{'skip_fields'} ) + }; + + my ( %common_keys, %pk ); + for my $table ( $self->get_tables ) { + for my $field ( $table->get_fields ) { + my $field_name = $field->name or next; + next if $skip_fields{ $field_name }; + $pk{ $field_name } = 1 if $field->is_primary_key; + push @{ $common_keys{ $field_name } }, $table->name; + } + } + + for my $field ( keys %common_keys ) { + next if $join_pk_only and !defined $pk{ $field }; + + my @table_names = @{ $common_keys{ $field } }; + next unless scalar @table_names > 1; + + for my $i ( 0 .. $#table_names ) { + my $table1 = $self->get_table( $table_names[ $i ] ) or next; + + for my $j ( 1 .. $#table_names ) { + my $table2 = $self->get_table( $table_names[ $j ] ) or next; + next if $table1->name eq $table2->name; + + $table1->add_constraint( + type => FOREIGN_KEY, + fields => $field, + reference_table => $table2->name, + reference_fields => $field, + ); + } + } + } + + return 1; +} + +# ---------------------------------------------------------------------- +sub name { + +=pod + +=head2 name + +Get or set the schema's name. (optional) + + my $schema_name = $schema->name('Foo Database'); + +=cut + + my $self = shift; + $self->{'name'} = shift if @_; + return $self->{'name'} || ''; +} + +# ---------------------------------------------------------------------- +sub DESTROY { + my $self = shift; + undef $_ for values %{ $self->{'tables'} }; + undef $_ for values %{ $self->{'views'} }; +} + 1; # ----------------------------------------------------------------------