package SQL::Translator::Schema::Index;
-# ----------------------------------------------------------------------
-# $Id: Index.pm,v 1.2 2003-05-05 04:32:39 kycl4rk Exp $
-# ----------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
-#
-# 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
C<SQL::Translator::Schema::Index> 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 base 'Class::Base';
-use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
+use Moo;
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Utils 'parse_list_arg';
+use List::MoreUtils qw(uniq);
-$VERSION = 1.00;
+with qw(
+ SQL::Translator::Schema::Role::Extra
+ SQL::Translator::Schema::Role::Error
+ SQL::Translator::Schema::Role::Compare
+);
-use constant VALID_TYPE => {
- unique => 1,
- normal => 1,
- full_text => 1, # MySQL only (?)
-};
+our ( $TABLE_COUNT, $VIEW_COUNT );
-# ----------------------------------------------------------------------
-sub init {
+our $VERSION = '1.59';
-=pod
+my %VALID_INDEX_TYPE = (
+ UNIQUE => 1,
+ NORMAL => 1,
+ FULLTEXT => 1, # MySQL only (?)
+ FULL_TEXT => 1, # MySQL only (?)
+ SPATIAL => 1, # MySQL only (?)
+);
=head2 new
=cut
- my ( $self, $config ) = @_;
- for my $arg ( qw[ name type fields ] ) {
- next unless $config->{ $arg };
- $self->$arg( $config->{ $arg } ) or return;
- }
- return $self;
+sub BUILD {
+ my ($self) = @_;
+ $self->$_(scalar $self->$_)
+ foreach qw(fields options);
}
-# ----------------------------------------------------------------------
-sub fields {
+=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
+
+has fields => (
+ is => 'rw',
+ default => sub { [] },
+ coerce => sub { [uniq @{parse_list_arg($_[0])}] },
+);
+
+around fields => sub {
+ my $orig = shift;
+ my $self = shift;
+ my $fields = parse_list_arg( @_ );
+ $self->$orig($fields) if @$fields;
+
+ return wantarray ? @{ $self->$orig } : $self->$orig;
+};
+
+sub is_valid {
=pod
-=head2 fields
+=head2 is_valid
-Gets and set the fields the index is on. Accepts a list or arrayref,
-return both, too.
+Determine whether the index is valid or not.
- my @fields = $index->fields( 'id' );
+ my $ok = $index->is_valid;
=cut
my $self = shift;
- my $fields = ref $_[0] eq 'ARRAY' ? shift : [ @_ ];
+ my $table = $self->table or return $self->error('No table');
+ my @fields = $self->fields or return $self->error('No fields');
- if ( @$fields ) {
- $self->{'fields'} = $fields;
+ for my $field ( @fields ) {
+ return $self->error(
+ "Field '$field' does not exist in table '", $table->name, "'"
+ ) unless $table->get_field( $field );
}
- return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
+ return 1;
}
-# ----------------------------------------------------------------------
-sub name {
-
-=pod
-
=head2 name
Get or set the index's name.
=cut
- my $self = shift;
- $self->{'name'} = shift if @_;
- return $self->{'name'} || '';
-}
+has name => ( is => 'rw', coerce => sub { defined $_[0] ? $_[0] : '' }, default => sub { '' } );
-# ----------------------------------------------------------------------
-sub table {
+=head2 options
-=pod
+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
+
+has options => (
+ is => 'rw',
+ default => sub { [] },
+ coerce => sub { parse_list_arg($_[0]) },
+);
+
+around options => sub {
+ my $orig = shift;
+ my $self = shift;
+ my $options = parse_list_arg( @_ );
+
+ push @{ $self->$orig }, @$options;
+
+ return wantarray ? @{ $self->$orig } : $self->$orig;
+};
=head2 table
=cut
+has table => ( is => 'rw' );
+
+around table => sub {
+ my $orig = shift;
my $self = shift;
- if ( my $arg = shift ) {
+ if ( my $arg = $_[0] ) {
return $self->error('Not a table object') unless
UNIVERSAL::isa( $arg, 'SQL::Translator::Schema::Table' );
- $self->{'table'} = $arg;
}
- return $self->{'table'};
-}
-
-# ----------------------------------------------------------------------
-sub type {
-
-=pod
+ return $self->$orig(@_);
+};
=head2 type
my $type = $index->type('unique');
+Get or set the index's type.
+
+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;
+has type => ( is => 'rw', default => sub { 'NORMAL' } );
- if ( my $type = shift ) {
- return $self->error("Invalid index type: $type")
- unless VALID_TYPE->{ $type };
- $self->{'type'} = $type;
+around type => sub {
+ my ( $orig, $self) = (shift, shift);
+
+ if ( my $type = $_[0] ) {
+ my $type = uc $type;
+ return $self->error("Invalid index type: $type")
+ unless $VALID_INDEX_TYPE{ $type };
}
- return $self->{'type'} || '';
-}
+ return $self->$orig(@_);
+};
+=head2 equals
-# ----------------------------------------------------------------------
-sub is_valid {
+Determines if this index is the same as another
-=pod
+ my $isIdentical = $index1->equals( $index2 );
-=head2 is_valid
+=cut
-Determine whether the index is valid or not.
+around equals => sub {
+ my $orig = shift;
+ my $self = shift;
+ my $other = shift;
+ my $case_insensitive = shift;
+ my $ignore_index_names = shift;
- my $ok = $index->is_valid;
+ return 0 unless $self->$orig($other);
-=cut
+ 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;
- return ( $self->name && $self->{'type'} && @{ $self->fields } ) ? 1 : 0;
+ undef $self->{'table'}; # destroy cyclical reference
}
1;
-# ----------------------------------------------------------------------
-
=pod
=head1 AUTHOR
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
=cut
projects / dbsrgits/SQL-Translator.git / blobdiff