1 package SQL::Translator::Schema::Table;
3 # ----------------------------------------------------------------------
4 # $Id: Table.pm,v 1.7 2003-06-06 22:36:09 kycl4rk 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 );
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 push @{ $self->{'comments'} }, @_ if @_;
270 ? @{ $self->{'comments'} || [] }
271 : join( "\n", @{ $self->{'comments'} || [] } );
274 # ----------------------------------------------------------------------
275 sub get_constraints {
279 =head2 get_constraints
281 Returns all the constraint objects as an array or array reference.
283 my @constraints = $table->get_constraints;
289 if ( ref $self->{'constraints'} ) {
291 ? @{ $self->{'constraints'} } : $self->{'constraints'};
294 $self->error('No constraints');
295 return wantarray ? () : undef;
299 # ----------------------------------------------------------------------
306 Returns all the index objects as an array or array reference.
308 my @indices = $table->get_indices;
314 if ( ref $self->{'indices'} ) {
316 ? @{ $self->{'indices'} }
317 : $self->{'indices'};
320 $self->error('No indices');
321 return wantarray ? () : undef;
325 # ----------------------------------------------------------------------
332 Returns a field by the name provided.
334 my $field = $table->get_field('foo');
339 my $field_name = shift or return $self->error('No field name');
340 return $self->error( qq[Field "$field_name" does not exist] ) unless
341 exists $self->{'fields'}{ $field_name };
342 return $self->{'fields'}{ $field_name };
345 # ----------------------------------------------------------------------
352 Returns all the field objects as an array or array reference.
354 my @fields = $table->get_fields;
361 sort { $a->[0] <=> $b->[0] }
362 map { [ $_->order, $_ ] }
363 values %{ $self->{'fields'} || {} };
366 return wantarray ? @fields : \@fields;
369 $self->error('No fields');
370 return wantarray ? () : undef;
374 # ----------------------------------------------------------------------
381 Determine whether the view is valid or not.
383 my $ok = $view->is_valid;
388 return $self->error('No name') unless $self->name;
389 return $self->error('No fields') unless $self->get_fields;
392 $self->get_fields, $self->get_indices, $self->get_constraints
394 return $object->error unless $object->is_valid;
400 # ----------------------------------------------------------------------
407 Get or set the table's name.
409 If provided an argument, checks the schema object for a table of
410 that name and disallows the change if one exists.
412 my $table_name = $table->name('foo');
418 if ( my $arg = shift ) {
419 if ( my $schema = $self->schema ) {
420 return $self->error( qq[Can't use table name "$arg": table exists] )
421 if $schema->get_table( $arg );
423 $self->{'name'} = $arg;
426 return $self->{'name'} || '';
429 # ----------------------------------------------------------------------
436 Get or set the table's schema object.
438 my $schema = $table->schema;
443 if ( my $arg = shift ) {
444 return $self->error('Not a schema object') unless
445 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
446 $self->{'schema'} = $arg;
449 return $self->{'schema'};
452 # ----------------------------------------------------------------------
459 Gets or sets the table's primary key(s). Takes one or more field
460 names (as a string, list or array[ref]) as an argument. If the field
461 names are present, it will create a new PK if none exists, or it will
462 add to the fields of an existing PK (and will unique the field names).
463 Returns the C<SQL::Translator::Schema::Constraint> object representing
468 $table->primary_key('id');
469 $table->primary_key(['name']);
470 $table->primary_key('id','name']);
471 $table->primary_key(['id','name']);
472 $table->primary_key('id,name');
473 $table->primary_key(qw[ id name ]);
475 my $pk = $table->primary_key;
480 my $fields = parse_list_arg( @_ );
484 for my $f ( @$fields ) {
485 return $self->error(qq[Invalid field "$f"]) unless
486 $self->get_field($f);
490 for my $c ( $self->get_constraints ) {
491 if ( $c->type eq PRIMARY_KEY ) {
493 $c->fields( @{ $c->fields }, @$fields );
499 $constraint = $self->add_constraint(
510 for my $c ( $self->get_constraints ) {
511 return $c if $c->type eq PRIMARY_KEY;
518 # ----------------------------------------------------------------------
525 Get or set the table's options (e.g., table types for MySQL). Returns
526 an array or array reference.
528 my @options = $table->options;
533 my $options = parse_list_arg( @_ );
535 push @{ $self->{'options'} }, @$options;
537 if ( ref $self->{'options'} ) {
538 return wantarray ? @{ $self->{'options'} || [] } : $self->{'options'};
541 return wantarray ? () : [];
545 # ----------------------------------------------------------------------
552 Get or set the table's order.
554 my $order = $table->order(3);
558 my ( $self, $arg ) = @_;
560 if ( defined $arg && $arg =~ /^\d+$/ ) {
561 $self->{'order'} = $arg;
564 return $self->{'order'} || 0;
567 # ----------------------------------------------------------------------
570 undef $self->{'schema'}; # destroy cyclical reference
571 undef $_ for @{ $self->{'constraints'} };
572 undef $_ for @{ $self->{'indices'} };
573 undef $_ for values %{ $self->{'fields'} };
578 # ----------------------------------------------------------------------
584 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>