package SQL::Translator::Schema::Table;
# ----------------------------------------------------------------------
-# $Id: Table.pm,v 1.2 2003-05-03 04:07:09 kycl4rk Exp $
+# $Id: Table.pm,v 1.5 2003-05-09 17:11:00 kycl4rk Exp $
# ----------------------------------------------------------------------
# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
#
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;
Object constructor.
- my $schema = SQL::Translator::Schema::Table->new( name => 'foo' );
+ my $table = SQL::Translator::Schema::Table->new(
+ schema => $schema,
+ name => 'foo',
+ );
=cut
my ( $self, $config ) = @_;
- $self->params( $config, qw[ name ] ) || return undef;
+
+ for my $arg ( qw[ schema name ] ) {
+ next unless defined $config->{ $arg };
+ $self->$arg( $config->{ $arg } ) or return;
+ }
+
return $self;
}
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;
- $self->{'name'} = shift if @_;
+
+ 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'} || '';
}
Add a constraint to the table. Returns the newly created
C<SQL::Translator::Schema::Constraint> object.
- my $constraint = $table->add_constraint(
- name => 'pk',
- type => PRIMARY_KEY,
- fields => [ 'foo_id' ],
+ my $constraint1 = $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 );
+
=cut
- my $self = shift;
- my $constraint = SQL::Translator::Schema::Constraint->new( @_ ) or
- return SQL::Translator::Schema::Constraint->error;
+ my $self = shift;
+ my $constraint_class = 'SQL::Translator::Schema::Constraint';
+ my $constraint;
+
+ if ( UNIVERSAL::isa( $_[0], $constraint_class ) ) {
+ $constraint = shift;
+ $constraint->table( $self );
+ }
+ else {
+ my %args = @_;
+ $args{'table'} = $self;
+ $constraint = $constraint_class->new( \%args ) or
+ return $self->error( $constraint_class->error );
+ }
+
push @{ $self->{'constraints'} }, $constraint;
return $constraint;
}
Add an index to the table. Returns the newly created
C<SQL::Translator::Schema::Index> object.
- my $index = $table->add_index(
+ my $index1 = $table->add_index(
name => 'name',
fields => [ 'name' ],
type => 'normal',
);
+ my $index2 = SQL::Translator::Schema::Index->new( name => 'id' );
+ $index2 = $table->add_index( $index );
+
=cut
- my $self = shift;
- my $index = SQL::Translator::Schema::Index->new( @_ ) or return
- SQL::Translator::Schema::Index->error;
+ my $self = shift;
+ my $index_class = 'SQL::Translator::Schema::Index';
+ my $index;
+
+ if ( UNIVERSAL::isa( $_[0], $index_class ) ) {
+ $index = shift;
+ $index->table( $self );
+ }
+ else {
+ my %args = @_;
+ $args{'table'} = $self;
+ $index = $index_class->new( \%args ) or return
+ $self->error( $index_class->error );
+ }
+
push @{ $self->{'indices'} }, $index;
return $index;
}
=head2 add_field
-Add an field to the table. Returns the newly created
-C<SQL::Translator::Schema::Field> object.
+Add an field to the table. Returns the newly created
+C<SQL::Translator::Schema::Field> object. The "name" parameter is
+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 $field = $table->add_field(
+ my $field1 = $table->add_field(
name => 'foo_id',
data_type => 'integer',
size => 11,
);
+ my $field2 = SQL::Translator::Schema::Field->new(
+ name => 'name',
+ table => $table,
+ );
+ $field2 = $table->add_field( $field2 ) or die $table->error;
+
=cut
my $self = shift;
- my %args = @_;
- return $self->error('No name') unless $args{'name'};
- my $field = SQL::Translator::Schema::Field->new( \%args ) or return;
- SQL::Translator::Schema::Field->error;
- $self->{'fields'}{ $field->name } = $field;
- $self->{'fields'}{ $field->name }{'order'} = ++$FIELD_ORDER;
+ my $field_class = 'SQL::Translator::Schema::Field';
+ my $field;
+
+ if ( UNIVERSAL::isa( $_[0], $field_class ) ) {
+ $field = shift;
+ $field->table( $self );
+ }
+ else {
+ my %args = @_;
+ $args{'table'} = $self;
+ $field = $field_class->new( \%args ) or return
+ $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 } ) {
+ return $self->error(qq[Can't create field: "$field_name" exists]);
+ }
+ else {
+ $self->{'fields'}{ $field_name } = $field;
+ }
+
return $field;
}
}
# ----------------------------------------------------------------------
+sub get_field {
+
+=pod
+
+=head2 get_field
+
+Returns a field by the name provided.
+
+ my $field = $table->get_field('foo');
+
+=cut
+
+ my $self = shift;
+ my $field_name = shift or return $self->error('No field name');
+ return $self->error( qq[Field "$field_name" does not exist] ) unless
+ exists $self->{'fields'}{ $field_name };
+ return $self->{'fields'}{ $field_name };
+}
+
+# ----------------------------------------------------------------------
sub get_fields {
=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 ) {
=cut
my $self = shift;
- return $self->error('No name') unless $self->name;
+ return $self->error('No name') unless $self->name;
return $self->error('No fields') unless $self->get_fields;
for my $object (
return 1;
}
+# ----------------------------------------------------------------------
+sub schema {
+
+=pod
+
+=head2 schema
+
+Get or set the table's schema object.
+
+ my $schema = $table->schema;
+
+=cut
+
+ my $self = shift;
+ if ( my $arg = shift ) {
+ return $self->error('Not a schema object') unless
+ UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
+ $self->{'schema'} = $arg;
+ }
+
+ return $self->{'schema'};
+}
+
+# ----------------------------------------------------------------------
+sub primary_key {
+
+=pod
+
+=head2 options
+
+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
+names are present, it will create a new PK if none exists, or it will
+add to the fields of an existing PK (and will unique the field names).
+Returns the C<SQL::Translator::Schema::Constraint> object representing
+the primary key.
+
+These are eqivalent:
+
+ $table->primary_key('id');
+ $table->primary_key(['name']);
+ $table->primary_key('id','name']);
+ $table->primary_key(['id','name']);
+ $table->primary_key('id,name');
+ $table->primary_key(qw[ id name ]);
+
+ my $pk = $table->primary_key;
+
+=cut
+
+ my $self = shift;
+ my $fields = parse_list_arg( @_ );
+
+ my $constraint;
+ if ( @$fields ) {
+ for my $f ( @$fields ) {
+ return $self->error(qq[Invalid field "$f"]) unless
+ $self->get_field($f);
+ }
+
+ my $has_pk;
+ for my $c ( $self->get_constraints ) {
+ if ( $c->type eq PRIMARY_KEY ) {
+ $has_pk = 1;
+ $c->fields( @{ $c->fields }, @$fields );
+ $constraint = $c;
+ }
+ }
+
+ unless ( $has_pk ) {
+ $constraint = $self->add_constraint(
+ type => PRIMARY_KEY,
+ fields => $fields,
+ );
+ }
+ }
+
+ if ( $constraint ) {
+ return $constraint;
+ }
+ else {
+ for my $c ( $self->get_constraints ) {
+ return $c if $c->type eq PRIMARY_KEY;
+ }
+ }
+
+ return $self->error('No primary key');
+}
+
+# ----------------------------------------------------------------------
+sub options {
+
+=pod
+
+=head2 options
+
+Get or set the table's options (e.g., table types for MySQL). Returns
+an array or array reference.
+
+ my @options = $table->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 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;
# ----------------------------------------------------------------------