X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FSchema%2FTable.pm;h=38c7ffef9595e70767724f5d6c05b6ff321ba5c2;hb=0fb585899446745386bc9b9233bdde168798f83d;hp=35f51f67bd11bfa39924305cfb04eb7723c9beaf;hpb=870024f3994d5f763ab80c6e6e18fec2d9b05c25;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Schema/Table.pm b/lib/SQL/Translator/Schema/Table.pm index 35f51f6..38c7ffe 100644 --- a/lib/SQL/Translator/Schema/Table.pm +++ b/lib/SQL/Translator/Schema/Table.pm @@ -1,25 +1,5 @@ package SQL::Translator::Schema::Table; -# ---------------------------------------------------------------------- -# $Id: Table.pm,v 1.18 2003-08-29 14:54:01 kycl4rk Exp $ -# ---------------------------------------------------------------------- -# Copyright (C) 2003 Ken Y. Clark -# -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License as -# published by the Free Software Foundation; version 2. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA -# 02111-1307 USA -# ------------------------------------------------------------------- - =pod =head1 NAME @@ -31,7 +11,7 @@ SQL::Translator::Schema::Table - SQL::Translator table object use SQL::Translator::Schema::Table; my $table = SQL::Translator::Schema::Table->new( name => 'foo' ); -=head1 DESCSIPTION +=head1 DESCRIPTION C is the table object. @@ -39,22 +19,30 @@ C is the table object. =cut -use strict; -use Class::Base; -use SQL::Translator::Utils 'parse_list_arg'; +use Moo; +use SQL::Translator::Utils qw(parse_list_arg ex2err throw); +use SQL::Translator::Types qw(schema_obj); +use SQL::Translator::Role::ListAttr; use SQL::Translator::Schema::Constants; use SQL::Translator::Schema::Constraint; use SQL::Translator::Schema::Field; use SQL::Translator::Schema::Index; -use Data::Dumper; -use base 'Class::Base'; -use vars qw( $VERSION $FIELD_ORDER ); +use Carp::Clan '^SQL::Translator'; +use List::Util 'max'; + +extends 'SQL::Translator::Schema::Object'; -$VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/; +our $VERSION = '1.59'; -# ---------------------------------------------------------------------- -sub init { +# Stringify to our name, being careful not to pass any args through so we don't +# accidentally set it to undef. We also have to tweak bool so the object is +# still true when it doesn't have a name (which shouldn't happen!). +use overload + '""' => sub { shift->name }, + 'bool' => sub { $_[0]->name || $_[0] }, + fallback => 1, +; =pod @@ -62,31 +50,14 @@ sub init { Object constructor. - my $table = SQL::Translator::Schema::Table->new( + my $table = SQL::Translator::Schema::Table->new( schema => $schema, name => 'foo', ); -=cut - - my ( $self, $config ) = @_; - - for my $arg ( qw[ schema name comments ] ) { - next unless defined $config->{ $arg }; - defined $self->$arg( $config->{ $arg } ) or return; - } - - return $self; -} - -# ---------------------------------------------------------------------- -sub add_constraint { - -=pod - =head2 add_constraint -Add a constraint to the table. Returns the newly created +Add a constraint to the table. Returns the newly created C object. my $c1 = $table->add_constraint( @@ -100,6 +71,15 @@ C object. =cut +has _constraints => ( + is => 'ro', + init_arg => undef, + default => sub { +[] }, + predicate => 1, + lazy => 1, +); + +sub add_constraint { my $self = shift; my $constraint_class = 'SQL::Translator::Schema::Constraint'; my $constraint; @@ -111,8 +91,8 @@ C object. else { my %args = @_; $args{'table'} = $self; - $constraint = $constraint_class->new( \%args ) or - return $self->error( $constraint_class->error ); + $constraint = $constraint_class->new( \%args ) or + return $self->error( $constraint_class->error ); } # @@ -123,6 +103,9 @@ C object. my $pk = $self->primary_key; if ( $pk && $constraint->type eq PRIMARY_KEY ) { $self->primary_key( $constraint->fields ); + $pk->name($constraint->name) if $constraint->name; + my %extra = $constraint->extra; + $pk->extra(%extra) if keys %extra; $constraint = $pk; $ok = 0; } @@ -134,38 +117,66 @@ C object. } } # - # See if another constraint of the same type - # covers the same fields. + # See if another constraint of the same type + # covers the same fields. -- This doesn't work! ky # - elsif ( $constraint->type ne CHECK_C ) { - my @field_names = $constraint->fields; - for my $c ( - grep { $_->type eq $constraint->type } - $self->get_constraints - ) { - my %fields = map { $_, 1 } $c->fields; - for my $field_name ( @field_names ) { - if ( $fields{ $field_name } ) { - $constraint = $c; - $ok = 0; - last; - } - } - last unless $ok; - } - } +# elsif ( $constraint->type ne CHECK_C ) { +# my @field_names = $constraint->fields; +# for my $c ( +# grep { $_->type eq $constraint->type } +# $self->get_constraints +# ) { +# my %fields = map { $_, 1 } $c->fields; +# for my $field_name ( @field_names ) { +# if ( $fields{ $field_name } ) { +# $constraint = $c; +# $ok = 0; +# last; +# } +# } +# last unless $ok; +# } +# } if ( $ok ) { - push @{ $self->{'constraints'} }, $constraint; + push @{ $self->_constraints }, $constraint; } return $constraint; } -# ---------------------------------------------------------------------- -sub add_index { +=head2 drop_constraint -=pod +Remove a constraint from the table. Returns the constraint object if the index +was found and removed, an error otherwise. The single parameter can be either +an index name or an C object. + + $table->drop_constraint('myconstraint'); + +=cut + +sub drop_constraint { + my $self = shift; + my $constraint_class = 'SQL::Translator::Schema::Constraint'; + my $constraint_name; + + if ( UNIVERSAL::isa( $_[0], $constraint_class ) ) { + $constraint_name = shift->name; + } + else { + $constraint_name = shift; + } + + if ( ! ($self->_has_constraints && grep { $_->name eq $constraint_name } @ { $self->_constraints }) ) { + return $self->error(qq[Can't drop constraint: "$constraint_name" doesn't exist]); + } + + my @cs = @{ $self->_constraints }; + my ($constraint_id) = grep { $cs[$_]->name eq $constraint_name } (0..$#cs); + my $constraint = splice(@{$self->_constraints}, $constraint_id, 1); + + return $constraint; +} =head2 add_index @@ -183,6 +194,15 @@ C object. =cut +has _indices => ( + is => 'ro', + init_arg => undef, + default => sub { [] }, + predicate => 1, + lazy => 1, +); + +sub add_index { my $self = shift; my $index_class = 'SQL::Translator::Schema::Index'; my $index; @@ -194,24 +214,54 @@ C object. else { my %args = @_; $args{'table'} = $self; - $index = $index_class->new( \%args ) or return + $index = $index_class->new( \%args ) or return $self->error( $index_class->error ); } - - push @{ $self->{'indices'} }, $index; + foreach my $ex_index ($self->get_indices) { + return if ($ex_index->equals($index)); + } + push @{ $self->_indices }, $index; return $index; } -# ---------------------------------------------------------------------- -sub add_field { +=head2 drop_index -=pod +Remove an index from the table. Returns the index object if the index was +found and removed, an error otherwise. The single parameter can be either +an index name of an C object. + + $table->drop_index('myindex'); + +=cut + +sub drop_index { + my $self = shift; + my $index_class = 'SQL::Translator::Schema::Index'; + my $index_name; + + if ( UNIVERSAL::isa( $_[0], $index_class ) ) { + $index_name = shift->name; + } + else { + $index_name = shift; + } + + if ( ! ($self->_has_indices && grep { $_->name eq $index_name } @{ $self->_indices }) ) { + return $self->error(qq[Can't drop index: "$index_name" doesn't exist]); + } + + my @is = @{ $self->_indices }; + my ($index_id) = grep { $is[$_]->name eq $index_name } (0..$#is); + my $index = splice(@{$self->_indices}, $index_id, 1); + + return $index; +} =head2 add_field Add an field to the table. Returns the newly created -C object. The "name" parameter is -required. If you try to create a field with the same name as an +C object. The "name" parameter is +required. If you try to create a field with the same name as an existing field, you will get an error and the field will not be created. my $f1 = $table->add_field( @@ -220,14 +270,23 @@ existing field, you will get an error and the field will not be created. size => 11, ); - my $f2 = SQL::Translator::Schema::Field->new( - name => 'name', + my $f2 = SQL::Translator::Schema::Field->new( + name => 'name', table => $table, ); $f2 = $table->add_field( $field2 ) or die $table->error; =cut +has _fields => ( + is => 'ro', + init_arg => undef, + default => sub { +{} }, + predicate => 1, + lazy => 1 +); + +sub add_field { my $self = shift; my $field_class = 'SQL::Translator::Schema::Field'; my $field; @@ -239,31 +298,100 @@ existing field, you will get an error and the field will not be created. else { my %args = @_; $args{'table'} = $self; - $field = $field_class->new( \%args ) or return + $field = $field_class->new( \%args ) or return $self->error( $field_class->error ); } - $field->order( ++$FIELD_ORDER ); - my $field_name = $field->name or return $self->error('No name'); + my $existing_order = { map { $_->order => $_->name } $self->get_fields }; + + # supplied order, possible unordered assembly + if ( $field->order ) { + if($existing_order->{$field->order}) { + croak sprintf + "Requested order '%d' for column '%s' conflicts with already existing column '%s'", + $field->order, + $field->name, + $existing_order->{$field->order}, + ; + } + } + else { + my $last_field_no = max(keys %$existing_order) || 0; + if ( $last_field_no != scalar keys %$existing_order ) { + croak sprintf + "Table '%s' field order incomplete - unable to auto-determine order for newly added field", + $self->name, + ; + } - if ( exists $self->{'fields'}{ $field_name } ) { - return $self->error(qq[Can't create field: "$field_name" exists]); + $field->order( $last_field_no + 1 ); + } + + # We know we have a name as the Field->new above errors if none given. + my $field_name = $field->name; + + if ( $self->get_field($field_name) ) { + return $self->error(qq[Can't use field name "$field_name": field exists]); } else { - $self->{'fields'}{ $field_name } = $field; + $self->_fields->{ $field_name } = $field; } return $field; } -# ---------------------------------------------------------------------- -sub comments { +=head2 drop_field -=pod +Remove a field from the table. Returns the field object if the field was +found and removed, an error otherwise. The single parameter can be either +a field name or an C object. + + $table->drop_field('myfield'); + +=cut + +sub drop_field { + my $self = shift; + my $field_class = 'SQL::Translator::Schema::Field'; + my $field_name; + + if ( UNIVERSAL::isa( $_[0], $field_class ) ) { + $field_name = shift->name; + } + else { + $field_name = shift; + } + my %args = @_; + my $cascade = $args{'cascade'}; + + if ( ! ($self->_has_fields && exists $self->_fields->{ $field_name } ) ) { + return $self->error(qq[Can't drop field: "$field_name" doesn't exists]); + } + + my $field = delete $self->_fields->{ $field_name }; + + if ( $cascade ) { + # Remove this field from all indices using it + foreach my $i ($self->get_indices()) { + my @fs = $i->fields(); + @fs = grep { $_ ne $field->name } @fs; + $i->fields(@fs); + } + + # Remove this field from all constraints using it + foreach my $c ($self->get_constraints()) { + my @cs = $c->fields(); + @cs = grep { $_ ne $field->name } @cs; + $c->fields(@cs); + } + } + + return $field; +} =head2 comments -Get or set the comments on a table. May be called several times to +Get or set the comments on a table. May be called several times to set and it will accumulate the comments. Called in an array context, returns each comment individually; called in a scalar context, returns all the comments joined on newlines. @@ -274,29 +402,27 @@ all the comments joined on newlines. =cut +has comments => ( + is => 'rw', + coerce => sub { ref($_[0]) eq 'ARRAY' ? $_[0] : [$_[0]] }, + default => sub { [] }, +); + +around comments => sub { + my $orig = shift; my $self = shift; my @comments = ref $_[0] ? @{ $_[0] } : @_; for my $arg ( @comments ) { $arg = $arg->[0] if ref $arg; - push @{ $self->{'comments'} }, $arg if defined $arg && $arg; + push @{ $self->$orig }, $arg if defined $arg && $arg; } - if ( @{ $self->{'comments'} || [] } ) { - return wantarray - ? @{ $self->{'comments'} } - : join( "\n", @{ $self->{'comments'} } ) - ; - } - else { - return wantarray ? () : undef; - } -} - -# ---------------------------------------------------------------------- -sub get_constraints { - -=pod + @comments = @{$self->$orig}; + return wantarray ? @comments + : @comments ? join( "\n", @comments ) + : undef; +}; =head2 get_constraints @@ -306,11 +432,12 @@ Returns all the constraint objects as an array or array reference. =cut +sub get_constraints { my $self = shift; - if ( ref $self->{'constraints'} ) { - return wantarray - ? @{ $self->{'constraints'} } : $self->{'constraints'}; + if ( $self->_has_constraints ) { + return wantarray + ? @{ $self->_constraints } : $self->_constraints; } else { $self->error('No constraints'); @@ -318,11 +445,6 @@ Returns all the constraint objects as an array or array reference. } } -# ---------------------------------------------------------------------- -sub get_indices { - -=pod - =head2 get_indices Returns all the index objects as an array or array reference. @@ -331,12 +453,13 @@ Returns all the index objects as an array or array reference. =cut +sub get_indices { my $self = shift; - if ( ref $self->{'indices'} ) { - return wantarray - ? @{ $self->{'indices'} } - : $self->{'indices'}; + if ( $self->_has_indices ) { + return wantarray + ? @{ $self->_indices } + : $self->_indices; } else { $self->error('No indices'); @@ -344,11 +467,6 @@ Returns all the index objects as an array or array reference. } } -# ---------------------------------------------------------------------- -sub get_field { - -=pod - =head2 get_field Returns a field by the name provided. @@ -357,18 +475,24 @@ Returns a field by the name provided. =cut +sub get_field { my $self = shift; my $field_name = shift or return $self->error('No field name'); + my $case_insensitive = shift; + return $self->error(qq[Field "$field_name" does not exist]) + unless $self->_has_fields; + if ( $case_insensitive ) { + $field_name = uc($field_name); + foreach my $field ( keys %{$self->_fields} ) { + return $self->_fields->{$field} if $field_name eq uc($field); + } + return $self->error(qq[Field "$field_name" does not exist]); + } return $self->error( qq[Field "$field_name" does not exist] ) unless - exists $self->{'fields'}{ $field_name }; - return $self->{'fields'}{ $field_name }; + exists $self->_fields->{ $field_name }; + return $self->_fields->{ $field_name }; } -# ---------------------------------------------------------------------- -sub get_fields { - -=pod - =head2 get_fields Returns all the field objects as an array or array reference. @@ -377,12 +501,13 @@ Returns all the field objects as an array or array reference. =cut +sub get_fields { my $self = shift; - my @fields = + my @fields = map { $_->[1] } sort { $a->[0] <=> $b->[0] } map { [ $_->order, $_ ] } - values %{ $self->{'fields'} || {} }; + values %{ $self->_has_fields ? $self->_fields : {} }; if ( @fields ) { return wantarray ? @fields : \@fields; @@ -393,11 +518,6 @@ Returns all the field objects as an array or array reference. } } -# ---------------------------------------------------------------------- -sub is_valid { - -=pod - =head2 is_valid Determine whether the view is valid or not. @@ -406,12 +526,13 @@ Determine whether the view is valid or not. =cut +sub is_valid { my $self = shift; return $self->error('No name') unless $self->name; return $self->error('No fields') unless $self->get_fields; - for my $object ( - $self->get_fields, $self->get_indices, $self->get_constraints + for my $object ( + $self->get_fields, $self->get_indices, $self->get_constraints ) { return $object->error unless $object->is_valid; } @@ -419,35 +540,54 @@ Determine whether the view is valid or not. return 1; } -# ---------------------------------------------------------------------- -sub is_data { +=head2 is_trivial_link -=pod +True if table has no data (non-key) fields and only uses single key joins. + +=cut + +has is_trivial_link => ( is => 'lazy', init_arg => undef ); + +sub _build_is_trivial_link { + my $self = shift; + return 0 if $self->is_data; + + my %fk = (); + + foreach my $field ( $self->get_fields ) { + next unless $field->is_foreign_key; + $fk{$field->foreign_key_reference->reference_table}++; + } + + foreach my $referenced (keys %fk){ + if($fk{$referenced} > 1){ + return 0; + } + } + + return 1; +} =head2 is_data +Returns true if the table has some non-key fields. + =cut - my $self = shift; - return $self->{'is_data'} if defined $self->{'is_data'}; +has is_data => ( is => 'lazy', init_arg => undef ); - $self->{'is_data'} = 0; +sub _build_is_data { + my $self = shift; foreach my $field ( $self->get_fields ) { if ( !$field->is_primary_key and !$field->is_foreign_key ) { - $self->{'is_data'} = 1; - return $self->{'is_data'}; + return 1; } } - return $self->{'is_data'}; + return 0; } -# ---------------------------------------------------------------------- -sub can_link { - -=pod - =head2 can_link Determine whether the table can link two arg tables via many-to-many. @@ -456,15 +596,18 @@ Determine whether the table can link two arg tables via many-to-many. =cut +has _can_link => ( is => 'ro', init_arg => undef, default => sub { +{} } ); + +sub can_link { my ( $self, $table1, $table2 ) = @_; - return $self->{'can_link'}{ $table1->name }{ $table2->name } - if defined $self->{'can_link'}{ $table1->name }{ $table2->name }; + return $self->_can_link->{ $table1->name }{ $table2->name } + if defined $self->_can_link->{ $table1->name }{ $table2->name }; if ( $self->is_data == 1 ) { - $self->{'can_link'}{ $table1->name }{ $table2->name } = [0]; - $self->{'can_link'}{ $table2->name }{ $table1->name } = [0]; - return $self->{'can_link'}{ $table1->name }{ $table2->name }; + $self->_can_link->{ $table1->name }{ $table2->name } = [0]; + $self->_can_link->{ $table2->name }{ $table1->name } = [0]; + return $self->_can_link->{ $table1->name }{ $table2->name }; } my %fk = (); @@ -478,40 +621,40 @@ Determine whether the table can link two arg tables via many-to-many. if ( !defined( $fk{ $table1->name } ) or !defined( $fk{ $table2->name } ) ) { - $self->{'can_link'}{ $table1->name }{ $table2->name } = [0]; - $self->{'can_link'}{ $table2->name }{ $table1->name } = [0]; - return $self->{'can_link'}{ $table1->name }{ $table2->name }; + $self->_can_link->{ $table1->name }{ $table2->name } = [0]; + $self->_can_link->{ $table2->name }{ $table1->name } = [0]; + return $self->_can_link->{ $table1->name }{ $table2->name }; } # trivial traversal, only one way to link the two tables if ( scalar( @{ $fk{ $table1->name } } == 1 ) and scalar( @{ $fk{ $table2->name } } == 1 ) ) { - $self->{'can_link'}{ $table1->name }{ $table2->name } = + $self->_can_link->{ $table1->name }{ $table2->name } = [ 'one2one', $fk{ $table1->name }, $fk{ $table2->name } ]; - $self->{'can_link'}{ $table1->name }{ $table2->name } = + $self->_can_link->{ $table1->name }{ $table2->name } = [ 'one2one', $fk{ $table2->name }, $fk{ $table1->name } ]; - # non-trivial traversal. one way to link table2, + # non-trivial traversal. one way to link table2, # many ways to link table1 } elsif ( scalar( @{ $fk{ $table1->name } } > 1 ) and scalar( @{ $fk{ $table2->name } } == 1 ) ) { - $self->{'can_link'}{ $table1->name }{ $table2->name } = + $self->_can_link->{ $table1->name }{ $table2->name } = [ 'many2one', $fk{ $table1->name }, $fk{ $table2->name } ]; - $self->{'can_link'}{ $table2->name }{ $table1->name } = + $self->_can_link->{ $table2->name }{ $table1->name } = [ 'one2many', $fk{ $table2->name }, $fk{ $table1->name } ]; - # non-trivial traversal. one way to link table1, + # non-trivial traversal. one way to link table1, # many ways to link table2 } elsif ( scalar( @{ $fk{ $table1->name } } == 1 ) and scalar( @{ $fk{ $table2->name } } > 1 ) ) { - $self->{'can_link'}{ $table1->name }{ $table2->name } = + $self->_can_link->{ $table1->name }{ $table2->name } = [ 'one2many', $fk{ $table1->name }, $fk{ $table2->name } ]; - $self->{'can_link'}{ $table2->name }{ $table1->name } = + $self->_can_link->{ $table2->name }{ $table1->name } = [ 'many2one', $fk{ $table2->name }, $fk{ $table1->name } ]; # non-trivial traversal. many ways to link table1 and table2 @@ -519,55 +662,54 @@ Determine whether the table can link two arg tables via many-to-many. elsif ( scalar( @{ $fk{ $table1->name } } > 1 ) and scalar( @{ $fk{ $table2->name } } > 1 ) ) { - $self->{'can_link'}{ $table1->name }{ $table2->name } = + $self->_can_link->{ $table1->name }{ $table2->name } = [ 'many2many', $fk{ $table1->name }, $fk{ $table2->name } ]; - $self->{'can_link'}{ $table2->name }{ $table1->name } = + $self->_can_link->{ $table2->name }{ $table1->name } = [ 'many2many', $fk{ $table2->name }, $fk{ $table1->name } ]; - # one of the tables didn't export a key + # one of the tables didn't export a key # to this table, no linking possible } else { - $self->{'can_link'}{ $table1->name }{ $table2->name } = [0]; - $self->{'can_link'}{ $table2->name }{ $table1->name } = [0]; + $self->_can_link->{ $table1->name }{ $table2->name } = [0]; + $self->_can_link->{ $table2->name }{ $table1->name } = [0]; } - return $self->{'can_link'}{ $table1->name }{ $table2->name }; + return $self->_can_link->{ $table1->name }{ $table2->name }; } -# ---------------------------------------------------------------------- -sub name { - -=pod - =head2 name Get or set the table's name. -If provided an argument, checks the schema object for a table of -that name and disallows the change if one exists. +Errors ("No table name") if you try to set a blank name. + +If provided an argument, checks the schema object for a table of +that name and disallows the change if one exists (setting the error to +"Can't use table name "%s": table exists"). my $table_name = $table->name('foo'); =cut +has name => ( + is => 'rw', + isa => sub { throw("No table name") unless $_[0] }, +); + +around name => sub { + my $orig = shift; my $self = shift; - if ( my $arg = shift ) { + if ( my ($arg) = @_ ) { if ( my $schema = $self->schema ) { return $self->error( qq[Can't use table name "$arg": table exists] ) if $schema->get_table( $arg ); } - $self->{'name'} = $arg; } - return $self->{'name'} || ''; -} - -# ---------------------------------------------------------------------- -sub schema { - -=pod + return ex2err($orig, $self, @_); +}; =head2 schema @@ -577,17 +719,10 @@ Get or set the table's schema object. =cut - my $self = shift; - if ( my $arg = shift ) { - return $self->error('Not a schema object') unless - UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' ); - $self->{'schema'} = $arg; - } +has schema => ( is => 'rw', isa => schema_obj('Schema'), weak_ref => 1 ); - return $self->{'schema'}; -} +around schema => \&ex2err; -# ---------------------------------------------------------------------- sub primary_key { =pod @@ -620,7 +755,7 @@ These are eqivalent: my $constraint; if ( @$fields ) { for my $f ( @$fields ) { - return $self->error(qq[Invalid field "$f"]) unless + return $self->error(qq[Invalid field "$f"]) unless $self->get_field($f); } @@ -630,7 +765,7 @@ These are eqivalent: $has_pk = 1; $c->fields( @{ $c->fields }, @$fields ); $constraint = $c; - } + } } unless ( $has_pk ) { @@ -653,11 +788,6 @@ These are eqivalent: return; } -# ---------------------------------------------------------------------- -sub options { - -=pod - =head2 options Get or set the table's options (e.g., table types for MySQL). Returns @@ -667,59 +797,237 @@ an array or array reference. =cut - my $self = shift; - my $options = parse_list_arg( @_ ); +with ListAttr options => ( append => 1 ); - push @{ $self->{'options'} }, @$options; +=head2 order - if ( ref $self->{'options'} ) { - return wantarray ? @{ $self->{'options'} || [] } : $self->{'options'}; +Get or set the table's order. + + my $order = $table->order(3); + +=cut + +has order => ( is => 'rw', default => sub { 0 } ); + +around order => sub { + my ( $orig, $self, $arg ) = @_; + + if ( defined $arg && $arg =~ /^\d+$/ ) { + return $self->$orig($arg); + } + + return $self->$orig; +}; + +=head2 field_names + +Read-only method to return a list or array ref of the field names. Returns undef +or an empty list if the table has no fields set. Useful if you want to +avoid the overload magic of the Field objects returned by the get_fields method. + + my @names = $constraint->field_names; + +=cut + +sub field_names { + my $self = shift; + my @fields = + map { $_->name } + $self->get_fields; + + if ( @fields ) { + return wantarray ? @fields : \@fields; } else { - return wantarray ? () : []; + $self->error('No fields'); + return wantarray ? () : undef; } } -# ---------------------------------------------------------------------- -sub order { +sub equals { =pod -=head2 order +=head2 equals -Get or set the table's order. +Determines if this table is the same as another - my $order = $table->order(3); + my $isIdentical = $table1->equals( $table2 ); =cut - my ( $self, $arg ) = @_; + my $self = shift; + my $other = shift; + my $case_insensitive = shift; - if ( defined $arg && $arg =~ /^\d+$/ ) { - $self->{'order'} = $arg; + return 0 unless $self->SUPER::equals($other); + return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name; + return 0 unless $self->_compare_objects(scalar $self->options, scalar $other->options); + return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra); + + # Fields + # Go through our fields + my %checkedFields; + foreach my $field ( $self->get_fields ) { + my $otherField = $other->get_field($field->name, $case_insensitive); + return 0 unless $field->equals($otherField, $case_insensitive); + $checkedFields{$field->name} = 1; + } + # Go through the other table's fields + foreach my $otherField ( $other->get_fields ) { + next if $checkedFields{$otherField->name}; + return 0; + } + + # Constraints + # Go through our constraints + my %checkedConstraints; +CONSTRAINT: + foreach my $constraint ( $self->get_constraints ) { + foreach my $otherConstraint ( $other->get_constraints ) { + if ( $constraint->equals($otherConstraint, $case_insensitive) ) { + $checkedConstraints{$otherConstraint} = 1; + next CONSTRAINT; + } + } + return 0; + } + # Go through the other table's constraints +CONSTRAINT2: + foreach my $otherConstraint ( $other->get_constraints ) { + next if $checkedFields{$otherConstraint}; + foreach my $constraint ( $self->get_constraints ) { + if ( $otherConstraint->equals($constraint, $case_insensitive) ) { + next CONSTRAINT2; + } + } + return 0; + } + + # Indices + # Go through our indices + my %checkedIndices; +INDEX: + foreach my $index ( $self->get_indices ) { + foreach my $otherIndex ( $other->get_indices ) { + if ( $index->equals($otherIndex, $case_insensitive) ) { + $checkedIndices{$otherIndex} = 1; + next INDEX; + } + } + return 0; + } + # Go through the other table's indices +INDEX2: + foreach my $otherIndex ( $other->get_indices ) { + next if $checkedIndices{$otherIndex}; + foreach my $index ( $self->get_indices ) { + if ( $otherIndex->equals($index, $case_insensitive) ) { + next INDEX2; + } + } + return 0; } - return $self->{'order'} || 0; + return 1; } -# ---------------------------------------------------------------------- -sub DESTROY { - my $self = shift; - undef $self->{'schema'}; # destroy cyclical reference - undef $_ for @{ $self->{'constraints'} }; - undef $_ for @{ $self->{'indices'} }; - undef $_ for values %{ $self->{'fields'} }; +=head1 LOOKUP METHODS + +The following are a set of shortcut methods for getting commonly used lists of +fields and constraints. They all return lists or array refs of Field or +Constraint objects. + +=over 4 + +=item pkey_fields + +The primary key fields. + +=item fkey_fields + +All foreign key fields. + +=item nonpkey_fields + +All the fields except the primary key. + +=item data_fields + +All non key fields. + +=item unique_fields + +All fields with unique constraints. + +=item unique_constraints + +All this tables unique constraints. + +=item fkey_constraints + +All this tables foreign key constraints. (See primary_key method to get the +primary key constraint) + +=back + +=cut + +sub pkey_fields { + my $me = shift; + my @fields = grep { $_->is_primary_key } $me->get_fields; + return wantarray ? @fields : \@fields; } -1; +sub fkey_fields { + my $me = shift; + my @fields; + push @fields, $_->fields foreach $me->fkey_constraints; + return wantarray ? @fields : \@fields; +} + +sub nonpkey_fields { + my $me = shift; + my @fields = grep { !$_->is_primary_key } $me->get_fields; + return wantarray ? @fields : \@fields; +} + +sub data_fields { + my $me = shift; + my @fields = + grep { !$_->is_foreign_key and !$_->is_primary_key } $me->get_fields; + return wantarray ? @fields : \@fields; +} + +sub unique_fields { + my $me = shift; + my @fields; + push @fields, $_->fields foreach $me->unique_constraints; + return wantarray ? @fields : \@fields; +} + +sub unique_constraints { + my $me = shift; + my @cons = grep { $_->type eq UNIQUE } $me->get_constraints; + return wantarray ? @cons : \@cons; +} -# ---------------------------------------------------------------------- +sub fkey_constraints { + my $me = shift; + my @cons = grep { $_->type eq FOREIGN_KEY } $me->get_constraints; + return wantarray ? @cons : \@cons; +} + +# Must come after all 'has' declarations +around new => \&ex2err; + +1; =pod =head1 AUTHORS -Ken Y. Clark Ekclark@cpan.orgE, +Ken Youens-Clark Ekclark@cpan.orgE, Allen Day Eallenday@ucla.eduE. =cut