Fixed 'useless use of constant in void context' warning.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Parser / PostgreSQL.pm
index 054aaf9..3281f7a 100644 (file)
@@ -1,7 +1,7 @@
 package SQL::Translator::Parser::PostgreSQL;
 
 # -------------------------------------------------------------------
-# $Id: PostgreSQL.pm,v 1.16 2003-06-09 02:41:31 kycl4rk Exp $
+# $Id: PostgreSQL.pm,v 1.36 2004-02-04 17:32:22 dlc Exp $
 # -------------------------------------------------------------------
 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
 #                    Allen Day <allenday@users.sourceforge.net>,
@@ -111,7 +111,7 @@ View table:
 
 use strict;
 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.16 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.36 $ =~ /(\d+)\.(\d+)/;
 $DEBUG   = 0 unless defined $DEBUG;
 
 use Data::Dumper;
@@ -131,7 +131,7 @@ my $parser; # should we do this?  There's no programmic way to
 
 $GRAMMAR = q!
 
-{ our ( %tables, $table_order ) }
+{ my ( %tables, $table_order, $field_order, @table_comments) }
 
 #
 # The "eofile" rule makes the parser fail if any "statement" rule
@@ -144,41 +144,49 @@ startrule : statement(s) eofile { \%tables }
 eofile : /^\Z/
 
 statement : create
+  | comment_on_table
+  | comment_on_column
   | comment
   | alter
   | grant
   | revoke
   | drop
+  | insert
   | connect
+  | update
   | set
   | <error>
 
 connect : /^\s*\\\connect.*\n/
 
-set : /SET/ /[^;]*/ ';'
+set : /set/i /[^;]*/ ';'
 
-revoke : /revoke/i WORD(s /,/) /on/i table_name /from/i name_with_opt_quotes(s /,/) ';'
+revoke : /revoke/i WORD(s /,/) /on/i TABLE(?) table_name /from/i name_with_opt_quotes(s /,/) ';'
     {
         my $table_name = $item{'table_name'};
         push @{ $tables{ $table_name }{'permissions'} }, {
             type       => 'revoke',
             actions    => $item[2],
-            users      => $item[6],
+            users      => $item[7],
         }
     }
 
-grant : /grant/i WORD(s /,/) /on/i table_name /to/i name_with_opt_quotes(s /,/) ';'
+grant : /grant/i WORD(s /,/) /on/i TABLE(?) table_name /to/i name_with_opt_quotes(s /,/) ';'
     {
         my $table_name = $item{'table_name'};
         push @{ $tables{ $table_name }{'permissions'} }, {
             type       => 'grant',
             actions    => $item[2],
-            users      => $item[6],
+            users      => $item[7],
         }
     }
 
 drop : /drop/i /[^;]*/ ';'
 
+insert : /insert/i /[^;]*/ ';'
+
+update : /update/i /[^;]*/ ';'
+
 #
 # Create table.
 #
