package SQL::Translator::Schema::Constraint;
# ----------------------------------------------------------------------
-# $Id: Constraint.pm,v 1.5 2003-06-06 22:35:16 kycl4rk Exp $
+# $Id: Constraint.pm,v 1.15 2004-11-05 13:19:31 grommit Exp $
# ----------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
+# 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
=cut
use strict;
-use Class::Base;
use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils 'parse_list_arg';
-use base 'Class::Base';
+use base 'SQL::Translator::Schema::Object';
+
use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
-$VERSION = 1.00;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.15 $ =~ /(\d+)\.(\d+)/;
my %VALID_CONSTRAINT_TYPE = (
PRIMARY_KEY, 1,
);
# ----------------------------------------------------------------------
-sub init {
+__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
=head2 new
type => 'foreign_key', # type of table constraint
name => 'fk_phone_id', # name of the constraint
fields => 'phone_id', # field in the referring table
- reference_fields => 'phone_id', # referenced table
- reference_table => 'phone', # referenced fields
+ 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
- ];
-
- for my $arg ( @fields ) {
- next unless $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(@_);
}
# ----------------------------------------------------------------------
=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:
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' );
$self->{'fields'} = \@unique;
}
- return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
+ if ( @{ $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. Usefull 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'};
}
# ----------------------------------------------------------------------
$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'} || [] }
+ ? @{ $self->{'reference_fields'} }
: $self->{'reference_fields'};
}
else {
=head2 table
-Get or set the field's table object.
+Get or set the constraint's table object.
my $table = $field->table;
=head1 AUTHOR
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
=cut
projects / dbsrgits/SQL-Translator.git / blobdiff