package SQL::Translator::Schema::Constraint;
-# ----------------------------------------------------------------------
-# $Id: Constraint.pm,v 1.10 2004-02-09 22:15:15 kycl4rk Exp $
-# ----------------------------------------------------------------------
-# Copyright (C) 2002-4 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
=cut
use strict;
-use Class::Base;
+use warnings;
use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils 'parse_list_arg';
-use base 'Class::Base';
-use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
+use base 'SQL::Translator::Schema::Object';
+
+ our ( $TABLE_COUNT, $VIEW_COUNT );
-$VERSION = sprintf "%d.%02d", q$Revision: 1.10 $ =~ /(\d+)\.(\d+)/;
+our $VERSION = '1.59';
my %VALID_CONSTRAINT_TYPE = (
PRIMARY_KEY, 1,
NOT_NULL, 1,
);
-# ----------------------------------------------------------------------
+__PACKAGE__->_attributes( qw/
+ table name type fields reference_fields reference_table
+ match_type on_delete on_update expression deferrable
+/);
+
+# Override to remove empty arrays from args.
+# t/14postgres-parser breaks without this.
sub init {
=pod
reference_fields => 'phone_id', # referenced field
reference_table => 'phone', # referenced table
match_type => 'full', # how to match
- on_delete_do => 'cascade', # what to do on deletes
- on_update_do => '', # what to do on updates
+ on_delete => 'cascade', # what to do on deletes
+ on_update => '', # what to do on updates
);
=cut
- my ( $self, $config ) = @_;
- my @fields = qw[
- table name type fields reference_fields reference_table
- match_type on_delete on_update expression
- ];
-
- for my $arg ( @fields ) {
- next unless $config->{ $arg };
- next if ref $config->{ $arg } eq 'ARRAY' && ! @{ $config->{ $arg } };
- defined $self->$arg( $config->{ $arg } ) or return;
- }
-
- return $self;
+ my $self = shift;
+ foreach ( values %{$_[0]} ) { $_ = undef if ref($_) eq "ARRAY" && ! @$_; }
+ $self->SUPER::init(@_);
}
-# ----------------------------------------------------------------------
sub deferrable {
=pod
=head2 deferrable
-Get or set the whether the constraint is deferrable. If not defined,
+Get or set whether the constraint is deferrable. If not defined,
then returns "1." The argument is evaluated by Perl for True or
False, so the following are eqivalent:
return defined $self->{'deferrable'} ? $self->{'deferrable'} : 1;
}
-# ----------------------------------------------------------------------
sub expression {
=pod
=cut
my $self = shift;
-
+
if ( my $arg = shift ) {
# check arg here?
$self->{'expression'} = $arg;
return $self->{'expression'} || '';
}
-# ----------------------------------------------------------------------
sub is_valid {
=pod
return $self->error('Only one field allowed for foreign key')
if scalar @fields > 1;
- my $ref_table_name = $self->reference_table or
+ my $ref_table_name = $self->reference_table or
return $self->error('No reference table');
my $ref_table = $schema->get_table( $ref_table_name ) or
for my $ref_field ( @ref_fields ) {
next if $ref_table->get_field( $ref_field );
return $self->error(
- "Constraint from field(s) ",
+ "Constraint from field(s) ",
join(', ', map {qq['$table_name.$_']} @fields),
" to non-existent field '$ref_table_name.$ref_field'"
);
}
}
elsif ( $type eq CHECK_C ) {
- return $self->error('No expression for CHECK') unless
+ return $self->error('No expression for CHECK') unless
$self->expression;
}
return 1;
}
-# ----------------------------------------------------------------------
sub fields {
=pod
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.
+The fields are returned as Field objects if they exist or as plain
+names if not. (If you just want the names and want to avoid the Field's overload
+magic use L<field_names>).
+
+Returns undef or an empty list if the constraint has no fields set.
+
$constraint->fields('id');
$constraint->fields('id', 'name');
$constraint->fields( 'id, name' );
}
if ( @{ $self->{'fields'} || [] } ) {
- return wantarray ? @{ $self->{'fields'} } : $self->{'fields'};
+ # We have to return fields that don't exist on the table as names in
+ # case those fields havn't been created yet.
+ my @ret = map {
+ $self->table->get_field($_) || $_ } @{ $self->{'fields'} };
+ return wantarray ? @ret : \@ret;
}
else {
return wantarray ? () : undef;
}
}
-# ----------------------------------------------------------------------
+sub field_names {
+
+=head2 field_names
+
+Read-only method to return a list or array ref of the field names. Returns undef
+or an empty list if the constraint has no fields set. Useful if you want to
+avoid the overload magic of the Field objects returned by the fields method.
+
+ my @names = $constraint->field_names;
+
+=cut
+
+ my $self = shift;
+ return wantarray ? @{ $self->{'fields'} || [] } : ($self->{'fields'} || '');
+}
+
sub match_type {
=pod
=head2 match_type
Get or set the constraint's match_type. Only valid values are "full"
-or "partial."
+"partial" and "simple"
my $match_type = $constraint->match_type('FULL');
=cut
- my $self = shift;
-
- if ( my $arg = lc shift ) {
+ my ( $self, $arg ) = @_;
+
+ if ( $arg ) {
+ $arg = lc $arg;
return $self->error("Invalid match type: $arg")
- unless $arg eq 'full' || $arg eq 'partial';
+ unless $arg eq 'full' || $arg eq 'partial' || $arg eq 'simple';
$self->{'match_type'} = $arg;
}
return $self->{'match_type'} || '';
}
-# ----------------------------------------------------------------------
sub name {
=pod
return $self->{'name'} || '';
}
-# ----------------------------------------------------------------------
sub options {
=pod
=head2 options
-Gets or adds to the constraints's options (e.g., "INITIALLY IMMEDIATE").
+Gets or adds to the constraints's options (e.g., "INITIALLY IMMEDIATE").
Returns an array or array reference.
$constraint->options('NORELY');
}
}
-
-# ----------------------------------------------------------------------
sub on_delete {
=pod
=cut
my $self = shift;
-
+
if ( my $arg = shift ) {
# validate $arg?
$self->{'on_delete'} = $arg;
return $self->{'on_delete'} || '';
}
-# ----------------------------------------------------------------------
sub on_update {
=pod
=cut
my $self = shift;
-
+
if ( my $arg = shift ) {
# validate $arg?
$self->{'on_update'} = $arg;
return $self->{'on_update'} || '';
}
-# ----------------------------------------------------------------------
sub reference_fields {
=pod
$self->{'reference_fields'} = $fields;
}
+ # Nothing set so try and derive it from the other constraint data
unless ( ref $self->{'reference_fields'} ) {
- my $table = $self->table or return $self->error('No table');
- my $schema = $table->schema or return $self->error('No schema');
- my $ref_table_name = $self->reference_table or
- return $self->error('No table');
- my $ref_table = $schema->get_table( $ref_table_name ) or
- return $self->error("Can't find table '$ref_table_name'");
-
- if ( my $constraint = $ref_table->primary_key ) {
- $self->{'reference_fields'} = [ $constraint->fields ];
- }
- else {
- $self->error(
- 'No reference fields defined and cannot find primary key in ',
- "reference table '$ref_table_name'"
- );
+ my $table = $self->table or return $self->error('No table');
+ my $schema = $table->schema or return $self->error('No schema');
+ if ( my $ref_table_name = $self->reference_table ) {
+ my $ref_table = $schema->get_table( $ref_table_name ) or
+ return $self->error("Can't find table '$ref_table_name'");
+
+ if ( my $constraint = $ref_table->primary_key ) {
+ $self->{'reference_fields'} = [ $constraint->fields ];
+ }
+ else {
+ $self->error(
+ 'No reference fields defined and cannot find primary key in ',
+ "reference table '$ref_table_name'"
+ );
+ }
}
+ # No ref table so we are not that sort of constraint, hence no ref
+ # fields. So we let the return below return an empty list.
}
if ( ref $self->{'reference_fields'} ) {
- return wantarray
- ? @{ $self->{'reference_fields'} || [] }
+ return wantarray
+ ? @{ $self->{'reference_fields'} }
: $self->{'reference_fields'};
}
else {
}
}
-# ----------------------------------------------------------------------
sub reference_table {
=pod
return $self->{'reference_table'} || '';
}
-# ----------------------------------------------------------------------
sub table {
=pod
=head2 table
-Get or set the field's table object.
+Get or set the constraint's table object.
my $table = $field->table;
return $self->{'table'};
}
-# ----------------------------------------------------------------------
sub type {
=pod
=cut
- my $self = shift;
+ my ( $self, $type ) = @_;
- if ( my $type = uc shift ) {
+ if ( $type ) {
+ $type = uc $type;
$type =~ s/_/ /g;
- return $self->error("Invalid constraint type: $type")
+ return $self->error("Invalid constraint type: $type")
unless $VALID_CONSTRAINT_TYPE{ $type };
$self->{'type'} = $type;
}
return $self->{'type'} || '';
}
-# ----------------------------------------------------------------------
+
+sub equals {
+
+=pod
+
+=head2 equals
+
+Determines if this constraint is the same as another
+
+ my $isIdentical = $constraint1->equals( $constraint2 );
+
+=cut
+
+ my $self = shift;
+ my $other = shift;
+ my $case_insensitive = shift;
+ my $ignore_constraint_names = shift;
+
+ return 0 unless $self->SUPER::equals($other);
+ return 0 unless $self->type eq $other->type;
+ unless ($ignore_constraint_names) {
+ return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name;
+ }
+ return 0 unless $self->deferrable eq $other->deferrable;
+ #return 0 unless $self->is_valid eq $other->is_valid;
+ return 0 unless $case_insensitive ? uc($self->table->name) eq uc($other->table->name)
+ : $self->table->name eq $other->table->name;
+ return 0 unless $self->expression eq $other->expression;
+
+ # 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;
+
+ # Check reference fields, regardless of order
+ my %otherRefFields = (); # create a hash of the other reference fields
+ foreach my $otherRefField ($other->reference_fields) {
+ $otherRefField = uc($otherRefField) if $case_insensitive;
+ $otherRefFields{$otherRefField} = 1;
+ }
+ foreach my $selfRefField ($self->reference_fields) { # check for self reference fields in hash
+ $selfRefField = uc($selfRefField) if $case_insensitive;
+ return 0 unless $otherRefFields{$selfRefField};
+ delete $otherRefFields{$selfRefField};
+ }
+ # Check all other reference fields were accounted for
+ return 0 unless keys %otherRefFields == 0;
+
+ return 0 unless $case_insensitive ? uc($self->reference_table) eq uc($other->reference_table) : $self->reference_table eq $other->reference_table;
+ return 0 unless $self->match_type eq $other->match_type;
+ return 0 unless $self->on_delete eq $other->on_delete;
+ return 0 unless $self->on_update eq $other->on_update;
+ 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 Y. Clark E<lt>kclark@cpan.orgE<gt>.
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
=cut
projects / dbsrgits/SQL-Translator.git / blobdiff