X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FSchema.pm;h=beac8935f016817480be0bd9b5afd23ca034d3b6;hb=37b15d8c38751b7f03405626fd180a05dfd423af;hp=0158ef6e1315c0f8246a8bcde31793a662d642ca;hpb=d0b4369556ff13af458726d6ca856ec61b95d553;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Schema.pm b/lib/SQL/Translator/Schema.pm index 0158ef6..beac893 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.4 2003-05-09 16:53:21 kycl4rk Exp $ +# $Id: Schema.pm,v 1.12 2003-10-08 18:35:15 phrrngtn Exp $ # ---------------------------------------------------------------------- # Copyright (C) 2003 Ken Y. Clark # @@ -44,13 +44,17 @@ returns the database structure. use strict; use Class::Base; +use SQL::Translator::Schema::Constants; +use SQL::Translator::Schema::Procedure; use SQL::Translator::Schema::Table; +use SQL::Translator::Schema::Trigger; use SQL::Translator::Schema::View; +use SQL::Translator::Utils 'parse_list_arg'; use base 'Class::Base'; -use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER ]; +use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER $PROC_ORDER ]; -$VERSION = 1.00; +$VERSION = sprintf "%d.%02d", q$Revision: 1.12 $ =~ /(\d+)\.(\d+)/; # ---------------------------------------------------------------------- sub init { @@ -85,10 +89,9 @@ 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_foo = $schema->add_table( name => 'foo' ) or die $schema->error; - - my $table_bar = SQL::Translator::Schema::Table->new( name => 'bar' ); - $table_bar = $schema->add_table( $table_bar ) or die $schema->error; + 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 @@ -121,6 +124,104 @@ not be created. } # ---------------------------------------------------------------------- +sub add_procedure { + +=pod + +=head2 add_procedure + +Add a procedure object. Returns the new +SQL::Translator::Schema::Procedure object. The "name" parameter is +required. If you try to create a procedure with the same name as an +existing procedure, you will get an error and the procedure will not +be created. + + my $p1 = $schema->add_procedure( name => 'foo' ); + my $p2 = SQL::Translator::Schema::Procedure->new( name => 'bar' ); + $p2 = $schema->add_procedure( $procedure_bar ) or die $schema->error; + +=cut + + my $self = shift; + my $procedure_class = 'SQL::Translator::Schema::Procedure'; + my $procedure; + + if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) { + $procedure = shift; + $procedure->schema( $self ); + } + else { + my %args = @_; + $args{'schema'} = $self; + return $self->error('No procedure name') unless $args{'name'}; + $procedure = $procedure_class->new( \%args ) or + return $self->error( $procedure_class->error ); + } + + $procedure->order( ++$PROC_ORDER ); + my $procedure_name = $procedure->name or return + $self->error('No procedure name'); + + if ( defined $self->{'procedures'}{ $procedure_name } ) { + return $self->error( + qq[Can't create procedure: "$procedure_name" exists] + ); + } + else { + $self->{'procedures'}{ $procedure_name } = $procedure; + } + + return $procedure; +} + +# ---------------------------------------------------------------------- +sub add_trigger { + +=pod + +=head2 add_trigger + +Add a trigger object. Returns the new SQL::Translator::Schema::Trigger object. +The "name" parameter is required. If you try to create a trigger with the +same name as an existing trigger, you will get an error and the trigger will +not be created. + + my $t1 = $schema->add_trigger( name => 'foo' ); + my $t2 = SQL::Translator::Schema::Trigger->new( name => 'bar' ); + $t2 = $schema->add_trigger( $trigger_bar ) or die $schema->error; + +=cut + + my $self = shift; + my $trigger_class = 'SQL::Translator::Schema::Trigger'; + my $trigger; + + if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) { + $trigger = shift; + $trigger->schema( $self ); + } + else { + my %args = @_; + $args{'schema'} = $self; + return $self->error('No trigger name') unless $args{'name'}; + $trigger = $trigger_class->new( \%args ) or + return $self->error( $trigger_class->error ); + } + + $trigger->order( ++$TRIGGER_ORDER ); + my $trigger_name = $trigger->name or return $self->error('No trigger name'); + + if ( defined $self->{'triggers'}{ $trigger_name } ) { + return $self->error(qq[Can't create trigger: "$trigger_name" exists]); + } + else { + $self->{'triggers'}{ $trigger_name } = $trigger; + } + + return $trigger; +} + +# ---------------------------------------------------------------------- sub add_view { =pod @@ -132,10 +233,9 @@ 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_foo = $schema->add_view( name => 'foo' ); - - my $view_bar = SQL::Translator::Schema::View->new( name => 'bar' ); - $view_bar = $schema->add_view( $view_bar ) or die $schema->error; + 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 @@ -145,9 +245,11 @@ not be created. if ( UNIVERSAL::isa( $_[0], $view_class ) ) { $view = shift; + $view->schema( $self ); } else { my %args = @_; + $args{'schema'} = $self; return $self->error('No view name') unless $args{'name'}; $view = $view_class->new( \%args ) or return $view_class->error; } @@ -208,6 +310,55 @@ Returns true if all the tables and views are valid. } # ---------------------------------------------------------------------- +sub get_procedure { + +=pod + +=head2 get_procedure + +Returns a procedure by the name provided. + + my $procedure = $schema->get_procedure('foo'); + +=cut + + my $self = shift; + my $procedure_name = shift or return $self->error('No procedure name'); + return $self->error( qq[Table "$procedure_name" does not exist] ) unless + exists $self->{'procedures'}{ $procedure_name }; + return $self->{'procedures'}{ $procedure_name }; +} + +# ---------------------------------------------------------------------- +sub get_procedures { + +=pod + +=head2 get_procedures + +Returns all the procedures as an array or array reference. + + my @procedures = $schema->get_procedures; + +=cut + + my $self = shift; + my @procedures = + map { $_->[1] } + sort { $a->[0] <=> $b->[0] } + map { [ $_->order, $_ ] } + values %{ $self->{'procedures'} }; + + if ( @procedures ) { + return wantarray ? @procedures : \@procedures; + } + else { + $self->error('No procedures'); + return wantarray ? () : undef; + } +} + +# ---------------------------------------------------------------------- sub get_table { =pod @@ -257,6 +408,55 @@ Returns all the tables as an array or array reference. } # ---------------------------------------------------------------------- +sub get_trigger { + +=pod + +=head2 get_trigger + +Returns a trigger by the name provided. + + my $trigger = $schema->get_trigger('foo'); + +=cut + + my $self = shift; + my $trigger_name = shift or return $self->error('No trigger name'); + return $self->error( qq[Table "$trigger_name" does not exist] ) unless + exists $self->{'triggers'}{ $trigger_name }; + return $self->{'triggers'}{ $trigger_name }; +} + +# ---------------------------------------------------------------------- +sub get_triggers { + +=pod + +=head2 get_triggers + +Returns all the triggers as an array or array reference. + + my @triggers = $schema->get_triggers; + +=cut + + my $self = shift; + my @triggers = + map { $_->[1] } + sort { $a->[0] <=> $b->[0] } + map { [ $_->order, $_ ] } + values %{ $self->{'triggers'} }; + + if ( @triggers ) { + return wantarray ? @triggers : \@triggers; + } + else { + $self->error('No triggers'); + return wantarray ? () : undef; + } +} + +# ---------------------------------------------------------------------- sub get_view { =pod @@ -306,6 +506,79 @@ 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