lib/SQL/Translator/Parser/PostgreSQL.pm

   1 package SQL::Translator::Parser::PostgreSQL;
   2
   3 # -------------------------------------------------------------------
   4 # $Id: PostgreSQL.pm,v 1.43 2004-10-23 20:18:44 cmungall Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2002-4 SQLFairy Authors
   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 =head1 NAME
  24
  25 SQL::Translator::Parser::PostgreSQL - parser for PostgreSQL
  26
  27 =head1 SYNOPSIS
  28
  29   use SQL::Translator;
  30   use SQL::Translator::Parser::PostgreSQL;
  31
  32   my $translator = SQL::Translator->new;
  33   $translator->parser("SQL::Translator::Parser::PostgreSQL");
  34
  35 =head1 DESCRIPTION
  36
  37 The grammar was started from the MySQL parsers.  Here is the description
  38 from PostgreSQL:
  39
  40 Table:
  41 (http://www.postgresql.org/docs/view.php?version=7.3&idoc=1&file=sql-createtable.html)
  42
  43   CREATE [ [ LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name (
  44       { column_name data_type [ DEFAULT default_expr ]
  45          [ column_constraint [, ... ] ]
  46       | table_constraint }  [, ... ]
  47   )
  48   [ INHERITS ( parent_table [, ... ] ) ]
  49   [ WITH OIDS | WITHOUT OIDS ]
  50
  51   where column_constraint is:
  52
  53   [ CONSTRAINT constraint_name ]
  54   { NOT NULL | NULL | UNIQUE | PRIMARY KEY |
  55     CHECK (expression) |
  56     REFERENCES reftable [ ( refcolumn ) ] [ MATCH FULL | MATCH PARTIAL ]
  57       [ ON DELETE action ] [ ON UPDATE action ] }
  58   [ DEFERRABLE | NOT DEFERRABLE ]
  59   [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
  60
  61   and table_constraint is:
  62
  63   [ CONSTRAINT constraint_name ]
  64   { UNIQUE ( column_name [, ... ] ) |
  65     PRIMARY KEY ( column_name [, ... ] ) |
  66     CHECK ( expression ) |
  67     FOREIGN KEY ( column_name [, ... ] )
  68      REFERENCES reftable [ ( refcolumn [, ... ] ) ]
  69       [ MATCH FULL | MATCH PARTIAL ]
  70       [ ON DELETE action ] [ ON UPDATE action ] }
  71   [ DEFERRABLE | NOT DEFERRABLE ]
  72   [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
  73
  74 Index:
  75 (http://www.postgresql.org/docs/view.php?version=7.3&idoc=1&file=sql-createindex.html)
  76
  77   CREATE [ UNIQUE ] INDEX index_name ON table
  78       [ USING acc_method ] ( column [ ops_name ] [, ...] )
  79       [ WHERE predicate ]
  80   CREATE [ UNIQUE ] INDEX index_name ON table
  81       [ USING acc_method ] ( func_name( column [, ... ]) [ ops_name ] )
  82       [ WHERE predicate ]
  83
  84 Alter table:
  85
  86   ALTER TABLE [ ONLY ] table [ * ]
  87       ADD [ COLUMN ] column type [ column_constraint [ ... ] ]
  88   ALTER TABLE [ ONLY ] table [ * ]
  89       ALTER [ COLUMN ] column { SET DEFAULT value | DROP DEFAULT }
  90   ALTER TABLE [ ONLY ] table [ * ]
  91       ALTER [ COLUMN ] column SET STATISTICS integer
  92   ALTER TABLE [ ONLY ] table [ * ]
  93       RENAME [ COLUMN ] column TO newcolumn
  94   ALTER TABLE table
  95       RENAME TO new_table
  96   ALTER TABLE table
  97       ADD table_constraint_definition
  98   ALTER TABLE [ ONLY ] table
  99           DROP CONSTRAINT constraint { RESTRICT | CASCADE }
 100   ALTER TABLE table
 101           OWNER TO new_owner
 102
 103 View table:
 104
 105     CREATE [ OR REPLACE ] VIEW view [ ( column name list ) ] AS SELECT query
 106
 107 =cut
 108
 109 use strict;
 110 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
 111 $VERSION = sprintf "%d.%02d", q$Revision: 1.43 $ =~ /(\d+)\.(\d+)/;
 112 $DEBUG   = 0 unless defined $DEBUG;
 113
 114 use Data::Dumper;
 115 use Parse::RecDescent;
 116 use Exporter;
 117 use base qw(Exporter);
 118
 119 @EXPORT_OK = qw(parse);
 120
 121 # Enable warnings within the Parse::RecDescent module.
 122 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
 123 $::RD_WARN   = 1; # Enable warnings. This will warn on unused rules &c.
 124 $::RD_HINT   = 1; # Give out hints to help fix problems.
 125
 126 my $parser; # should we do this?  There's no programmic way to
 127             # change the grammar, so I think this is safe.
 128
 129 $GRAMMAR = q!
 130
 131 { my ( %tables, $table_order, $field_order, @table_comments) }
 132
 133 #
 134 # The "eofile" rule makes the parser fail if any "statement" rule
 135 # fails.  Otherwise, the first successful match by a "statement"
 136 # won't cause the failure needed to know that the parse, as a whole,
 137 # failed. -ky
 138 #
 139 startrule : statement(s) eofile { \%tables }
 140
 141 eofile : /^\Z/
 142
 143
 144 statement : create
 145   | comment_on_table
 146   | comment_on_column
 147   | comment_on_other
 148   | comment
 149   | alter
 150   | grant
 151   | revoke
 152   | drop
 153   | insert
 154   | connect
 155   | update
 156   | set
 157   | <error>
 158
 159 connect : /^\s*\\\connect.*\n/
 160
 161 set : /set/i /[^;]*/ ';'
 162
 163 revoke : /revoke/i WORD(s /,/) /on/i TABLE(?) table_name /from/i name_with_opt_quotes(s /,/) ';'
 164     {
 165         my $table_name = $item{'table_name'};
 166         push @{ $tables{ $table_name }{'permissions'} }, {
 167             type       => 'revoke',
 168             actions    => $item[2],
 169             users      => $item[7],
 170         }
 171     }
 172
 173 grant : /grant/i WORD(s /,/) /on/i TABLE(?) table_name /to/i name_with_opt_quotes(s /,/) ';'
 174     {
 175         my $table_name = $item{'table_name'};
 176         push @{ $tables{ $table_name }{'permissions'} }, {
 177             type       => 'grant',
 178             actions    => $item[2],
 179             users      => $item[7],
 180         }
 181     }
 182
 183 drop : /drop/i /[^;]*/ ';'
 184
 185 insert : /insert/i /[^;]*/ ';'
 186
 187 update : /update/i /[^;]*/ ';'
 188
 189 #
 190 # Create table.
 191 #
 192 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
 193     {
 194         my $table_name                       = $item{'table_name'};
 195         $tables{ $table_name }{'order'}      = ++$table_order;
 196         $tables{ $table_name }{'table_name'} = $table_name;
 197
 198         if ( @table_comments ) {
 199             $tables{ $table_name }{'comments'} = [ @table_comments ];
 200             @table_comments = ();
 201         }
 202
 203         my @constraints;
 204         for my $definition ( @{ $item[4] } ) {
 205             if ( $definition->{'supertype'} eq 'field' ) {
 206                 my $field_name = $definition->{'name'};
 207                 $tables{ $table_name }{'fields'}{ $field_name } =
 208                     { %$definition, order => $field_order++ };
 209
 210                 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
 211                     $constraint->{'fields'} = [ $field_name ];
 212                     push @{ $tables{ $table_name }{'constraints'} },
 213                         $constraint;
 214                 }
 215             }
 216             elsif ( $definition->{'supertype'} eq 'constraint' ) {
 217                 push @{ $tables{ $table_name }{'constraints'} }, $definition;
 218             }
 219             elsif ( $definition->{'supertype'} eq 'index' ) {
 220                 push @{ $tables{ $table_name }{'indices'} }, $definition;
 221             }
 222         }
 223
 224         for my $option ( @{ $item[6] } ) {
 225             $tables{ $table_name }{'table_options(s?)'}{ $option->{'type'} } =
 226                 $option;
 227         }
 228
 229         1;
 230     }
 231
 232 create : CREATE unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
 233     {
 234         push @{ $tables{ $item{'table_name'} }{'indices'} },
 235             {
 236                 name      => $item{'index_name'},
 237                 supertype => $item{'unique'}[0] ? 'constraint' : 'index',
 238                 type      => $item{'unique'}[0] ? 'unique'     : 'normal',
 239                 fields    => $item[9],
 240                 method    => $item{'using_method'}[0],
 241             }
 242         ;
 243
 244     }
 245
 246 #
 247 # Create anything else (e.g., domain, etc.)
 248 #
 249 create : CREATE WORD /[^;]+/ ';'
 250     { @table_comments = (); }
 251
 252 using_method : /using/i WORD { $item[2] }
 253
 254 where_predicate : /where/i /[^;]+/
 255
 256 create_definition : field
 257     | table_constraint
 258     | <error>
 259
 260 comment : /^\s*(?:#|-{2})(.*)\n/
 261     {
 262         my $comment =  $item[1];
 263         $comment    =~ s/^\s*(#|-*)\s*//;
 264         $comment    =~ s/\s*$//;
 265         $return     = $comment;
 266         push @table_comments, $comment;
 267     }
 268
 269 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
 270     {
 271         push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
 272     }
 273
 274 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
 275     {
 276         my $table_name = $item[4]->{'table'};
 277         my $field_name = $item[4]->{'field'};
 278         if ($tables{ $table_name }{'fields'}{ $field_name } ) {
 279           push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
 280               $item{'comment_phrase'};
 281         }
 282         else {
 283            die "No such column as $table_name.$field_name";
 284         }
 285     }
 286
 287 comment_on_other : /comment/i /on/i /\w+/ /\w+/ /is/i comment_phrase ';'
 288     {
 289         push(@table_comments, $item{'comment_phrase'});
 290     }
 291
 292 # [added by cjm 20041019]
 293 # [TODO: other comment-on types]
 294 # for now we just have a general mechanism for handling other
 295 # kinds of comments than table/column; I'm not sure of the best
 296 # way to incorporate these into the datamodel
 297 #
 298 # this is the exhaustive list of types of comment:
 299 #COMMENT ON DATABASE my_database IS 'Development Database';
 300 #COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee id';
 301 #COMMENT ON RULE my_rule IS 'Logs UPDATES of employee records';
 302 #COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys';
 303 #COMMENT ON TABLE my_table IS 'Employee Information';
 304 #COMMENT ON TYPE my_type IS 'Complex Number support';
 305 #COMMENT ON VIEW my_view IS 'View of departmental costs';
 306 #COMMENT ON COLUMN my_table.my_field IS 'Employee ID number';
 307 #COMMENT ON TRIGGER my_trigger ON my_table IS 'Used for R.I.';
 308 #
 309 # this is tested by test 08
 310
 311 column_name : NAME '.' NAME
 312     { $return = { table => $item[1], field => $item[3] } }
 313
 314 comment_phrase : /null/i
 315     { $return = 'NULL' }
 316
 317 comment_phrase : /'/ comment_phrase_unquoted(s) /'/
 318     { my $phrase = join(' ', @{ $item[2] });
 319       $return = $phrase}
 320
 321 # [cjm TODO: double-single quotes in a comment_phrase]
 322 comment_phrase_unquoted : /[^\']*/
 323     { $return = $item[1] }
 324
 325
 326 xxxcomment_phrase : /'.*?'|NULL/
 327     {
 328         my $val = $item[1] || '';
 329         $val =~ s/^'|'$//g;
 330         $return = $val;
 331     }
 332
 333 field : field_comment(s?) field_name data_type field_meta(s?) field_comment(s?)
 334     {
 335         my ( $default, @constraints, $is_pk );
 336         my $is_nullable = 1;
 337         for my $meta ( @{ $item[4] } ) {
 338             if ( $meta->{'type'} eq 'default' ) {
 339                 $default = $meta;
 340                 next;
 341             }
 342             elsif ( $meta->{'type'} eq 'not_null' ) {
 343                 $is_nullable = 0;
 344             }
 345             elsif ( $meta->{'type'} eq 'primary_key' ) {
 346                 $is_pk = 1;
 347             }
 348
 349             push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
 350         }
 351
 352         my @comments = ( @{ $item[1] }, @{ $item[5] } );
 353
 354         $return = {
 355             supertype         => 'field',
 356             name              => $item{'field_name'},
 357             data_type         => $item{'data_type'}{'type'},
 358             size              => $item{'data_type'}{'size'},
 359             is_nullable       => $is_nullable,
 360             default           => $default->{'value'},
 361             constraints       => [ @constraints ],
 362             comments          => [ @comments ],
 363             is_primary_key    => $is_pk || 0,
 364             is_auto_increment => $item{'data_type'}{'is_auto_increment'},
 365         }
 366     }
 367     | <error>
 368
 369 field_comment : /^\s*(?:#|-{2})(.*)\n/
 370     {
 371         my $comment =  $item[1];
 372         $comment    =~ s/^\s*(#|-*)\s*//;
 373         $comment    =~ s/\s*$//;
 374         $return     = $comment;
 375     }
 376
 377 field_meta : default_val
 378     | column_constraint
 379
 380 column_constraint : constraint_name(?) column_constraint_type deferrable(?) deferred(?)
 381     {
 382         my $desc       = $item{'column_constraint_type'};
 383         my $type       = $desc->{'type'};
 384         my $fields     = $desc->{'fields'}     || [];
 385         my $expression = $desc->{'expression'} || '';
 386
 387         $return              =  {
 388             supertype        => 'constraint',
 389             name             => $item{'constraint_name'}[0] || '',
 390             type             => $type,
 391             expression       => $type eq 'check' ? $expression : '',
 392             deferrable       => $item{'deferrable'},
 393             deferred         => $item{'deferred'},
 394             reference_table  => $desc->{'reference_table'},
 395             reference_fields => $desc->{'reference_fields'},
 396             match_type       => $desc->{'match_type'},
 397             on_delete_do     => $desc->{'on_delete_do'},
 398             on_update_do     => $desc->{'on_update_do'},
 399         }
 400     }
 401
 402 constraint_name : /constraint/i name_with_opt_quotes { $item[2] }
 403
 404 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
 405     |
 406     /null/i
 407         { $return = { type => 'null' } }
 408     |
 409     /unique/i
 410         { $return = { type => 'unique' } }
 411     |
 412     /primary key/i
 413         { $return = { type => 'primary_key' } }
 414     |
 415     /check/i '(' /[^)]+/ ')'
 416         { $return = { type => 'check', expression => $item[3] } }
 417     |
 418     /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
 419     {
 420         my ( $on_delete, $on_update );
 421         for my $action ( @{ $item[5] || [] } ) {
 422             $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
 423             $on_update = $action->{'action'} if $action->{'type'} eq 'update';
 424         }
 425
 426         $return              =  {
 427             type             => 'foreign_key',
 428             reference_table  => $item[2],
 429             reference_fields => $item[3][0],
 430             match_type       => $item[4][0],
 431             on_delete_do     => $on_delete,
 432             on_update_do     => $on_update,
 433         }
 434     }
 435
 436 table_name : name_with_opt_quotes
 437
 438 field_name : name_with_opt_quotes
 439
 440 name_with_opt_quotes : double_quote(?) NAME double_quote(?) { $item[2] }
 441
 442 double_quote: /"/
 443
 444 index_name : WORD
 445
 446 data_type : pg_data_type parens_value_list(?)
 447     {
 448         my $data_type = $item[1];
 449
 450         #
 451         # We can deduce some sizes from the data type's name.
 452         #
 453         if ( my $size = $item[2][0] ) {
 454             $data_type->{'size'} = $size;
 455         }
 456
 457         $return  = $data_type;
 458     }
 459
 460 pg_data_type :
 461     /(bigint|int8)/i
 462         {
 463             $return = {
 464                 type => 'integer',
 465                 size => 20,
 466             };
 467         }
 468     |
 469     /(smallint|int2)/i
 470         {
 471             $return = {
 472                 type => 'integer',
 473                 size => 5,
 474             };
 475         }
 476     |
 477     /interval/i
 478         {
 479             $return = { type => 'interval' };
 480         }
 481     |
 482     /(integer|int4?)/i # interval must come before this
 483         {
 484             $return = {
 485                 type => 'integer',
 486                 size => 10,
 487             };
 488         }
 489     |
 490     /(real|float4)/i
 491         {
 492             $return = {
 493                 type => 'real',
 494                 size => 10,
 495             };
 496         }
 497     |
 498     /(double precision|float8?)/i
 499         {
 500             $return = {
 501                 type => 'float',
 502                 size => 20,
 503             };
 504         }
 505     |
 506     /(bigserial|serial8)/i
 507         {
 508             $return = {
 509                 type              => 'integer',
 510                 size              => 20,
 511                 is_auto_increment => 1,
 512             };
 513         }
 514     |
 515     /serial4?/i
 516         {
 517             $return = {
 518                 type              => 'integer',
 519                 size              => 11,
 520                 is_auto_increment => 1,
 521             };
 522         }
 523     |
 524     /(bit varying|varbit)/i
 525         {
 526             $return = { type => 'varbit' };
 527         }
 528     |
 529     /character varying/i
 530         {
 531             $return = { type => 'varchar' };
 532         }
 533     |
 534     /char(acter)?/i
 535         {
 536             $return = { type => 'char' };
 537         }
 538     |
 539     /bool(ean)?/i
 540         {
 541             $return = { type => 'boolean' };
 542         }
 543     |
 544     /bytea/i
 545         {
 546             $return = { type => 'bytea' };
 547         }
 548     |
 549     /(timestamptz|timestamp)( with time zone)?/i
 550         {
 551             $return = { type => 'timestamp' };
 552         }
 553     |
 554     /(timestamptz|timestamp)( without time zone)?/i
 555         {
 556             $return = { type => 'timestamp' };
 557         }
 558     |
 559     /text/i
 560         {
 561             $return = {
 562                 type => 'text',
 563                 size => 64_000,
 564             };
 565         }
 566     |
 567     /(bit|box|cidr|circle|date|inet|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|timetz|time|varchar)/i
 568         {
 569             $return = { type => $item[1] };
 570         }
 571
 572 parens_value_list : '(' VALUE(s /,/) ')'
 573     { $item[2] }
 574
 575 parens_word_list : '(' WORD(s /,/) ')'
 576     { $item[2] }
 577
 578 field_size : '(' num_range ')' { $item{'num_range'} }
 579
 580 num_range : DIGITS ',' DIGITS
 581     { $return = $item[1].','.$item[3] }
 582     | DIGITS
 583     { $return = $item[1] }
 584
 585 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
 586     {
 587         my $desc       = $item{'table_constraint_type'};
 588         my $type       = $desc->{'type'};
 589         my $fields     = $desc->{'fields'};
 590         my $expression = $desc->{'expression'};
 591         my @comments   = ( @{ $item[1] }, @{ $item[-1] } );
 592
 593         $return              =  {
 594             name             => $item{'constraint_name'}[0] || '',
 595             supertype        => 'constraint',
 596             type             => $type,
 597             fields           => $type ne 'check' ? $fields : [],
 598             expression       => $type eq 'check' ? $expression : '',
 599             deferrable       => $item{'deferrable'},
 600             deferred         => $item{'deferred'},
 601             reference_table  => $desc->{'reference_table'},
 602             reference_fields => $desc->{'reference_fields'},
 603             match_type       => $desc->{'match_type'}[0],
 604             on_delete_do     => $desc->{'on_delete_do'},
 605             on_update_do     => $desc->{'on_update_do'},
 606             comments         => [ @comments ],
 607         }
 608     }
 609
 610 table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
 611     {
 612         $return = {
 613             type   => 'primary_key',
 614             fields => $item[3],
 615         }
 616     }
 617     |
 618     /unique/i '(' name_with_opt_quotes(s /,/) ')'
 619     {
 620         $return    =  {
 621             type   => 'unique',
 622             fields => $item[3],
 623         }
 624     }
 625     |
 626     /check/i '(' /[^)]+/ ')'
 627     {
 628         $return        =  {
 629             type       => 'check',
 630             expression => $item[3],
 631         }
 632     }
 633     |
 634     /foreign key/i '(' name_with_opt_quotes(s /,/) ')' /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
 635     {
 636         my ( $on_delete, $on_update );
 637         for my $action ( @{ $item[9] || [] } ) {
 638             $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
 639             $on_update = $action->{'action'} if $action->{'type'} eq 'update';
 640         }
 641
 642         $return              =  {
 643             supertype        => 'constraint',
 644             type             => 'foreign_key',
 645             fields           => $item[3],
 646             reference_table  => $item[6],
 647             reference_fields => $item[7][0],
 648             match_type       => $item[8][0],
 649             on_delete_do     => $on_delete || '',
 650             on_update_do     => $on_update || '',
 651         }
 652     }
 653
 654 deferrable : /not/i /deferrable/i
 655     {
 656         $return = ( $item[1] =~ /not/i ) ? 0 : 1;
 657     }
 658
 659 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
 660
 661 match_type : /match full/i { 'match_full' }
 662     |
 663     /match partial/i { 'match_partial' }
 664
 665 key_action : key_delete
 666     |
 667     key_update
 668
 669 key_delete : /on delete/i key_mutation
 670     {
 671         $return = {
 672             type   => 'delete',
 673             action => $item[2],
 674         };
 675     }
 676
 677 key_update : /on update/i key_mutation
 678     {
 679         $return = {
 680             type   => 'update',
 681             action => $item[2],
 682         };
 683     }
 684
 685 key_mutation : /no action/i { $return = 'no_action' }
 686     |
 687     /restrict/i { $return = 'restrict' }
 688     |
 689     /cascade/i { $return = 'cascade' }
 690     |
 691     /set null/i { $return = 'set null' }
 692     |
 693     /set default/i { $return = 'set default' }
 694
 695 alter : alter_table table_name add_column field ';'
 696     {
 697         my $field_def = $item[4];
 698         $tables{ $item[2] }{'fields'}{ $field_def->{'name'} } = {
 699             %$field_def, order => $field_order++
 700         };
 701         1;
 702     }
 703
 704 alter : alter_table table_name ADD table_constraint ';'
 705     {
 706         my $table_name = $item[2];
 707         my $constraint = $item[4];
 708         push @{ $tables{ $table_name }{'constraints'} }, $constraint;
 709         1;
 710     }
 711
 712 alter : alter_table table_name drop_column NAME restrict_or_cascade(?) ';'
 713     {
 714         $tables{ $item[2] }{'fields'}{ $item[4] }{'drop'} = 1;
 715         1;
 716     }
 717
 718 alter : alter_table table_name alter_column NAME alter_default_val ';'
 719     {
 720         $tables{ $item[2] }{'fields'}{ $item[4] }{'default'} =
 721             $item[5]->{'value'};
 722         1;
 723     }
 724
 725 #
 726 # These will just parse for now but won't affect the structure. - ky
 727 #
 728 alter : alter_table table_name /rename/i /to/i NAME ';'
 729     { 1 }
 730
 731 alter : alter_table table_name alter_column NAME SET /statistics/i INTEGER ';'
 732     { 1 }
 733
 734 alter : alter_table table_name alter_column NAME SET /storage/i storage_type ';'
 735     { 1 }
 736
 737 alter : alter_table table_name rename_column NAME /to/i NAME ';'
 738     { 1 }
 739
 740 alter : alter_table table_name DROP /constraint/i NAME restrict_or_cascade ';'
 741     { 1 }
 742
 743 alter : alter_table table_name /owner/i /to/i NAME ';'
 744     { 1 }
 745
 746 storage_type : /(plain|external|extended|main)/i
 747
 748 alter_default_val : SET default_val
 749     {
 750         $return = { value => $item[2]->{'value'} }
 751     }
 752     | DROP DEFAULT
 753     {
 754         $return = { value => undef }
 755     }
 756
 757 #
 758 # This is a little tricky to get right, at least WRT to making the
 759 # tests pass.  The problem is that the constraints are stored just as
 760 # a list (no name access), and the tests expect the constraints in a
 761 # particular order.  I'm going to leave the rule but disable the code
 762 # for now. - ky
 763 #
 764 alter : alter_table table_name alter_column NAME alter_nullable ';'
 765     {
 766 #        my $table_name  = $item[2];
 767 #        my $field_name  = $item[4];
 768 #        my $is_nullable = $item[5]->{'is_nullable'};
 769 #
 770 #        $tables{ $table_name }{'fields'}{ $field_name }{'is_nullable'} =
 771 #            $is_nullable;
 772 #
 773 #        if ( $is_nullable ) {
 774 #            1;
 775 #            push @{ $tables{ $table_name }{'constraints'} }, {
 776 #                type   => 'not_null',
 777 #                fields => [ $field_name ],
 778 #            };
 779 #        }
 780 #        else {
 781 #            for my $i (
 782 #                0 .. $#{ $tables{ $table_name }{'constraints'} || [] }
 783 #            ) {
 784 #                my $c = $tables{ $table_name }{'constraints'}[ $i ] or next;
 785 #                my $fields = join( '', @{ $c->{'fields'} || [] } ) or next;
 786 #                if ( $c->{'type'} eq 'not_null' && $fields eq $field_name ) {
 787 #                    delete $tables{ $table_name }{'constraints'}[ $i ];
 788 #                    last;
 789 #                }
 790 #            }
 791 #        }
 792
 793         1;
 794     }
 795
 796 alter_nullable : SET not_null
 797     {
 798         $return = { is_nullable => 0 }
 799     }
 800     | DROP not_null
 801     {
 802         $return = { is_nullable => 1 }
 803     }
 804
 805 not_null : /not/i /null/i
 806
 807 add_column : ADD COLUMN(?)
 808
 809 alter_table : ALTER TABLE ONLY(?)
 810
 811 drop_column : DROP COLUMN(?)
 812
 813 alter_column : ALTER COLUMN(?)
 814
 815 rename_column : /rename/i COLUMN(?)
 816
 817 restrict_or_cascade : /restrict/i |
 818     /cascade/i
 819
 820 #
 821 # End basically useless stuff. - ky
 822 #
 823
 824 create_table : CREATE TABLE
 825
 826 create_index : CREATE /index/i
 827
 828 default_val  : DEFAULT /(\d+|'[^']*'|\w+\(.*?\))|\w+/
 829     {
 830         my $val =  defined $item[2] ? $item[2] : '';
 831         $val    =~ s/^'|'$//g;
 832         $return =  {
 833             supertype => 'constraint',
 834             type      => 'default',
 835             value     => $val,
 836         }
 837     }
 838     | /null/i
 839     {
 840         $return =  {
 841             supertype => 'constraint',
 842             type      => 'default',
 843             value     => 'NULL',
 844         }
 845     }
 846
 847 name_with_opt_paren : NAME parens_value_list(s?)
 848     { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
 849
 850 unique : /unique/i { 1 }
 851
 852 key : /key/i | /index/i
 853
 854 table_option : /inherits/i '(' name_with_opt_quotes(s /,/) ')'
 855     {
 856         $return = { type => 'inherits', table_name => $item[3] }
 857     }
 858     |
 859     /with(out)? oids/i
 860     {
 861         $return = { type => $item[1] =~ /out/i ? 'without_oids' : 'with_oids' }
 862     }
 863
 864 ADD : /add/i
 865
 866 ALTER : /alter/i
 867
 868 CREATE : /create/i
 869
 870 ONLY : /only/i
 871
 872 DEFAULT : /default/i
 873
 874 DROP : /drop/i
 875
 876 COLUMN : /column/i
 877
 878 TABLE : /table/i
 879
 880 SEMICOLON : /\s*;\n?/
 881
 882 INTEGER : /\d+/
 883
 884 WORD : /\w+/
 885
 886 DIGITS : /\d+/
 887
 888 COMMA : ','
 889
 890 SET : /set/i
 891
 892 NAME    : "`" /\w+/ "`"
 893     { $item[2] }
 894     | /\w+/
 895     { $item[1] }
 896     | /[\$\w]+/
 897     { $item[1] }
 898
 899 VALUE   : /[-+]?\.?\d+(?:[eE]\d+)?/
 900     { $item[1] }
 901     | /'.*?'/   # XXX doesn't handle embedded quotes
 902     { $item[1] }
 903     | /null/i
 904     { 'NULL' }
 905
 906 !;
 907
 908 # -------------------------------------------------------------------
 909 sub parse {
 910     my ( $translator, $data ) = @_;
 911     $parser ||= Parse::RecDescent->new($GRAMMAR);
 912
 913     $::RD_TRACE  = $translator->trace ? 1 : undef;
 914     $DEBUG       = $translator->debug;
 915
 916     unless (defined $parser) {
 917         return $translator->error("Error instantiating Parse::RecDescent ".
 918             "instance: Bad grammer");
 919     }
 920
 921     my $result = $parser->startrule($data);
 922     die "Parse failed.\n" unless defined $result;
 923     warn Dumper($result) if $DEBUG;
 924
 925     my $schema = $translator->schema;
 926     my @tables = sort {
 927         ( $result->{ $a }{'order'} || 0 ) <=> ( $result->{ $b }{'order'} || 0 )
 928     } keys %{ $result };
 929
 930     for my $table_name ( @tables ) {
 931         my $tdata =  $result->{ $table_name };
 932         my $table =  $schema->add_table(
 933             name  => $tdata->{'table_name'},
 934         ) or die "Couldn't create table '$table_name': " . $schema->error;
 935
 936         $table->comments( $tdata->{'comments'} );
 937
 938         my @fields = sort {
 939             $tdata->{'fields'}{ $a }{'order'}
 940             <=>
 941             $tdata->{'fields'}{ $b }{'order'}
 942         } keys %{ $tdata->{'fields'} };
 943
 944         for my $fname ( @fields ) {
 945             my $fdata = $tdata->{'fields'}{ $fname };
 946             next if $fdata->{'drop'};
 947             my $field = $table->add_field(
 948                 name              => $fdata->{'name'},
 949                 data_type         => $fdata->{'data_type'},
 950                 size              => $fdata->{'size'},
 951                 default_value     => $fdata->{'default'},
 952                 is_auto_increment => $fdata->{'is_auto_increment'},
 953                 is_nullable       => $fdata->{'is_nullable'},
 954                 comments          => $fdata->{'comments'},
 955             ) or die $table->error;
 956
 957             $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
 958
 959             for my $cdata ( @{ $fdata->{'constraints'} } ) {
 960                 next unless $cdata->{'type'} eq 'foreign_key';
 961                 $cdata->{'fields'} ||= [ $field->name ];
 962                 push @{ $tdata->{'constraints'} }, $cdata;
 963             }
 964         }
 965
 966         for my $idata ( @{ $tdata->{'indices'} || [] } ) {
 967             my $index  =  $table->add_index(
 968                 name   => $idata->{'name'},
 969                 type   => uc $idata->{'type'},
 970                 fields => $idata->{'fields'},
 971             ) or die $table->error;
 972         }
 973
 974         for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
 975             my $constraint       =  $table->add_constraint(
 976                 name             => $cdata->{'name'},
 977                 type             => $cdata->{'type'},
 978                 fields           => $cdata->{'fields'},
 979                 reference_table  => $cdata->{'reference_table'},
 980                 reference_fields => $cdata->{'reference_fields'},
 981                 match_type       => $cdata->{'match_type'} || '',
 982                 on_delete        => $cdata->{'on_delete_do'},
 983                 on_update        => $cdata->{'on_update_do'},
 984                 expression       => $cdata->{'expression'},
 985             ) or die "Can't add constraint of type '" .
 986                 $cdata->{'type'} .  "' to table '" . $table->name .
 987                 "': " . $table->error;
 988         }
 989     }
 990
 991     return 1;
 992 }
 993
 994 1;
 995
 996 # -------------------------------------------------------------------
 997 # Rescue the drowning and tie your shoestrings.
 998 # Henry David Thoreau
 999 # -------------------------------------------------------------------
1000
1001 =pod
1002
1003 =head1 AUTHORS
1004
1005 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
1006 Allen Day E<lt>allenday@ucla.eduE<gt>.
1007
1008 =head1 SEE ALSO
1009
1010 perl(1), Parse::RecDescent.
1011
1012 =cut