@@ -188,14 +196,17 @@ create : create_table table_name '(' create_definition(s /,/) ')' table_option(s
         $tables{ $table_name }{'order'}      = ++$table_order;
         $tables{ $table_name }{'table_name'} = $table_name;
 
-        my $i = 1;
+        if ( @table_comments ) {
+            $tables{ $table_name }{'comments'} = [ @table_comments ];
+            @table_comments = ();
+        }
+
         my @constraints;
         for my $definition ( @{ $item[4] } ) {
-            if ( $definition->{'type'} eq 'field' ) {
+            if ( $definition->{'supertype'} eq 'field' ) {
                 my $field_name = $definition->{'name'};
                 $tables{ $table_name }{'fields'}{ $field_name } = 
-                    { %$definition, order => $i };
-                $i++;
+                    { %$definition, order => $field_order++ };
                                
                 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
                     $constraint->{'fields'} = [ $field_name ];
@@ -203,22 +214,10 @@ create : create_table table_name '(' create_definition(s /,/) ')' table_option(s
                         $constraint;
                 }
             }
-            elsif ( $definition->{'type'} eq 'constraint' ) {
-                $definition->{'type'} = $definition->{'constraint_type'};
-                # group FKs at the field level
-#                if ( $definition->{'type'} eq 'foreign_key' ) {
-#                    for my $fld ( @{ $definition->{'fields'} || [] } ) {
-#                        push @{ 
-#                            $tables{$table_name}{'fields'}{$fld}{'constraints'}
-#                        }, $definition;
-#                    }
-#                }
-#                else {
-                    push @{ $tables{ $table_name }{'constraints'} }, 
-                        $definition;
-#                }
+            elsif ( $definition->{'supertype'} eq 'constraint' ) {
+                push @{ $tables{ $table_name }{'constraints'} }, $definition;
             }
-            else {
+            elsif ( $definition->{'supertype'} eq 'index' ) {
                 push @{ $tables{ $table_name }{'indices'} }, $definition;
             }
         }
@@ -231,25 +230,25 @@ create : create_table table_name '(' create_definition(s /,/) ')' table_option(s
         1;
     }
 
-#
-# Create index.
-#
-create : /create/i unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
+create : CREATE unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
     {
         push @{ $tables{ $item{'table_name'} }{'indices'} },
             {
-                name   => $item{'index_name'},
-                type   => $item{'unique'}[0] ? 'unique' : 'normal',
-                fields => $item[9],
-                method => $item{'using_method'}[0],
+                name      => $item{'index_name'},
+                supertype => $item{'unique'}[0] ? 'constraint' : 'index',
+                type      => $item{'unique'}[0] ? 'unique'     : 'normal',
+                fields    => $item[9],
+                method    => $item{'using_method'}[0],
             }
         ;
+
     }
 
 #
-# Create anything else (e.g., domain, function, etc.)
+# Create anything else (e.g., domain, etc.)
 #
-create : /create/i WORD /[^;]+/ ';'
+create : CREATE WORD /[^;]+/ ';'
+    { @table_comments = (); }
 
 using_method : /using/i WORD { $item[2] }
 
@@ -259,20 +258,49 @@ create_definition : field
     | table_constraint
     | <error>
 
+table_comment : comment
+    {
+        my $comment = $item[1];
+        $return     = $comment;
+        push @table_comments, $comment;
+    }
+
 comment : /^\s*(?:#|-{2}).*\n/
 
+comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
+    {
+        push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
+    }
+
+comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
+    {
+        my $table_name = $item[4]->{'table'};
+        my $field_name = $item[4]->{'field'};
+        push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} }, 
+            $item{'comment_phrase'};
+    }
+
+column_name : NAME '.' NAME
+    { $return = { table => $item[1], field => $item[3] } }
+
+comment_phrase : /'.*?'|NULL/ 
+    { 
+        my $val = $item[1] || '';
+        $val =~ s/^'|'$//g;
+        $return = $val;
+    }
+
 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
     {
         my ( $default, @constraints, $is_pk );
-        my $null = 1;
+        my $is_nullable = 1;
         for my $meta ( @{ $item[4] } ) {
             if ( $meta->{'type'} eq 'default' ) {
                 $default = $meta;
                 next;
             }
             elsif ( $meta->{'type'} eq 'not_null' ) {
-                $null = 0;
-                next;
+                $is_nullable = 0;
             }
             elsif ( $meta->{'type'} eq 'primary_key' ) {
                 $is_pk = 1;
@@ -284,15 +312,16 @@ field : comment(s?) field_name data_type field_meta(s?) comment(s?)
         my @comments = ( @{ $item[1] }, @{ $item[5] } );
 
         $return = {
-            type           => 'field',
-            name           => $item{'field_name'}, 
-            data_type      => $item{'data_type'}{'type'},
-            size           => $item{'data_type'}{'size'},
-            null           => $null,
-            default        => $default->{'value'},
-            constraints    => [ @constraints ],
-            comments       => [ @comments ],
-            is_primary_key => $is_pk || 0,
+            supertype         => 'field',
+            name              => $item{'field_name'}, 
+            data_type         => $item{'data_type'}{'type'},
+            size              => $item{'data_type'}{'size'},
+            is_nullable       => $is_nullable,
+            default           => $default->{'value'},
+            constraints       => [ @constraints ],
+            comments          => [ @comments ],
+            is_primary_key    => $is_pk || 0,
+            is_auto_increment => $item{'data_type'}{'is_auto_increment'},
         } 
     }
     | <error>
@@ -312,7 +341,7 @@ column_constraint : constraint_name(?) column_constraint_type deferrable(?) defe
             name             => $item{'constraint_name'}[0] || '',
             type             => $type,
             expression       => $type eq 'check' ? $expression : '',
-            deferreable      => $item{'deferrable'},
+            deferrable       => $item{'deferrable'},
             deferred         => $item{'deferred'},
             reference_table  => $desc->{'reference_table'},
             reference_fields => $desc->{'reference_fields'},
@@ -326,17 +355,17 @@ constraint_name : /constraint/i name_with_opt_quotes { $item[2] }
 
 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
     |
-    /null/ 
+    /null/i
         { $return = { type => 'null' } }
     |
-    /unique/ 
+    /unique/i
         { $return = { type => 'unique' } }
     |
     /primary key/i 
         { $return = { type => 'primary_key' } }
     |
     /check/i '(' /[^)]+/ ')' 
-        { $return = { type => 'check', expression => $item[2] } }
+        { $return = { type => 'check', expression => $item[3] } }
     |
     /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
     {
@@ -379,96 +408,103 @@ data_type : pg_data_type parens_value_list(?)
     }
 
 pg_data_type :
-    /(bigint|int8|bigserial|serial8)/ 
+    /(bigint|int8)/i
         { 
             $return = { 
-                type           => 'integer',
-                size           => [8],
-                auto_increment => 1,
+                type => 'integer',
+                size => 20,
             };
         }
     |
-    /(smallint|int2)/ 
+    /(smallint|int2)/i
         { 
             $return = {
                 type => 'integer', 
-                size => [2],
+                size => 5,
             };
         }
     |
-    /int(eger)?|int4/ 
+    /(integer|int4?)/i # interval must come before this
         { 
             $return = {
                 type => 'integer', 
-                size => [4],
+                size => 10,
             };
         }
-    |
-    /(double precision|float8?)/ 
+    |    
+    /(real|float4)/i
         { 
             $return = {
-                type => 'float', 
-                size => [8],
-            }; 
+                type => 'real', 
+                size => 10,
+            };
         }
     |
-    /(real|float4)/ 
+    /(double precision|float8?)/i
         { 
             $return = {
-                type => 'real', 
-                size => [4],
-            };
+                type => 'float', 
+                size => 20,
+            }; 
         }
     |
-    /serial4?/ 
+    /(bigserial|serial8)/i
         { 
             $return = { 
-                type           => 'integer',
-                size           => [4], 
-                auto_increment => 1,
+                type              => 'integer', 
+                size              => 20, 
+                is_auto_increment => 1,
             };
         }
     |
-    /bigserial/ 
+    /serial4?/i
         { 
             $return = { 
-                type           => 'integer', 
-                size           => [8], 
-                auto_increment => 1,
+                type              => 'integer',
+                size              => 11, 
+                is_auto_increment => 1,
             };
         }
     |
-    /(bit varying|varbit)/ 
+    /(bit varying|varbit)/i
         { 
             $return = { type => 'varbit' };
         }
     |
-    /character varying/ 
+    /character varying/i
         { 
             $return = { type => 'varchar' };
         }
     |
-    /char(acter)?/ 
+    /char(acter)?/i
         { 
             $return = { type => 'char' };
         }
     |
-    /bool(ean)?/ 
+    /bool(ean)?/i
         { 
             $return = { type => 'boolean' };
         }
     |
-    /bytea/ 
+    /bytea/i
         { 
             $return = { type => 'bytea' };
         }
     |
-    /timestampz?/ 
+    /(timestamptz|timestamp)/i
         { 
             $return = { type => 'timestamp' };
         }
     |
-    /(bit|box|cidr|circle|date|inet|interval|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|text|time|varchar)/
+    /text/i
+        { 
+            $return = { 
+                type => 'text',
+                size => 64_000,
+            };
+        }
+    |
+    /(bit|box|cidr|circle|date|inet|interval|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|timetz|time|varchar)/i
         { 
             $return = { type => $item[1] };
         }
@@ -496,11 +532,11 @@ table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrab
 
         $return              =  {
             name             => $item{'constraint_name'}[0] || '',
-            type             => 'constraint',
-            constraint_type  => $type,
+            supertype        => 'constraint',
+            type             => $type,
             fields           => $type ne 'check' ? $fields : [],
             expression       => $type eq 'check' ? $expression : '',
-            deferreable      => $item{'deferrable'},
+            deferrable       => $item{'deferrable'},
             deferred         => $item{'deferred'},
             reference_table  => $desc->{'reference_table'},
             reference_fields => $desc->{'reference_fields'},
@@ -527,7 +563,7 @@ table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
         }
     }
     |
-    /check/ '(' /(.+)/ ')'
+    /check/i '(' /[^)]+/ ')' 
     {
         $return        =  {
             type       => 'check',
@@ -544,6 +580,7 @@ table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
         }
         
         $return              =  {
+            supertype        => 'constraint',
             type             => 'foreign_key',
             fields           => $item[3],
             reference_table  => $item[6],
@@ -571,7 +608,7 @@ key_action : key_delete
 
 key_delete : /on delete/i key_mutation
     { 
-        $return => { 
+        $return = { 
             type   => 'delete',
             action => $item[2],
         };
@@ -579,7 +616,7 @@ key_delete : /on delete/i key_mutation
 
 key_update : /on update/i key_mutation
     { 
-        $return => { 
+        $return = { 
             type   => 'update',
             action => $item[2],
         };
@@ -591,30 +628,147 @@ key_mutation : /no action/i { $return = 'no_action' }
     |
     /cascade/i { $return = 'cascade' }
     |
-    /set null/i { $return = 'set_null' }
+    /set null/i { $return = 'set null' }
     |
-    /set default/i { $return = 'set_default' }
+    /set default/i { $return = 'set default' }
+
+alter : alter_table table_name add_column field ';' 
+    { 
+        my $field_def = $item[4];
+        $tables{ $item[2] }{'fields'}{ $field_def->{'name'} } = {
+            %$field_def, order => $field_order++
+        };
+        1;
+    }
 
-alter : alter_table table_name /add/i table_constraint ';' 
+alter : alter_table table_name ADD table_constraint ';' 
     { 
         my $table_name = $item[2];
         my $constraint = $item[4];
-        $constraint->{'type'} = $constraint->{'constraint_type'};
         push @{ $tables{ $table_name }{'constraints'} }, $constraint;
+        1;
     }
 
-alter_table : /alter/i /table/i only(?)
+alter : alter_table table_name drop_column NAME restrict_or_cascade(?) ';' 
+    {
+        $tables{ $item[2] }{'fields'}{ $item[4] }{'drop'} = 1;
+        1;
+    }
 
-only : /only/i
+alter : alter_table table_name alter_column NAME alter_default_val ';' 
+    {
+        $tables{ $item[2] }{'fields'}{ $item[4] }{'default'} = 
+            $item[5]->{'value'};
+        1;
+    }
+
+#
+# These will just parse for now but won't affect the structure. - ky
+#
+alter : alter_table table_name /rename/i /to/i NAME ';'
+    { 1 }
+
+alter : alter_table table_name alter_column NAME SET /statistics/i INTEGER ';' 
+    { 1 }
+
+alter : alter_table table_name alter_column NAME SET /storage/i storage_type ';'
+    { 1 }
+
+alter : alter_table table_name rename_column NAME /to/i NAME ';'
+    { 1 }
+
+alter : alter_table table_name DROP /constraint/i NAME restrict_or_cascade ';'
+    { 1 }
+
+alter : alter_table table_name /owner/i /to/i NAME ';'
+    { 1 }
+
+storage_type : /(plain|external|extended|main)/i
+
+alter_default_val : SET default_val 
+    { 
+        $return = { value => $item[2]->{'value'} } 
+    }
+    | DROP DEFAULT 
+    { 
+        $return = { value => undef } 
+    } 
 
-create_table : /create/i /table/i
+#
+# This is a little tricky to get right, at least WRT to making the 
+# tests pass.  The problem is that the constraints are stored just as
+# a list (no name access), and the tests expect the constraints in a
+# particular order.  I'm going to leave the rule but disable the code 
+# for now. - ky
+#
+alter : alter_table table_name alter_column NAME alter_nullable ';'
+    {
+#        my $table_name  = $item[2];
+#        my $field_name  = $item[4];
+#        my $is_nullable = $item[5]->{'is_nullable'};
+#
+#        $tables{ $table_name }{'fields'}{ $field_name }{'is_nullable'} = 
+#            $is_nullable;
+#
+#        if ( $is_nullable ) {
+#            1;
+#            push @{ $tables{ $table_name }{'constraints'} }, {
+#                type   => 'not_null',
+#                fields => [ $field_name ],
+#            };
+#        }
+#        else {
+#            for my $i ( 
+#                0 .. $#{ $tables{ $table_name }{'constraints'} || [] } 
+#            ) {
+#                my $c = $tables{ $table_name }{'constraints'}[ $i ] or next;
+#                my $fields = join( '', @{ $c->{'fields'} || [] } ) or next;
+#                if ( $c->{'type'} eq 'not_null' && $fields eq $field_name ) {
+#                    delete $tables{ $table_name }{'constraints'}[ $i ];
+#                    last;
+#                }
+#            }
+#        }
 
-create_index : /create/i /index/i
+        1;
+    }
 
-default_val  : /default/i /(?:')?[\w\d.-]*(?:')?/ 
+alter_nullable : SET not_null 
+    { 
+        $return = { is_nullable => 0 } 
+    }
+    | DROP not_null
     { 
-        my $val =  $item[2] || '';
-        $val    =~ s/'//g; 
+        $return = { is_nullable => 1 } 
+    }
+
+not_null : /not/i /null/i
+
+add_column : ADD COLUMN(?)
+
+alter_table : ALTER TABLE ONLY(?)
+
+drop_column : DROP COLUMN(?)
+
+alter_column : ALTER COLUMN(?)
+
+rename_column : /rename/i COLUMN(?)
+
+restrict_or_cascade : /restrict/i | 
+    /cascade/i
+
+#
+# End basically useless stuff. - ky
+#
+
+create_table : CREATE TABLE
+
+create_index : CREATE /index/i
+
+default_val  : DEFAULT /(\d+|'[^']*'|\w+\(.*?\))|\w+/
+    { 
+        my $val =  defined $item[2] ? $item[2] : '';
+        $val    =~ s/^'|'$//g; 
         $return =  {
             supertype => 'constraint',
             type      => 'default',
@@ -647,14 +801,34 @@ table_option : /inherits/i '(' name_with_opt_quotes(s /,/) ')'
         $return = { type => $item[1] =~ /out/i ? 'without_oids' : 'with_oids' }
     }
 
+ADD : /add/i
+
+ALTER : /alter/i
+
+CREATE : /create/i
+
+ONLY : /only/i
+
+DEFAULT : /default/i
+
+DROP : /drop/i
+
+COLUMN : /column/i
+
+TABLE : /table/i
+
 SEMICOLON : /\s*;\n?/
 
+INTEGER : /\d+/
+
 WORD : /\w+/
 
 DIGITS : /\d+/
 
 COMMA : ','
 
+SET : /set/i
+
 NAME    : "`" /\w+/ "`"
     { $item[2] }
     | /\w+/
@@ -666,7 +840,7 @@ VALUE   : /[-+]?\.?\d+(?:[eE]\d+)?/
     { $item[1] }
     | /'.*?'/   # XXX doesn't handle embedded quotes
     { $item[1] }
-    | /NULL/
+    | /null/i
     { 'NULL' }
 
 !;
@@ -697,23 +871,24 @@ sub parse {
         my $tdata =  $result->{ $table_name };
         my $table =  $schema->add_table( 
             name  => $tdata->{'table_name'},
-        ) or die $schema->error;
+        ) or die "Couldn't create table '$table_name': " . $schema->error;
 
         my @fields = sort { 
-            $tdata->{'fields'}->{$a}->{'order'} 
+            $tdata->{'fields'}->{ $a }->{'order'} 
             <=>
-            $tdata->{'fields'}->{$b}->{'order'}
+            $tdata->{'fields'}->{ $b }->{'order'}
         } keys %{ $tdata->{'fields'} };
 
         for my $fname ( @fields ) {
             my $fdata = $tdata->{'fields'}{ $fname };
+            next if $fdata->{'drop'};
             my $field = $table->add_field(
                 name              => $fdata->{'name'},
                 data_type         => $fdata->{'data_type'},
                 size              => $fdata->{'size'},
                 default_value     => $fdata->{'default'},
-                is_auto_increment => $fdata->{'is_auto_inc'},
-                is_nullable       => $fdata->{'null'},
+                is_auto_increment => $fdata->{'is_auto_increment'},
+                is_nullable       => $fdata->{'is_nullable'},
             ) or die $table->error;
 
             $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
@@ -743,11 +918,14 @@ sub parse {
                 match_type       => $cdata->{'match_type'} || '',
                 on_delete        => $cdata->{'on_delete_do'},
                 on_update        => $cdata->{'on_update_do'},
-            ) or die $table->error;
+                expression       => $cdata->{'expression'},
+            ) or die "Can't add constraint of type '" .
+                $cdata->{'type'} .  "' to table '" . $table->name . 
+                "': " . $table->error;
         }
     }
 
-    return $result;
+    return 1;
 }
 
 1;
@@ -762,7 +940,7 @@ sub parse {
 =head1 AUTHORS
 
 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
-Allen Day <allenday@ucla.edu>.
+Allen Day E<lt>allenday@ucla.eduE<gt>.
 
 =head1 SEE ALSO