1 package SQL::Translator::Schema::Table;
3 # ----------------------------------------------------------------------
4 # $Id: Table.pm,v 1.11 2003-08-20 13:50:47 dlc Exp $
5 # ----------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
27 SQL::Translator::Schema::Table - SQL::Translator table object
31 use SQL::Translator::Schema::Table;
32 my $table = SQL::Translator::Schema::Table->new( name => 'foo' );
36 C<SQL::Translator::Schema::Table> is the table object.
44 use SQL::Translator::Utils 'parse_list_arg';
45 use SQL::Translator::Schema::Constants;
46 use SQL::Translator::Schema::Constraint;
47 use SQL::Translator::Schema::Field;
48 use SQL::Translator::Schema::Index;
50 use base 'Class::Base';
51 use vars qw( $VERSION $FIELD_ORDER );
53 $VERSION = sprintf "%d.%02d", q$Revision: 1.11 $ =~ /(\d+)\.(\d+)/;
55 # ----------------------------------------------------------------------
64 my $table = SQL::Translator::Schema::Table->new(
71 my ( $self, $config ) = @_;
73 for my $arg ( qw[ schema name comments ] ) {
74 next unless defined $config->{ $arg };
75 defined $self->$arg( $config->{ $arg } ) or return;
81 # ----------------------------------------------------------------------
88 Add a constraint to the table. Returns the newly created
89 C<SQL::Translator::Schema::Constraint> object.
91 my $c1 = $table->add_constraint(
94 fields => [ 'foo_id' ],
97 my $c2 = SQL::Translator::Schema::Constraint->new( name => 'uniq' );
98 $c2 = $table->add_constraint( $constraint );
103 my $constraint_class = 'SQL::Translator::Schema::Constraint';
106 if ( UNIVERSAL::isa( $_[0], $constraint_class ) ) {
108 $constraint->table( $self );
112 $args{'table'} = $self;
113 $constraint = $constraint_class->new( \%args ) or
114 return $self->error( $constraint_class->error );
118 # If we're trying to add a PK when one is already defined,
119 # then just add the fields to the existing definition.
122 my $pk = $self->primary_key;
123 if ( $pk && $constraint->type eq PRIMARY_KEY ) {
124 $self->primary_key( $constraint->fields );
128 my @field_names = $constraint->fields;
132 grep { $_->type eq $constraint->type }
133 $self->get_constraints
135 my %fields = map { $_, 1 } $c->fields;
136 for my $field_name ( @field_names ) {
137 if ( $fields{ $field_name } ) {
148 push @{ $self->{'constraints'} }, $constraint;
154 # ----------------------------------------------------------------------
161 Add an index to the table. Returns the newly created
162 C<SQL::Translator::Schema::Index> object.
164 my $i1 = $table->add_index(
166 fields => [ 'name' ],
170 my $i2 = SQL::Translator::Schema::Index->new( name => 'id' );
171 $i2 = $table->add_index( $index );
176 my $index_class = 'SQL::Translator::Schema::Index';
179 if ( UNIVERSAL::isa( $_[0], $index_class ) ) {
181 $index->table( $self );
185 $args{'table'} = $self;
186 $index = $index_class->new( \%args ) or return
187 $self->error( $index_class->error );
190 push @{ $self->{'indices'} }, $index;
194 # ----------------------------------------------------------------------
201 Add an field to the table. Returns the newly created
202 C<SQL::Translator::Schema::Field> object. The "name" parameter is
203 required. If you try to create a field with the same name as an
204 existing field, you will get an error and the field will not be created.
206 my $f1 = $table->add_field(
208 data_type => 'integer',
212 my $f2 = SQL::Translator::Schema::Field->new(
216 $f2 = $table->add_field( $field2 ) or die $table->error;
221 my $field_class = 'SQL::Translator::Schema::Field';
224 if ( UNIVERSAL::isa( $_[0], $field_class ) ) {
226 $field->table( $self );
230 $args{'table'} = $self;
231 $field = $field_class->new( \%args ) or return
232 $self->error( $field_class->error );
235 $field->order( ++$FIELD_ORDER );
236 my $field_name = $field->name or return $self->error('No name');
238 if ( exists $self->{'fields'}{ $field_name } ) {
239 return $self->error(qq[Can't create field: "$field_name" exists]);
242 $self->{'fields'}{ $field_name } = $field;
248 # ----------------------------------------------------------------------
255 Get or set the comments on a table. May be called several times to
256 set and it will accumulate the comments. Called in an array context,
257 returns each comment individually; called in a scalar context, returns
258 all the comments joined on newlines.
260 $table->comments('foo');
261 $table->comments('bar');
262 print join( ', ', $table->comments ); # prints "foo, bar"
267 $self->{'comments'} = [ ]
268 unless (defined $self->{'comments'} &&
269 ref($self->{'comments'}) eq 'ARRAY');
272 $arg = $arg->[0] if ref $arg;
273 push @{ $self->{'comments'} }, $arg
278 ? @{ $self->{'comments'} }
279 : join( "\n", @{ $self->{'comments'} } );
282 # ----------------------------------------------------------------------
283 sub get_constraints {
287 =head2 get_constraints
289 Returns all the constraint objects as an array or array reference.
291 my @constraints = $table->get_constraints;
297 if ( ref $self->{'constraints'} ) {
299 ? @{ $self->{'constraints'} } : $self->{'constraints'};
302 $self->error('No constraints');
303 return wantarray ? () : undef;
307 # ----------------------------------------------------------------------
314 Returns all the index objects as an array or array reference.
316 my @indices = $table->get_indices;
322 if ( ref $self->{'indices'} ) {
324 ? @{ $self->{'indices'} }
325 : $self->{'indices'};
328 $self->error('No indices');
329 return wantarray ? () : undef;
333 # ----------------------------------------------------------------------
340 Returns a field by the name provided.
342 my $field = $table->get_field('foo');
347 my $field_name = shift or return $self->error('No field name');
348 return $self->error( qq[Field "$field_name" does not exist] ) unless
349 exists $self->{'fields'}{ $field_name };
350 return $self->{'fields'}{ $field_name };
353 # ----------------------------------------------------------------------
360 Returns all the field objects as an array or array reference.
362 my @fields = $table->get_fields;
369 sort { $a->[0] <=> $b->[0] }
370 map { [ $_->order, $_ ] }
371 values %{ $self->{'fields'} || {} };
374 return wantarray ? @fields : \@fields;
377 $self->error('No fields');
378 return wantarray ? () : undef;
382 # ----------------------------------------------------------------------
389 Determine whether the view is valid or not.
391 my $ok = $view->is_valid;
396 return $self->error('No name') unless $self->name;
397 return $self->error('No fields') unless $self->get_fields;
400 $self->get_fields, $self->get_indices, $self->get_constraints
402 return $object->error unless $object->is_valid;
408 # ----------------------------------------------------------------------
415 Get or set the table's name.
417 If provided an argument, checks the schema object for a table of
418 that name and disallows the change if one exists.
420 my $table_name = $table->name('foo');
426 if ( my $arg = shift ) {
427 if ( my $schema = $self->schema ) {
428 return $self->error( qq[Can't use table name "$arg": table exists] )
429 if $schema->get_table( $arg );
431 $self->{'name'} = $arg;
434 return $self->{'name'} || '';
437 # ----------------------------------------------------------------------
444 Get or set the table's schema object.
446 my $schema = $table->schema;
451 if ( my $arg = shift ) {
452 return $self->error('Not a schema object') unless
453 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
454 $self->{'schema'} = $arg;
457 return $self->{'schema'};
460 # ----------------------------------------------------------------------
467 Gets or sets the table's primary key(s). Takes one or more field
468 names (as a string, list or array[ref]) as an argument. If the field
469 names are present, it will create a new PK if none exists, or it will
470 add to the fields of an existing PK (and will unique the field names).
471 Returns the C<SQL::Translator::Schema::Constraint> object representing
476 $table->primary_key('id');
477 $table->primary_key(['name']);
478 $table->primary_key('id','name']);
479 $table->primary_key(['id','name']);
480 $table->primary_key('id,name');
481 $table->primary_key(qw[ id name ]);
483 my $pk = $table->primary_key;
488 my $fields = parse_list_arg( @_ );
492 for my $f ( @$fields ) {
493 return $self->error(qq[Invalid field "$f"]) unless
494 $self->get_field($f);
498 for my $c ( $self->get_constraints ) {
499 if ( $c->type eq PRIMARY_KEY ) {
501 $c->fields( @{ $c->fields }, @$fields );
507 $constraint = $self->add_constraint(
518 for my $c ( $self->get_constraints ) {
519 return $c if $c->type eq PRIMARY_KEY;
526 # ----------------------------------------------------------------------
533 Get or set the table's options (e.g., table types for MySQL). Returns
534 an array or array reference.
536 my @options = $table->options;
541 my $options = parse_list_arg( @_ );
543 push @{ $self->{'options'} }, @$options;
545 if ( ref $self->{'options'} ) {
546 return wantarray ? @{ $self->{'options'} || [] } : $self->{'options'};
549 return wantarray ? () : [];
553 # ----------------------------------------------------------------------
560 Get or set the table's order.
562 my $order = $table->order(3);
566 my ( $self, $arg ) = @_;
568 if ( defined $arg && $arg =~ /^\d+$/ ) {
569 $self->{'order'} = $arg;
572 return $self->{'order'} || 0;
575 # ----------------------------------------------------------------------
578 undef $self->{'schema'}; # destroy cyclical reference
579 undef $_ for @{ $self->{'constraints'} };
580 undef $_ for @{ $self->{'indices'} };
581 undef $_ for values %{ $self->{'fields'} };
586 # ----------------------------------------------------------------------
592 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>