package SQL::Translator::Schema::Index;
-# ----------------------------------------------------------------------
-# $Id: Index.pm,v 1.3 2003-05-09 17:09:43 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 Moo 1.000003;
use SQL::Translator::Schema::Constants;
-use SQL::Translator::Utils 'parse_list_arg';
-
-use base 'Class::Base';
-use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
-
-$VERSION = 1.00;
+use SQL::Translator::Utils qw(ex2err throw);
+use SQL::Translator::Role::ListAttr;
+use SQL::Translator::Types qw(schema_obj);
+use Sub::Quote qw(quote_sub);
-use constant VALID_TYPE => {
- UNIQUE, 1,
- NORMAL, 1,
- FULL_TEXT, 1, # MySQL only (?)
-};
+extends 'SQL::Translator::Schema::Object';
-# ----------------------------------------------------------------------
-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
my $schema = SQL::Translator::Schema::Index->new;
-=cut
+=head2 fields
- my ( $self, $config ) = @_;
+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.
- for my $arg ( qw[ name type fields table ] ) {
- next unless $config->{ $arg };
- $self->$arg( $config->{ $arg } ) or return;
- }
+ $index->fields('id');
+ $index->fields('id', 'name');
+ $index->fields( 'id, name' );
+ $index->fields( [ 'id', 'name' ] );
+ $index->fields( qw[ id name ] );
- return $self;
-}
+ my @fields = $index->fields;
-# ----------------------------------------------------------------------
-sub fields {
+=cut
-=pod
+with ListAttr fields => ( uniq => 1 );
-=head2 fields
+sub is_valid {
-Gets and set the fields the constraint 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.
+=pod
- $constraint->fields('id');
- $constraint->fields('id', 'name');
- $constraint->fields( 'id, name' );
- $constraint->fields( [ 'id', 'name' ] );
- $constraint->fields( qw[ id name ] );
+=head2 is_valid
- my @fields = $constraint->fields;
+Determine whether the index is valid or not.
+
+ my $ok = $index->is_valid;
=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;
- }
+ my $table = $self->table or return $self->error('No table');
+ my @fields = $self->fields or return $self->error('No fields');
- $self->{'fields'} = \@unique;
+ 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'} || '';
-}
-
-# ----------------------------------------------------------------------
-sub options {
-
-=pod
+has name => ( is => 'rw', coerce => sub { defined $_[0] ? $_[0] : '' }, default => quote_sub(q{ '' }) );
=head2 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
+with ListAttr options => ();
=head2 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 {
+has table => ( is => 'rw', isa => schema_obj('Table'), weak_ref => 1 );
-=pod
+around table => \&ex2err;
=head2 type
my $type = $index->type('unique');
-=cut
-
- my $self = shift;
-
- if ( my $type = shift ) {
- return $self->error("Invalid index type: $type")
- unless VALID_TYPE->{ $type };
- $self->{'type'} = $type;
- }
+Get or set the index's type.
- return $self->{'type'} || NORMAL;
-}
+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
-# ----------------------------------------------------------------------
-sub is_valid {
+has type => (
+ is => 'rw',
+ isa => sub {
+ my $type = uc $_[0] or return;
+ throw("Invalid index type: $type") unless $VALID_INDEX_TYPE{$type};
+ },
+ coerce => sub { uc $_[0] },
+ default => quote_sub(q{ 'NORMAL' }),
+);
-=pod
+around type => \&ex2err;
-=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;
- my $table = $self->table or return $self->error('No table');
- my @fields = $self->fields or return $self->error('No fields');
+around equals => sub {
+ my $orig = shift;
+ my $self = shift;
+ my $other = shift;
+ my $case_insensitive = shift;
+ my $ignore_index_names = shift;
- for my $field ( @fields ) {
- return $self->error(
- "Field '$field' does not exist in table '", $table->name, "'"
- ) unless $table->get_field( $field );
+ return 0 unless $self->$orig($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
-}
+# Must come after all 'has' declarations
+around new => \&ex2err;
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