package SQL::Translator::Schema::Table;
# ----------------------------------------------------------------------
-# $Id: Table.pm,v 1.4 2003-05-07 20:42:34 kycl4rk Exp $
+# $Id: Table.pm,v 1.24 2004-02-09 22:15:15 kycl4rk 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
use strict;
use Class::Base;
+use SQL::Translator::Utils 'parse_list_arg';
use SQL::Translator::Schema::Constants;
use SQL::Translator::Schema::Constraint;
use SQL::Translator::Schema::Field;
use SQL::Translator::Schema::Index;
+use Data::Dumper;
use base 'Class::Base';
use vars qw( $VERSION $FIELD_ORDER );
-$VERSION = 1.00;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.24 $ =~ /(\d+)\.(\d+)/;
# ----------------------------------------------------------------------
sub init {
my ( $self, $config ) = @_;
- for my $arg ( qw[ schema name ] ) {
+ for my $arg ( qw[ schema name comments ] ) {
next unless defined $config->{ $arg };
- $self->$arg( $config->{ $arg } ) or return;
+ defined $self->$arg( $config->{ $arg } ) or return;
}
return $self;
}
# ----------------------------------------------------------------------
-sub name {
-
-=pod
-
-=head2 name
-
-Get or set the table's name.
-
-If provided an argument, checks the schema object for a table of
-that name and disallows the change if one exists.
-
- my $table_name = $table->name('foo');
-
-=cut
-
- my $self = shift;
-
- if ( my $arg = shift ) {
- if ( my $schema = $self->schema ) {
- return $self->error( qq[Can't use table name "$arg": table exists] )
- if $schema->get_table( $arg );
- }
- $self->{'name'} = $arg;
- }
-
- return $self->{'name'} || '';
-}
-
-# ----------------------------------------------------------------------
sub add_constraint {
=pod
Add a constraint to the table. Returns the newly created
C<SQL::Translator::Schema::Constraint> object.
- my $constraint1 = $table->add_constraint(
- name => 'pk',
- type => PRIMARY_KEY,
- fields => [ 'foo_id' ],
+ my $c1 = $table->add_constraint(
+ name => 'pk',
+ type => PRIMARY_KEY,
+ fields => [ 'foo_id' ],
);
- my $constraint2 = SQL::Translator::Schema::Constraint->new( name => 'uniq' );
- $constraint2 = $table->add_constraint( $constraint );
+ my $c2 = SQL::Translator::Schema::Constraint->new( name => 'uniq' );
+ $c2 = $table->add_constraint( $constraint );
=cut
return $self->error( $constraint_class->error );
}
- push @{ $self->{'constraints'} }, $constraint;
+ #
+ # If we're trying to add a PK when one is already defined,
+ # then just add the fields to the existing definition.
+ #
+ my $ok = 1;
+ my $pk = $self->primary_key;
+ if ( $pk && $constraint->type eq PRIMARY_KEY ) {
+ $self->primary_key( $constraint->fields );
+ $constraint = $pk;
+ $ok = 0;
+ }
+ elsif ( $constraint->type eq PRIMARY_KEY ) {
+ for my $fname ( $constraint->fields ) {
+ if ( my $f = $self->get_field( $fname ) ) {
+ $f->is_primary_key( 1 );
+ }
+ }
+ }
+ #
+ # See if another constraint of the same type
+ # covers the same fields. -- This doesn't work! ky
+ #
+# elsif ( $constraint->type ne CHECK_C ) {
+# my @field_names = $constraint->fields;
+# for my $c (
+# grep { $_->type eq $constraint->type }
+# $self->get_constraints
+# ) {
+# my %fields = map { $_, 1 } $c->fields;
+# for my $field_name ( @field_names ) {
+# if ( $fields{ $field_name } ) {
+# $constraint = $c;
+# $ok = 0;
+# last;
+# }
+# }
+# last unless $ok;
+# }
+# }
+
+ if ( $ok ) {
+ push @{ $self->{'constraints'} }, $constraint;
+ }
+
return $constraint;
}
Add an index to the table. Returns the newly created
C<SQL::Translator::Schema::Index> object.
- my $index1 = $table->add_index(
+ my $i1 = $table->add_index(
name => 'name',
fields => [ 'name' ],
type => 'normal',
);
- my $index2 = SQL::Translator::Schema::Index->new( name => 'id' );
- $index2 = $table->add_index( $index );
+ my $i2 = SQL::Translator::Schema::Index->new( name => 'id' );
+ $i2 = $table->add_index( $index );
=cut
required. If you try to create a field with the same name as an
existing field, you will get an error and the field will not be created.
- my $field1 = $table->add_field(
+ my $f1 = $table->add_field(
name => 'foo_id',
data_type => 'integer',
size => 11,
);
- my $field2 = SQL::Translator::Schema::Field->new(
+ my $f2 = SQL::Translator::Schema::Field->new(
name => 'name',
table => $table,
);
- $field2 = $table->add_field( $field2 ) or die $table->error;
+ $f2 = $table->add_field( $field2 ) or die $table->error;
=cut
- my $self = shift;
+ my $self = shift;
my $field_class = 'SQL::Translator::Schema::Field';
my $field;
$self->error( $field_class->error );
}
+ $field->order( ++$FIELD_ORDER );
my $field_name = $field->name or return $self->error('No name');
if ( exists $self->{'fields'}{ $field_name } ) {
}
else {
$self->{'fields'}{ $field_name } = $field;
- $self->{'fields'}{ $field_name }{'order'} = ++$FIELD_ORDER;
}
return $field;
}
# ----------------------------------------------------------------------
+sub comments {
+
+=pod
+
+=head2 comments
+
+Get or set the comments on a table. May be called several times to
+set and it will accumulate the comments. Called in an array context,
+returns each comment individually; called in a scalar context, returns
+all the comments joined on newlines.
+
+ $table->comments('foo');
+ $table->comments('bar');
+ print join( ', ', $table->comments ); # prints "foo, bar"
+
+=cut
+
+ my $self = shift;
+ my @comments = ref $_[0] ? @{ $_[0] } : @_;
+
+ for my $arg ( @comments ) {
+ $arg = $arg->[0] if ref $arg;
+ push @{ $self->{'comments'} }, $arg if defined $arg && $arg;
+ }
+
+ if ( @{ $self->{'comments'} || [] } ) {
+ return wantarray
+ ? @{ $self->{'comments'} }
+ : join( "\n", @{ $self->{'comments'} } )
+ ;
+ }
+ else {
+ return wantarray ? () : undef;
+ }
+}
+
+# ----------------------------------------------------------------------
sub get_constraints {
=pod
my $self = shift;
my @fields =
- sort { $a->{'order'} <=> $b->{'order'} }
+ map { $_->[1] }
+ sort { $a->[0] <=> $b->[0] }
+ map { [ $_->order, $_ ] }
values %{ $self->{'fields'} || {} };
if ( @fields ) {
}
# ----------------------------------------------------------------------
+sub is_trivial_link {
+
+=pod
+
+=head2 is_data
+
+=cut
+
+ my $self = shift;
+ return 0 if $self->is_data;
+ return $self->{'is_trivial_link'} if defined $self->{'is_trivial_link'};
+
+ $self->{'is_trivial_link'} = 1;
+
+ my %fk = ();
+
+ foreach my $field ( $self->get_fields ) {
+ next unless $field->is_foreign_key;
+ $fk{$field->foreign_key_reference->reference_table}++;
+ }
+
+ foreach my $referenced (keys %fk){
+ if($fk{$referenced} > 1){
+ $self->{'is_trivial_link'} = 0;
+ last;
+ }
+ }
+
+ return $self->{'is_trivial_link'};
+
+}
+
+sub is_data {
+
+=pod
+
+=head2 is_data
+
+=cut
+
+ my $self = shift;
+ return $self->{'is_data'} if defined $self->{'is_data'};
+
+ $self->{'is_data'} = 0;
+
+ foreach my $field ( $self->get_fields ) {
+ if ( !$field->is_primary_key and !$field->is_foreign_key ) {
+ $self->{'is_data'} = 1;
+ return $self->{'is_data'};
+ }
+ }
+
+ return $self->{'is_data'};
+}
+
+# ----------------------------------------------------------------------
+sub can_link {
+
+=pod
+
+=head2 can_link
+
+Determine whether the table can link two arg tables via many-to-many.
+
+ my $ok = $table->can_link($table1,$table2);
+
+=cut
+
+ my ( $self, $table1, $table2 ) = @_;
+
+ return $self->{'can_link'}{ $table1->name }{ $table2->name }
+ if defined $self->{'can_link'}{ $table1->name }{ $table2->name };
+
+ if ( $self->is_data == 1 ) {
+ $self->{'can_link'}{ $table1->name }{ $table2->name } = [0];
+ $self->{'can_link'}{ $table2->name }{ $table1->name } = [0];
+ return $self->{'can_link'}{ $table1->name }{ $table2->name };
+ }
+
+ my %fk = ();
+
+ foreach my $field ( $self->get_fields ) {
+ if ( $field->is_foreign_key ) {
+ push @{ $fk{ $field->foreign_key_reference->reference_table } },
+ $field->foreign_key_reference;
+ }
+ }
+
+ if ( !defined( $fk{ $table1->name } ) or !defined( $fk{ $table2->name } ) )
+ {
+ $self->{'can_link'}{ $table1->name }{ $table2->name } = [0];
+ $self->{'can_link'}{ $table2->name }{ $table1->name } = [0];
+ return $self->{'can_link'}{ $table1->name }{ $table2->name };
+ }
+
+ # trivial traversal, only one way to link the two tables
+ if ( scalar( @{ $fk{ $table1->name } } == 1 )
+ and scalar( @{ $fk{ $table2->name } } == 1 ) )
+ {
+ $self->{'can_link'}{ $table1->name }{ $table2->name } =
+ [ 'one2one', $fk{ $table1->name }, $fk{ $table2->name } ];
+ $self->{'can_link'}{ $table1->name }{ $table2->name } =
+ [ 'one2one', $fk{ $table2->name }, $fk{ $table1->name } ];
+
+ # non-trivial traversal. one way to link table2,
+ # many ways to link table1
+ }
+ elsif ( scalar( @{ $fk{ $table1->name } } > 1 )
+ and scalar( @{ $fk{ $table2->name } } == 1 ) )
+ {
+ $self->{'can_link'}{ $table1->name }{ $table2->name } =
+ [ 'many2one', $fk{ $table1->name }, $fk{ $table2->name } ];
+ $self->{'can_link'}{ $table2->name }{ $table1->name } =
+ [ 'one2many', $fk{ $table2->name }, $fk{ $table1->name } ];
+
+ # non-trivial traversal. one way to link table1,
+ # many ways to link table2
+ }
+ elsif ( scalar( @{ $fk{ $table1->name } } == 1 )
+ and scalar( @{ $fk{ $table2->name } } > 1 ) )
+ {
+ $self->{'can_link'}{ $table1->name }{ $table2->name } =
+ [ 'one2many', $fk{ $table1->name }, $fk{ $table2->name } ];
+ $self->{'can_link'}{ $table2->name }{ $table1->name } =
+ [ 'many2one', $fk{ $table2->name }, $fk{ $table1->name } ];
+
+ # non-trivial traversal. many ways to link table1 and table2
+ }
+ elsif ( scalar( @{ $fk{ $table1->name } } > 1 )
+ and scalar( @{ $fk{ $table2->name } } > 1 ) )
+ {
+ $self->{'can_link'}{ $table1->name }{ $table2->name } =
+ [ 'many2many', $fk{ $table1->name }, $fk{ $table2->name } ];
+ $self->{'can_link'}{ $table2->name }{ $table1->name } =
+ [ 'many2many', $fk{ $table2->name }, $fk{ $table1->name } ];
+
+ # one of the tables didn't export a key
+ # to this table, no linking possible
+ }
+ else {
+ $self->{'can_link'}{ $table1->name }{ $table2->name } = [0];
+ $self->{'can_link'}{ $table2->name }{ $table1->name } = [0];
+ }
+
+ return $self->{'can_link'}{ $table1->name }{ $table2->name };
+}
+
+# ----------------------------------------------------------------------
+sub name {
+
+=pod
+
+=head2 name
+
+Get or set the table's name.
+
+If provided an argument, checks the schema object for a table of
+that name and disallows the change if one exists.
+
+ my $table_name = $table->name('foo');
+
+=cut
+
+ my $self = shift;
+
+ if ( my $arg = shift ) {
+ if ( my $schema = $self->schema ) {
+ return $self->error( qq[Can't use table name "$arg": table exists] )
+ if $schema->get_table( $arg );
+ }
+ $self->{'name'} = $arg;
+ }
+
+ return $self->{'name'} || '';
+}
+
+# ----------------------------------------------------------------------
sub schema {
=pod
=pod
-=head2 options
+=head2 primary_key
Gets or sets the table's primary key(s). Takes one or more field
names (as a string, list or array[ref]) as an argument. If the field
=cut
- my $self = shift;
- my $fields = UNIVERSAL::isa( $_[0], 'ARRAY' )
- ? shift : [ map { s/^\s+|\s+$//g; $_ } map { split /,/ } @_ ];
+ my $self = shift;
+ my $fields = parse_list_arg( @_ );
my $constraint;
if ( @$fields ) {
$constraint = $self->add_constraint(
type => PRIMARY_KEY,
fields => $fields,
- );
+ ) or return;
}
}
}
}
- return $self->error('No primary key');
+ return;
}
# ----------------------------------------------------------------------
=cut
my $self = shift;
- my $options = UNIVERSAL::isa( $_[0], 'ARRAY' )
- ? shift : [ map { s/^\s+|\s+$//g; $_ } map { split /,/ } @_ ];
+ my $options = parse_list_arg( @_ );
push @{ $self->{'options'} }, @$options;
}
}
+# ----------------------------------------------------------------------
+sub order {
+
+=pod
+
+=head2 order
+
+Get or set the table's order.
+
+ my $order = $table->order(3);
+
+=cut
+
+ my ( $self, $arg ) = @_;
+
+ if ( defined $arg && $arg =~ /^\d+$/ ) {
+ $self->{'order'} = $arg;
+ }
+
+ return $self->{'order'} || 0;
+}
+
+# ----------------------------------------------------------------------
+sub DESTROY {
+ my $self = shift;
+ undef $self->{'schema'}; # destroy cyclical reference
+ undef $_ for @{ $self->{'constraints'} };
+ undef $_ for @{ $self->{'indices'} };
+ undef $_ for values %{ $self->{'fields'} };
+}
+
1;
# ----------------------------------------------------------------------
=pod
-=head1 AUTHOR
+=head1 AUTHORS
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
+Allen Day E<lt>allenday@ucla.eduE<gt>.
=cut