X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FSchema%2FIndex.pm;h=7e04811b22547b1ac96962946bd494a41850d92b;hb=4ab3763d2ad756c236b757306989cafa08e7f35e;hp=3ee0e4c32aee5239610a992cedc6d0f533591e5d;hpb=3c5de62a52d2d49bd3de3768d6f649565fa620e9;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Schema/Index.pm b/lib/SQL/Translator/Schema/Index.pm index 3ee0e4c..7e04811 100644 --- a/lib/SQL/Translator/Schema/Index.pm +++ b/lib/SQL/Translator/Schema/Index.pm @@ -1,9 +1,7 @@ package SQL::Translator::Schema::Index; # ---------------------------------------------------------------------- -# $Id: Index.pm,v 1.1 2003-05-01 04:25:00 kycl4rk Exp $ -# ---------------------------------------------------------------------- -# Copyright (C) 2003 Ken Y. Clark +# Copyright (C) 2002-2009 SQLFairy Authors # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License as @@ -39,28 +37,34 @@ SQL::Translator::Schema::Index - SQL::Translator index object C is the index object. -Primary keys will be considered table constraints, not indices. +Primary and unique keys are table constraints, not indices. =head1 METHODS =cut use strict; -use Class::Base; +use SQL::Translator::Schema::Constants; +use SQL::Translator::Utils 'parse_list_arg'; + +use base 'SQL::Translator::Schema::Object'; -use base 'Class::Base'; use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT); -$VERSION = 1.00; +$VERSION = '1.59'; -use constant VALID_TYPE => { - unique => 1, - normal => 1, - full_text => 1, # MySQL only (?) -}; +my %VALID_INDEX_TYPE = ( + UNIQUE => 1, + NORMAL => 1, + FULL_TEXT => 1, # MySQL only (?) + SPATIAL => 1, # MySQL only (?) +); # ---------------------------------------------------------------------- -sub init { + +__PACKAGE__->_attributes( qw/ + name type fields table options +/); =pod @@ -72,14 +76,6 @@ Object constructor. =cut - my ( $self, $config ) = @_; - for my $arg ( qw[ name type fields ] ) { - next unless $config->{ $arg }; - $self->$arg( $config->{ $arg } ) or return; - } - return $self; -} - # ---------------------------------------------------------------------- sub fields { @@ -87,24 +83,64 @@ sub fields { =head2 fields -Gets and set the fields the index is on. Accepts a list or arrayref, -return both, too. +Gets and set the fields the index is on. Accepts a string, list or +arrayref; returns an array or array reference. Will unique the field +names and keep them in order by the first occurrence of a field name. + + $index->fields('id'); + $index->fields('id', 'name'); + $index->fields( 'id, name' ); + $index->fields( [ 'id', 'name' ] ); + $index->fields( qw[ id name ] ); - my @fields = $index->fields( 'id' ); + my @fields = $index->fields; =cut my $self = shift; - my $fields = ref $_[0] eq 'ARRAY' ? shift : [ @_ ]; + my $fields = parse_list_arg( @_ ); if ( @$fields ) { - $self->{'fields'} = $fields; + my ( %unique, @unique ); + for my $f ( @$fields ) { + next if $unique{ $f }; + $unique{ $f } = 1; + push @unique, $f; + } + + $self->{'fields'} = \@unique; } return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'}; } # ---------------------------------------------------------------------- +sub is_valid { + +=pod + +=head2 is_valid + +Determine whether the index is valid or not. + + my $ok = $index->is_valid; + +=cut + + my $self = shift; + my $table = $self->table or return $self->error('No table'); + my @fields = $self->fields or return $self->error('No fields'); + + for my $field ( @fields ) { + return $self->error( + "Field '$field' does not exist in table '", $table->name, "'" + ) unless $table->get_field( $field ); + } + + return 1; +} + +# ---------------------------------------------------------------------- sub name { =pod @@ -123,6 +159,56 @@ Get or set the index's name. } # ---------------------------------------------------------------------- +sub options { + +=pod + +=head2 options + +Get or set the index's options (e.g., "using" or "where" for PG). Returns +an array or array reference. + + my @options = $index->options; + +=cut + + my $self = shift; + my $options = parse_list_arg( @_ ); + + push @{ $self->{'options'} }, @$options; + + if ( ref $self->{'options'} ) { + return wantarray ? @{ $self->{'options'} || [] } : $self->{'options'}; + } + else { + return wantarray ? () : []; + } +} + +# ---------------------------------------------------------------------- +sub table { + +=pod + +=head2 table + +Get or set the index's table object. + + my $table = $index->table; + +=cut + + my $self = shift; + if ( my $arg = shift ) { + return $self->error('Not a table object') unless + UNIVERSAL::isa( $arg, 'SQL::Translator::Schema::Table' ); + $self->{'table'} = $arg; + } + + return $self->{'table'}; +} + +# ---------------------------------------------------------------------- sub type { =pod @@ -133,35 +219,78 @@ Get or set the index's type. my $type = $index->type('unique'); +Get or set the index's options (e.g., "using" or "where" for PG). Returns + +Currently there are only four acceptable types: UNIQUE, NORMAL, FULL_TEXT, +and SPATIAL. The latter two might be MySQL-specific. While both lowercase +and uppercase types are acceptable input, this method returns the type in +uppercase. + =cut my $self = shift; - if ( my $type = shift ) { + if ( my $type = uc shift ) { return $self->error("Invalid index type: $type") - unless VALID_TYPE->{ $type }; + unless $VALID_INDEX_TYPE{ $type }; $self->{'type'} = $type; } - return $self->{'type'} || ''; + return $self->{'type'} || 'NORMAL'; } - # ---------------------------------------------------------------------- -sub is_valid { +sub equals { =pod -=head2 is_valid +=head2 equals -Determine whether the index is valid or not. +Determines if this index is the same as another - my $ok = $index->is_valid; + my $isIdentical = $index1->equals( $index2 ); =cut my $self = shift; - return ( $self->name && $self->{'type'} && @{ $self->fields } ) ? 1 : 0; + my $other = shift; + my $case_insensitive = shift; + my $ignore_index_names = shift; + + return 0 unless $self->SUPER::equals($other); + + unless ($ignore_index_names) { + unless ((!$self->name && ($other->name eq $other->fields->[0])) || + (!$other->name && ($self->name eq $self->fields->[0]))) { + return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name; + } + } + #return 0 unless $self->is_valid eq $other->is_valid; + return 0 unless $self->type eq $other->type; + + # Check fields, regardless of order + my %otherFields = (); # create a hash of the other fields + foreach my $otherField ($other->fields) { + $otherField = uc($otherField) if $case_insensitive; + $otherFields{$otherField} = 1; + } + foreach my $selfField ($self->fields) { # check for self fields in hash + $selfField = uc($selfField) if $case_insensitive; + return 0 unless $otherFields{$selfField}; + delete $otherFields{$selfField}; + } + # Check all other fields were accounted for + return 0 unless keys %otherFields == 0; + + return 0 unless $self->_compare_objects(scalar $self->options, scalar $other->options); + return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra); + return 1; +} + +# ---------------------------------------------------------------------- +sub DESTROY { + my $self = shift; + undef $self->{'table'}; # destroy cyclical reference } 1; @@ -172,6 +301,6 @@ Determine whether the index is valid or not. =head1 AUTHOR -Ken Y. Clark Ekclark@cpan.orgE +Ken Y. Clark Ekclark@cpan.orgE. =cut