package SQL::Translator::Schema::Index;
# ----------------------------------------------------------------------
# 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
# 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
SQL::Translator::Schema::Index - SQL::Translator index object
=head1 SYNOPSIS
use SQL::Translator::Schema::Index;
my $index = SQL::Translator::Schema::Index->new(
name => 'foo',
fields => [ id ],
type => 'unique',
);
=head1 DESCRIPTION
C<SQL::Translator::Schema::Index> is the index object.
Primary and unique keys are table constraints, not indices.
=head1 METHODS
=cut
use strict;
use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils 'parse_list_arg';
use base 'SQL::Translator::Schema::Object';
use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
$VERSION = '1.59';
my %VALID_INDEX_TYPE = (
UNIQUE => 1,
NORMAL => 1,
FULLTEXT => 1, # MySQL only (?)
FULL_TEXT => 1, # MySQL only (?)
SPATIAL => 1, # MySQL only (?)
);
# ----------------------------------------------------------------------
__PACKAGE__->_attributes( qw/
name type fields table options
/);
=pod
=head2 new
Object constructor.
my $schema = SQL::Translator::Schema::Index->new;
=cut
# ----------------------------------------------------------------------
sub fields {
=pod
=head2 fields
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;
=cut
my $self = shift;
my $fields = parse_list_arg( @_ );
if ( @$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
=head2 name
Get or set the index's name.
my $name = $index->name('foo');
=cut
my $self = shift;
$self->{'name'} = shift if @_;
return $self->{'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
=head2 type
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, $type ) = @_;
if ( $type ) {
$type = uc $type;
return $self->error("Invalid index type: $type")
unless $VALID_INDEX_TYPE{ $type };
$self->{'type'} = $type;
}
return $self->{'type'} || 'NORMAL';
}
# ----------------------------------------------------------------------
sub equals {
=pod
=head2 equals
Determines if this index is the same as another
my $isIdentical = $index1->equals( $index2 );
=cut
my $self = shift;
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;
# ----------------------------------------------------------------------
=pod
=head1 AUTHOR
Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
=cut