lib/SQL/Translator/Schema/Table.pm

   1 package SQL::Translator::Schema::Table;
   2
   3 # ----------------------------------------------------------------------
   4 # $Id: Table.pm,v 1.18 2003-08-29 14:54:01 kycl4rk Exp $
   5 # ----------------------------------------------------------------------
   6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
   7 #
   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.
  11 #
  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.
  16 #
  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
  20 # 02111-1307  USA
  21 # -------------------------------------------------------------------
  22
  23 =pod
  24
  25 =head1 NAME
  26
  27 SQL::Translator::Schema::Table - SQL::Translator table object
  28
  29 =head1 SYNOPSIS
  30
  31   use SQL::Translator::Schema::Table;
  32   my $table = SQL::Translator::Schema::Table->new( name => 'foo' );
  33
  34 =head1 DESCSIPTION
  35
  36 C<SQL::Translator::Schema::Table> is the table object.
  37
  38 =head1 METHODS
  39
  40 =cut
  41
  42 use strict;
  43 use Class::Base;
  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;
  49 use Data::Dumper;
  50
  51 use base 'Class::Base';
  52 use vars qw( $VERSION $FIELD_ORDER );
  53
  54 $VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/;
  55
  56 # ----------------------------------------------------------------------
  57 sub init {
  58
  59 =pod
  60
  61 =head2 new
  62
  63 Object constructor.
  64
  65   my $table  =  SQL::Translator::Schema::Table->new(
  66       schema => $schema,
  67       name   => 'foo',
  68   );
  69
  70 =cut
  71
  72     my ( $self, $config ) = @_;
  73
  74     for my $arg ( qw[ schema name comments ] ) {
  75         next unless defined $config->{ $arg };
  76         defined $self->$arg( $config->{ $arg } ) or return;
  77     }
  78
  79     return $self;
  80 }
  81
  82 # ----------------------------------------------------------------------
  83 sub add_constraint {
  84
  85 =pod
  86
  87 =head2 add_constraint
  88
  89 Add a constraint to the table.  Returns the newly created
  90 C<SQL::Translator::Schema::Constraint> object.
  91
  92   my $c1     = $table->add_constraint(
  93       name   => 'pk',
  94       type   => PRIMARY_KEY,
  95       fields => [ 'foo_id' ],
  96   );
  97
  98   my $c2 = SQL::Translator::Schema::Constraint->new( name => 'uniq' );
  99   $c2    = $table->add_constraint( $constraint );
 100
 101 =cut
 102
 103     my $self             = shift;
 104     my $constraint_class = 'SQL::Translator::Schema::Constraint';
 105     my $constraint;
 106
 107     if ( UNIVERSAL::isa( $_[0], $constraint_class ) ) {
 108         $constraint = shift;
 109         $constraint->table( $self );
 110     }
 111     else {
 112         my %args = @_;
 113         $args{'table'} = $self;
 114         $constraint = $constraint_class->new( \%args ) or
 115             return $self->error( $constraint_class->error );
 116     }
 117
 118     #
 119     # If we're trying to add a PK when one is already defined,
 120     # then just add the fields to the existing definition.
 121     #
 122     my $ok = 1;
 123     my $pk = $self->primary_key;
 124     if ( $pk && $constraint->type eq PRIMARY_KEY ) {
 125         $self->primary_key( $constraint->fields );
 126         $constraint = $pk;
 127         $ok         = 0;
 128     }
 129     elsif ( $constraint->type eq PRIMARY_KEY ) {
 130         for my $fname ( $constraint->fields ) {
 131             if ( my $f = $self->get_field( $fname ) ) {
 132                 $f->is_primary_key( 1 );
 133             }
 134         }
 135     }
 136     #
 137     # See if another constraint of the same type
 138     # covers the same fields.
 139     #
 140     elsif ( $constraint->type ne CHECK_C ) {
 141         my @field_names = $constraint->fields;
 142         for my $c (
 143             grep { $_->type eq $constraint->type }
 144             $self->get_constraints
 145         ) {
 146             my %fields = map { $_, 1 } $c->fields;
 147             for my $field_name ( @field_names ) {
 148                 if ( $fields{ $field_name } ) {
 149                     $constraint = $c;
 150                     $ok = 0;
 151                     last;
 152                 }
 153             }
 154             last unless $ok;
 155         }
 156     }
 157
 158     if ( $ok ) {
 159         push @{ $self->{'constraints'} }, $constraint;
 160     }
 161
 162     return $constraint;
 163 }
 164
 165 # ----------------------------------------------------------------------
 166 sub add_index {
 167
 168 =pod
 169
 170 =head2 add_index
 171
 172 Add an index to the table.  Returns the newly created
 173 C<SQL::Translator::Schema::Index> object.
 174
 175   my $i1     = $table->add_index(
 176       name   => 'name',
 177       fields => [ 'name' ],
 178       type   => 'normal',
 179   );
 180
 181   my $i2 = SQL::Translator::Schema::Index->new( name => 'id' );
 182   $i2    = $table->add_index( $index );
 183
 184 =cut
 185
 186     my $self        = shift;
 187     my $index_class = 'SQL::Translator::Schema::Index';
 188     my $index;
 189
 190     if ( UNIVERSAL::isa( $_[0], $index_class ) ) {
 191         $index = shift;
 192         $index->table( $self );
 193     }
 194     else {
 195         my %args = @_;
 196         $args{'table'} = $self;
 197         $index = $index_class->new( \%args ) or return
 198             $self->error( $index_class->error );
 199     }
 200
 201     push @{ $self->{'indices'} }, $index;
 202     return $index;
 203 }
 204
 205 # ----------------------------------------------------------------------
 206 sub add_field {
 207
 208 =pod
 209
 210 =head2 add_field
 211
 212 Add an field to the table.  Returns the newly created
 213 C<SQL::Translator::Schema::Field> object.  The "name" parameter is
 214 required.  If you try to create a field with the same name as an
 215 existing field, you will get an error and the field will not be created.
 216
 217   my $f1        =  $table->add_field(
 218       name      => 'foo_id',
 219       data_type => 'integer',
 220       size      => 11,
 221   );
 222
 223   my $f2     =  SQL::Translator::Schema::Field->new(
 224       name   => 'name',
 225       table  => $table,
 226   );
 227   $f2 = $table->add_field( $field2 ) or die $table->error;
 228
 229 =cut
 230
 231     my $self        = shift;
 232     my $field_class = 'SQL::Translator::Schema::Field';
 233     my $field;
 234
 235     if ( UNIVERSAL::isa( $_[0], $field_class ) ) {
 236         $field = shift;
 237         $field->table( $self );
 238     }
 239     else {
 240         my %args = @_;
 241         $args{'table'} = $self;
 242         $field = $field_class->new( \%args ) or return
 243             $self->error( $field_class->error );
 244     }
 245
 246     $field->order( ++$FIELD_ORDER );
 247     my $field_name = $field->name or return $self->error('No name');
 248
 249     if ( exists $self->{'fields'}{ $field_name } ) {
 250         return $self->error(qq[Can't create field: "$field_name" exists]);
 251     }
 252     else {
 253         $self->{'fields'}{ $field_name } = $field;
 254     }
 255
 256     return $field;
 257 }
 258
 259 # ----------------------------------------------------------------------
 260 sub comments {
 261
 262 =pod
 263
 264 =head2 comments
 265
 266 Get or set the comments on a table.  May be called several times to
 267 set and it will accumulate the comments.  Called in an array context,
 268 returns each comment individually; called in a scalar context, returns
 269 all the comments joined on newlines.
 270
 271   $table->comments('foo');
 272   $table->comments('bar');
 273   print join( ', ', $table->comments ); # prints "foo, bar"
 274
 275 =cut
 276
 277     my $self     = shift;
 278     my @comments = ref $_[0] ? @{ $_[0] } : @_;
 279
 280     for my $arg ( @comments ) {
 281         $arg = $arg->[0] if ref $arg;
 282         push @{ $self->{'comments'} }, $arg if defined $arg && $arg;
 283     }
 284
 285     if ( @{ $self->{'comments'} || [] } ) {
 286         return wantarray
 287             ? @{ $self->{'comments'} }
 288             : join( "\n", @{ $self->{'comments'} } )
 289         ;
 290     }
 291     else {
 292         return wantarray ? () : undef;
 293     }
 294 }
 295
 296 # ----------------------------------------------------------------------
 297 sub get_constraints {
 298
 299 =pod
 300
 301 =head2 get_constraints
 302
 303 Returns all the constraint objects as an array or array reference.
 304
 305   my @constraints = $table->get_constraints;
 306
 307 =cut
 308
 309     my $self = shift;
 310
 311     if ( ref $self->{'constraints'} ) {
 312         return wantarray
 313             ? @{ $self->{'constraints'} } : $self->{'constraints'};
 314     }
 315     else {
 316         $self->error('No constraints');
 317         return wantarray ? () : undef;
 318     }
 319 }
 320
 321 # ----------------------------------------------------------------------
 322 sub get_indices {
 323
 324 =pod
 325
 326 =head2 get_indices
 327
 328 Returns all the index objects as an array or array reference.
 329
 330   my @indices = $table->get_indices;
 331
 332 =cut
 333
 334     my $self = shift;
 335
 336     if ( ref $self->{'indices'} ) {
 337         return wantarray
 338             ? @{ $self->{'indices'} }
 339             : $self->{'indices'};
 340     }
 341     else {
 342         $self->error('No indices');
 343         return wantarray ? () : undef;
 344     }
 345 }
 346
 347 # ----------------------------------------------------------------------
 348 sub get_field {
 349
 350 =pod
 351
 352 =head2 get_field
 353
 354 Returns a field by the name provided.
 355
 356   my $field = $table->get_field('foo');
 357
 358 =cut
 359
 360     my $self       = shift;
 361     my $field_name = shift or return $self->error('No field name');
 362     return $self->error( qq[Field "$field_name" does not exist] ) unless
 363         exists $self->{'fields'}{ $field_name };
 364     return $self->{'fields'}{ $field_name };
 365 }
 366
 367 # ----------------------------------------------------------------------
 368 sub get_fields {
 369
 370 =pod
 371
 372 =head2 get_fields
 373
 374 Returns all the field objects as an array or array reference.
 375
 376   my @fields = $table->get_fields;
 377
 378 =cut
 379
 380     my $self = shift;
 381     my @fields =
 382         map  { $_->[1] }
 383         sort { $a->[0] <=> $b->[0] }
 384         map  { [ $_->order, $_ ] }
 385         values %{ $self->{'fields'} || {} };
 386
 387     if ( @fields ) {
 388         return wantarray ? @fields : \@fields;
 389     }
 390     else {
 391         $self->error('No fields');
 392         return wantarray ? () : undef;
 393     }
 394 }
 395
 396 # ----------------------------------------------------------------------
 397 sub is_valid {
 398
 399 =pod
 400
 401 =head2 is_valid
 402
 403 Determine whether the view is valid or not.
 404
 405   my $ok = $view->is_valid;
 406
 407 =cut
 408
 409     my $self = shift;
 410     return $self->error('No name')   unless $self->name;
 411     return $self->error('No fields') unless $self->get_fields;
 412
 413     for my $object (
 414         $self->get_fields, $self->get_indices, $self->get_constraints
 415     ) {
 416         return $object->error unless $object->is_valid;
 417     }
 418
 419     return 1;
 420 }
 421
 422 # ----------------------------------------------------------------------
 423 sub is_data {
 424
 425 =pod
 426
 427 =head2 is_data
 428
 429 =cut
 430
 431     my $self = shift;
 432     return $self->{'is_data'} if defined $self->{'is_data'};
 433
 434     $self->{'is_data'} = 0;
 435
 436     foreach my $field ( $self->get_fields ) {
 437         if ( !$field->is_primary_key and !$field->is_foreign_key ) {
 438             $self->{'is_data'} = 1;
 439             return $self->{'is_data'};
 440         }
 441     }
 442
 443     return $self->{'is_data'};
 444 }
 445
 446 # ----------------------------------------------------------------------
 447 sub can_link {
 448
 449 =pod
 450
 451 =head2 can_link
 452
 453 Determine whether the table can link two arg tables via many-to-many.
 454
 455   my $ok = $table->can_link($table1,$table2);
 456
 457 =cut
 458
 459     my ( $self, $table1, $table2 ) = @_;
 460
 461     return $self->{'can_link'}{ $table1->name }{ $table2->name }
 462       if defined $self->{'can_link'}{ $table1->name }{ $table2->name };
 463
 464     if ( $self->is_data == 1 ) {
 465         $self->{'can_link'}{ $table1->name }{ $table2->name } = [0];
 466         $self->{'can_link'}{ $table2->name }{ $table1->name } = [0];
 467         return $self->{'can_link'}{ $table1->name }{ $table2->name };
 468     }
 469
 470     my %fk = ();
 471
 472     foreach my $field ( $self->get_fields ) {
 473         if ( $field->is_foreign_key ) {
 474             push @{ $fk{ $field->foreign_key_reference->reference_table } },
 475               $field->foreign_key_reference;
 476         }
 477     }
 478
 479     if ( !defined( $fk{ $table1->name } ) or !defined( $fk{ $table2->name } ) )
 480     {
 481         $self->{'can_link'}{ $table1->name }{ $table2->name } = [0];
 482         $self->{'can_link'}{ $table2->name }{ $table1->name } = [0];
 483         return $self->{'can_link'}{ $table1->name }{ $table2->name };
 484     }
 485
 486     # trivial traversal, only one way to link the two tables
 487     if (    scalar( @{ $fk{ $table1->name } } == 1 )
 488         and scalar( @{ $fk{ $table2->name } } == 1 ) )
 489     {
 490         $self->{'can_link'}{ $table1->name }{ $table2->name } =
 491           [ 'one2one', $fk{ $table1->name }, $fk{ $table2->name } ];
 492         $self->{'can_link'}{ $table1->name }{ $table2->name } =
 493           [ 'one2one', $fk{ $table2->name }, $fk{ $table1->name } ];
 494
 495         # non-trivial traversal.  one way to link table2,
 496         # many ways to link table1
 497     }
 498     elsif ( scalar( @{ $fk{ $table1->name } } > 1 )
 499         and scalar( @{ $fk{ $table2->name } } == 1 ) )
 500     {
 501         $self->{'can_link'}{ $table1->name }{ $table2->name } =
 502           [ 'many2one', $fk{ $table1->name }, $fk{ $table2->name } ];
 503         $self->{'can_link'}{ $table2->name }{ $table1->name } =
 504           [ 'one2many', $fk{ $table2->name }, $fk{ $table1->name } ];
 505
 506         # non-trivial traversal.  one way to link table1,
 507         # many ways to link table2
 508     }
 509     elsif ( scalar( @{ $fk{ $table1->name } } == 1 )
 510         and scalar( @{ $fk{ $table2->name } } > 1 ) )
 511     {
 512         $self->{'can_link'}{ $table1->name }{ $table2->name } =
 513           [ 'one2many', $fk{ $table1->name }, $fk{ $table2->name } ];
 514         $self->{'can_link'}{ $table2->name }{ $table1->name } =
 515           [ 'many2one', $fk{ $table2->name }, $fk{ $table1->name } ];
 516
 517         # non-trivial traversal.  many ways to link table1 and table2
 518     }
 519     elsif ( scalar( @{ $fk{ $table1->name } } > 1 )
 520         and scalar( @{ $fk{ $table2->name } } > 1 ) )
 521     {
 522         $self->{'can_link'}{ $table1->name }{ $table2->name } =
 523           [ 'many2many', $fk{ $table1->name }, $fk{ $table2->name } ];
 524         $self->{'can_link'}{ $table2->name }{ $table1->name } =
 525           [ 'many2many', $fk{ $table2->name }, $fk{ $table1->name } ];
 526
 527         # one of the tables didn't export a key
 528         # to this table, no linking possible
 529     }
 530     else {
 531         $self->{'can_link'}{ $table1->name }{ $table2->name } = [0];
 532         $self->{'can_link'}{ $table2->name }{ $table1->name } = [0];
 533     }
 534
 535     return $self->{'can_link'}{ $table1->name }{ $table2->name };
 536 }
 537
 538 # ----------------------------------------------------------------------
 539 sub name {
 540
 541 =pod
 542
 543 =head2 name
 544
 545 Get or set the table's name.
 546
 547 If provided an argument, checks the schema object for a table of
 548 that name and disallows the change if one exists.
 549
 550   my $table_name = $table->name('foo');
 551
 552 =cut
 553
 554     my $self = shift;
 555
 556     if ( my $arg = shift ) {
 557         if ( my $schema = $self->schema ) {
 558             return $self->error( qq[Can't use table name "$arg": table exists] )
 559                 if $schema->get_table( $arg );
 560         }
 561         $self->{'name'} = $arg;
 562     }
 563
 564     return $self->{'name'} || '';
 565 }
 566
 567 # ----------------------------------------------------------------------
 568 sub schema {
 569
 570 =pod
 571
 572 =head2 schema
 573
 574 Get or set the table's schema object.
 575
 576   my $schema = $table->schema;
 577
 578 =cut
 579
 580     my $self = shift;
 581     if ( my $arg = shift ) {
 582         return $self->error('Not a schema object') unless
 583             UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
 584         $self->{'schema'} = $arg;
 585     }
 586
 587     return $self->{'schema'};
 588 }
 589
 590 # ----------------------------------------------------------------------
 591 sub primary_key {
 592
 593 =pod
 594
 595 =head2 primary_key
 596
 597 Gets or sets the table's primary key(s).  Takes one or more field
 598 names (as a string, list or array[ref]) as an argument.  If the field
 599 names are present, it will create a new PK if none exists, or it will
 600 add to the fields of an existing PK (and will unique the field names).
 601 Returns the C<SQL::Translator::Schema::Constraint> object representing
 602 the primary key.
 603
 604 These are eqivalent:
 605
 606   $table->primary_key('id');
 607   $table->primary_key(['name']);
 608   $table->primary_key('id','name']);
 609   $table->primary_key(['id','name']);
 610   $table->primary_key('id,name');
 611   $table->primary_key(qw[ id name ]);
 612
 613   my $pk = $table->primary_key;
 614
 615 =cut
 616
 617     my $self   = shift;
 618     my $fields = parse_list_arg( @_ );
 619
 620     my $constraint;
 621     if ( @$fields ) {
 622         for my $f ( @$fields ) {
 623             return $self->error(qq[Invalid field "$f"]) unless
 624                 $self->get_field($f);
 625         }
 626
 627         my $has_pk;
 628         for my $c ( $self->get_constraints ) {
 629             if ( $c->type eq PRIMARY_KEY ) {
 630                 $has_pk = 1;
 631                 $c->fields( @{ $c->fields }, @$fields );
 632                 $constraint = $c;
 633             }
 634         }
 635
 636         unless ( $has_pk ) {
 637             $constraint = $self->add_constraint(
 638                 type   => PRIMARY_KEY,
 639                 fields => $fields,
 640             ) or return;
 641         }
 642     }
 643
 644     if ( $constraint ) {
 645         return $constraint;
 646     }
 647     else {
 648         for my $c ( $self->get_constraints ) {
 649             return $c if $c->type eq PRIMARY_KEY;
 650         }
 651     }
 652
 653     return;
 654 }
 655
 656 # ----------------------------------------------------------------------
 657 sub options {
 658
 659 =pod
 660
 661 =head2 options
 662
 663 Get or set the table's options (e.g., table types for MySQL).  Returns
 664 an array or array reference.
 665
 666   my @options = $table->options;
 667
 668 =cut
 669
 670     my $self    = shift;
 671     my $options = parse_list_arg( @_ );
 672
 673     push @{ $self->{'options'} }, @$options;
 674
 675     if ( ref $self->{'options'} ) {
 676         return wantarray ? @{ $self->{'options'} || [] } : $self->{'options'};
 677     }
 678     else {
 679         return wantarray ? () : [];
 680     }
 681 }
 682
 683 # ----------------------------------------------------------------------
 684 sub order {
 685
 686 =pod
 687
 688 =head2 order
 689
 690 Get or set the table's order.
 691
 692   my $order = $table->order(3);
 693
 694 =cut
 695
 696     my ( $self, $arg ) = @_;
 697
 698     if ( defined $arg && $arg =~ /^\d+$/ ) {
 699         $self->{'order'} = $arg;
 700     }
 701
 702     return $self->{'order'} || 0;
 703 }
 704
 705 # ----------------------------------------------------------------------
 706 sub DESTROY {
 707     my $self = shift;
 708     undef $self->{'schema'}; # destroy cyclical reference
 709     undef $_ for @{ $self->{'constraints'} };
 710     undef $_ for @{ $self->{'indices'} };
 711     undef $_ for values %{ $self->{'fields'} };
 712 }
 713
 714 1;
 715
 716 # ----------------------------------------------------------------------
 717
 718 =pod
 719
 720 =head1 AUTHORS
 721
 722 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
 723 Allen Day E<lt>allenday@ucla.eduE<gt>.
 724
 725 =cut