1 package SQL::Translator::Schema::Index;
3 # ----------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
25 SQL::Translator::Schema::Index - SQL::Translator index object
29 use SQL::Translator::Schema::Index;
30 my $index = SQL::Translator::Schema::Index->new(
38 C<SQL::Translator::Schema::Index> is the index object.
40 Primary and unique keys are table constraints, not indices.
47 use SQL::Translator::Schema::Constants;
48 use SQL::Translator::Utils 'parse_list_arg';
50 use base 'SQL::Translator::Schema::Object';
52 use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
56 my %VALID_INDEX_TYPE = (
59 FULLTEXT => 1, # MySQL only (?)
60 FULL_TEXT => 1, # MySQL only (?)
61 SPATIAL => 1, # MySQL only (?)
64 # ----------------------------------------------------------------------
66 __PACKAGE__->_attributes( qw/
67 name type fields table options
76 my $schema = SQL::Translator::Schema::Index->new;
80 # ----------------------------------------------------------------------
87 Gets and set the fields the index is on. Accepts a string, list or
88 arrayref; returns an array or array reference. Will unique the field
89 names and keep them in order by the first occurrence of a field name.
92 $index->fields('id', 'name');
93 $index->fields( 'id, name' );
94 $index->fields( [ 'id', 'name' ] );
95 $index->fields( qw[ id name ] );
97 my @fields = $index->fields;
102 my $fields = parse_list_arg( @_ );
105 my ( %unique, @unique );
106 for my $f ( @$fields ) {
107 next if $unique{ $f };
112 $self->{'fields'} = \@unique;
115 return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
118 # ----------------------------------------------------------------------
125 Determine whether the index is valid or not.
127 my $ok = $index->is_valid;
132 my $table = $self->table or return $self->error('No table');
133 my @fields = $self->fields or return $self->error('No fields');
135 for my $field ( @fields ) {
137 "Field '$field' does not exist in table '", $table->name, "'"
138 ) unless $table->get_field( $field );
144 # ----------------------------------------------------------------------
151 Get or set the index's name.
153 my $name = $index->name('foo');
158 $self->{'name'} = shift if @_;
159 return $self->{'name'} || '';
162 # ----------------------------------------------------------------------
169 Get or set the index's options (e.g., "using" or "where" for PG). Returns
170 an array or array reference.
172 my @options = $index->options;
177 my $options = parse_list_arg( @_ );
179 push @{ $self->{'options'} }, @$options;
181 if ( ref $self->{'options'} ) {
182 return wantarray ? @{ $self->{'options'} || [] } : $self->{'options'};
185 return wantarray ? () : [];
189 # ----------------------------------------------------------------------
196 Get or set the index's table object.
198 my $table = $index->table;
203 if ( my $arg = shift ) {
204 return $self->error('Not a table object') unless
205 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema::Table' );
206 $self->{'table'} = $arg;
209 return $self->{'table'};
212 # ----------------------------------------------------------------------
219 Get or set the index's type.
221 my $type = $index->type('unique');
223 Get or set the index's options (e.g., "using" or "where" for PG). Returns
225 Currently there are only four acceptable types: UNIQUE, NORMAL, FULL_TEXT,
226 and SPATIAL. The latter two might be MySQL-specific. While both lowercase
227 and uppercase types are acceptable input, this method returns the type in
234 if ( my $type = uc shift ) {
235 return $self->error("Invalid index type: $type")
236 unless $VALID_INDEX_TYPE{ $type };
237 $self->{'type'} = $type;
240 return $self->{'type'} || 'NORMAL';
243 # ----------------------------------------------------------------------
250 Determines if this index is the same as another
252 my $isIdentical = $index1->equals( $index2 );
258 my $case_insensitive = shift;
259 my $ignore_index_names = shift;
261 return 0 unless $self->SUPER::equals($other);
263 unless ($ignore_index_names) {
264 unless ((!$self->name && ($other->name eq $other->fields->[0])) ||
265 (!$other->name && ($self->name eq $self->fields->[0]))) {
266 return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name;
269 #return 0 unless $self->is_valid eq $other->is_valid;
270 return 0 unless $self->type eq $other->type;
272 # Check fields, regardless of order
273 my %otherFields = (); # create a hash of the other fields
274 foreach my $otherField ($other->fields) {
275 $otherField = uc($otherField) if $case_insensitive;
276 $otherFields{$otherField} = 1;
278 foreach my $selfField ($self->fields) { # check for self fields in hash
279 $selfField = uc($selfField) if $case_insensitive;
280 return 0 unless $otherFields{$selfField};
281 delete $otherFields{$selfField};
283 # Check all other fields were accounted for
284 return 0 unless keys %otherFields == 0;
286 return 0 unless $self->_compare_objects(scalar $self->options, scalar $other->options);
287 return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra);
291 # ----------------------------------------------------------------------
294 undef $self->{'table'}; # destroy cyclical reference
299 # ----------------------------------------------------------------------
305 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.