1 package SQL::Translator::Parser::PostgreSQL;
3 # -------------------------------------------------------------------
4 # $Id: PostgreSQL.pm,v 1.37 2004-02-09 22:23:40 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 SQLFairy Authors
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 # -------------------------------------------------------------------
25 SQL::Translator::Parser::PostgreSQL - parser for PostgreSQL
30 use SQL::Translator::Parser::PostgreSQL;
32 my $translator = SQL::Translator->new;
33 $translator->parser("SQL::Translator::Parser::PostgreSQL");
37 The grammar was started from the MySQL parsers. Here is the description
41 (http://www.postgresql.org/docs/view.php?version=7.3&idoc=1&file=sql-createtable.html)
43 CREATE [ [ LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name (
44 { column_name data_type [ DEFAULT default_expr ]
45 [ column_constraint [, ... ] ]
46 | table_constraint } [, ... ]
48 [ INHERITS ( parent_table [, ... ] ) ]
49 [ WITH OIDS | WITHOUT OIDS ]
51 where column_constraint is:
53 [ CONSTRAINT constraint_name ]
54 { NOT NULL | NULL | UNIQUE | PRIMARY KEY |
56 REFERENCES reftable [ ( refcolumn ) ] [ MATCH FULL | MATCH PARTIAL ]
57 [ ON DELETE action ] [ ON UPDATE action ] }
58 [ DEFERRABLE | NOT DEFERRABLE ]
59 [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
61 and table_constraint is:
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 ]
75 (http://www.postgresql.org/docs/view.php?version=7.3&idoc=1&file=sql-createindex.html)
77 CREATE [ UNIQUE ] INDEX index_name ON table
78 [ USING acc_method ] ( column [ ops_name ] [, ...] )
80 CREATE [ UNIQUE ] INDEX index_name ON table
81 [ USING acc_method ] ( func_name( column [, ... ]) [ ops_name ] )
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
97 ADD table_constraint_definition
98 ALTER TABLE [ ONLY ] table
99 DROP CONSTRAINT constraint { RESTRICT | CASCADE }
105 CREATE [ OR REPLACE ] VIEW view [ ( column name list ) ] AS SELECT query
110 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
111 $VERSION = sprintf "%d.%02d", q$Revision: 1.37 $ =~ /(\d+)\.(\d+)/;
112 $DEBUG = 0 unless defined $DEBUG;
115 use Parse::RecDescent;
117 use base qw(Exporter);
119 @EXPORT_OK = qw(parse);
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.
126 my $parser; # should we do this? There's no programmic way to
127 # change the grammar, so I think this is safe.
131 { my ( %tables, $table_order, $field_order, @table_comments) }
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,
139 startrule : statement(s) eofile { \%tables }
157 connect : /^\s*\\\connect.*\n/
159 set : /set/i /[^;]*/ ';'
161 revoke : /revoke/i WORD(s /,/) /on/i TABLE(?) table_name /from/i name_with_opt_quotes(s /,/) ';'
163 my $table_name = $item{'table_name'};
164 push @{ $tables{ $table_name }{'permissions'} }, {
171 grant : /grant/i WORD(s /,/) /on/i TABLE(?) table_name /to/i name_with_opt_quotes(s /,/) ';'
173 my $table_name = $item{'table_name'};
174 push @{ $tables{ $table_name }{'permissions'} }, {
181 drop : /drop/i /[^;]*/ ';'
183 insert : /insert/i /[^;]*/ ';'
185 update : /update/i /[^;]*/ ';'
190 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
192 my $table_name = $item{'table_name'};
193 $tables{ $table_name }{'order'} = ++$table_order;
194 $tables{ $table_name }{'table_name'} = $table_name;
196 if ( @table_comments ) {
197 $tables{ $table_name }{'comments'} = [ @table_comments ];
198 @table_comments = ();
202 for my $definition ( @{ $item[4] } ) {
203 if ( $definition->{'supertype'} eq 'field' ) {
204 my $field_name = $definition->{'name'};
205 $tables{ $table_name }{'fields'}{ $field_name } =
206 { %$definition, order => $field_order++ };
208 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
209 $constraint->{'fields'} = [ $field_name ];
210 push @{ $tables{ $table_name }{'constraints'} },
214 elsif ( $definition->{'supertype'} eq 'constraint' ) {
215 push @{ $tables{ $table_name }{'constraints'} }, $definition;
217 elsif ( $definition->{'supertype'} eq 'index' ) {
218 push @{ $tables{ $table_name }{'indices'} }, $definition;
222 for my $option ( @{ $item[6] } ) {
223 $tables{ $table_name }{'table_options(s?)'}{ $option->{'type'} } =
230 create : CREATE unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
232 push @{ $tables{ $item{'table_name'} }{'indices'} },
234 name => $item{'index_name'},
235 supertype => $item{'unique'}[0] ? 'constraint' : 'index',
236 type => $item{'unique'}[0] ? 'unique' : 'normal',
238 method => $item{'using_method'}[0],
245 # Create anything else (e.g., domain, etc.)
247 create : CREATE WORD /[^;]+/ ';'
248 { @table_comments = (); }
250 using_method : /using/i WORD { $item[2] }
252 where_predicate : /where/i /[^;]+/
254 create_definition : field
258 table_comment : comment
260 my $comment = $item[1];
262 push @table_comments, $comment;
265 comment : /^\s*(?:#|-{2}).*\n/
267 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
269 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
272 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
274 my $table_name = $item[4]->{'table'};
275 my $field_name = $item[4]->{'field'};
276 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
277 $item{'comment_phrase'};
280 column_name : NAME '.' NAME
281 { $return = { table => $item[1], field => $item[3] } }
283 comment_phrase : /'.*?'|NULL/
285 my $val = $item[1] || '';
290 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
292 my ( $default, @constraints, $is_pk );
294 for my $meta ( @{ $item[4] } ) {
295 if ( $meta->{'type'} eq 'default' ) {
299 elsif ( $meta->{'type'} eq 'not_null' ) {
302 elsif ( $meta->{'type'} eq 'primary_key' ) {
306 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
309 my @comments = ( @{ $item[1] }, @{ $item[5] } );
312 supertype => 'field',
313 name => $item{'field_name'},
314 data_type => $item{'data_type'}{'type'},
315 size => $item{'data_type'}{'size'},
316 is_nullable => $is_nullable,
317 default => $default->{'value'},
318 constraints => [ @constraints ],
319 comments => [ @comments ],
320 is_primary_key => $is_pk || 0,
321 is_auto_increment => $item{'data_type'}{'is_auto_increment'},
326 field_meta : default_val
329 column_constraint : constraint_name(?) column_constraint_type deferrable(?) deferred(?)
331 my $desc = $item{'column_constraint_type'};
332 my $type = $desc->{'type'};
333 my $fields = $desc->{'fields'} || [];
334 my $expression = $desc->{'expression'} || '';
337 supertype => 'constraint',
338 name => $item{'constraint_name'}[0] || '',
340 expression => $type eq 'check' ? $expression : '',
341 deferrable => $item{'deferrable'},
342 deferred => $item{'deferred'},
343 reference_table => $desc->{'reference_table'},
344 reference_fields => $desc->{'reference_fields'},
345 match_type => $desc->{'match_type'},
346 on_delete_do => $desc->{'on_delete_do'},
347 on_update_do => $desc->{'on_update_do'},
351 constraint_name : /constraint/i name_with_opt_quotes { $item[2] }
353 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
356 { $return = { type => 'null' } }
359 { $return = { type => 'unique' } }
362 { $return = { type => 'primary_key' } }
364 /check/i '(' /[^)]+/ ')'
365 { $return = { type => 'check', expression => $item[3] } }
367 /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
369 my ( $on_delete, $on_update );
370 for my $action ( @{ $item[5] || [] } ) {
371 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
372 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
376 type => 'foreign_key',
377 reference_table => $item[2],
378 reference_fields => $item[3][0],
379 match_type => $item[4][0],
380 on_delete_do => $on_delete,
381 on_update_do => $on_update,
385 table_name : name_with_opt_quotes
387 field_name : name_with_opt_quotes
389 name_with_opt_quotes : double_quote(?) NAME double_quote(?) { $item[2] }
395 data_type : pg_data_type parens_value_list(?)
397 my $data_type = $item[1];
400 # We can deduce some sizes from the data type's name.
402 $data_type->{'size'} ||= $item[2][0];
404 $return = $data_type;
424 /(integer|int4?)/i # interval must come before this
440 /(double precision|float8?)/i
448 /(bigserial|serial8)/i
453 is_auto_increment => 1,
462 is_auto_increment => 1,
466 /(bit varying|varbit)/i
468 $return = { type => 'varbit' };
473 $return = { type => 'varchar' };
478 $return = { type => 'char' };
483 $return = { type => 'boolean' };
488 $return = { type => 'bytea' };
491 /(timestamptz|timestamp)/i
493 $return = { type => 'timestamp' };
504 /(bit|box|cidr|circle|date|inet|interval|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|timetz|time|varchar)/i
506 $return = { type => $item[1] };
509 parens_value_list : '(' VALUE(s /,/) ')'
512 parens_word_list : '(' WORD(s /,/) ')'
515 field_size : '(' num_range ')' { $item{'num_range'} }
517 num_range : DIGITS ',' DIGITS
518 { $return = $item[1].','.$item[3] }
520 { $return = $item[1] }
522 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
524 my $desc = $item{'table_constraint_type'};
525 my $type = $desc->{'type'};
526 my $fields = $desc->{'fields'};
527 my $expression = $desc->{'expression'};
528 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
531 name => $item{'constraint_name'}[0] || '',
532 supertype => 'constraint',
534 fields => $type ne 'check' ? $fields : [],
535 expression => $type eq 'check' ? $expression : '',
536 deferrable => $item{'deferrable'},
537 deferred => $item{'deferred'},
538 reference_table => $desc->{'reference_table'},
539 reference_fields => $desc->{'reference_fields'},
540 match_type => $desc->{'match_type'}[0],
541 on_delete_do => $desc->{'on_delete_do'},
542 on_update_do => $desc->{'on_update_do'},
543 comments => [ @comments ],
547 table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
550 type => 'primary_key',
555 /unique/i '(' name_with_opt_quotes(s /,/) ')'
563 /check/i '(' /[^)]+/ ')'
567 expression => $item[3],
571 /foreign key/i '(' name_with_opt_quotes(s /,/) ')' /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
573 my ( $on_delete, $on_update );
574 for my $action ( @{ $item[9] || [] } ) {
575 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
576 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
580 supertype => 'constraint',
581 type => 'foreign_key',
583 reference_table => $item[6],
584 reference_fields => $item[7][0],
585 match_type => $item[8][0],
586 on_delete_do => $on_delete || '',
587 on_update_do => $on_update || '',
591 deferrable : /not/i /deferrable/i
593 $return = ( $item[1] =~ /not/i ) ? 0 : 1;
596 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
598 match_type : /match full/i { 'match_full' }
600 /match partial/i { 'match_partial' }
602 key_action : key_delete
606 key_delete : /on delete/i key_mutation
614 key_update : /on update/i key_mutation
622 key_mutation : /no action/i { $return = 'no_action' }
624 /restrict/i { $return = 'restrict' }
626 /cascade/i { $return = 'cascade' }
628 /set null/i { $return = 'set null' }
630 /set default/i { $return = 'set default' }
632 alter : alter_table table_name add_column field ';'
634 my $field_def = $item[4];
635 $tables{ $item[2] }{'fields'}{ $field_def->{'name'} } = {
636 %$field_def, order => $field_order++
641 alter : alter_table table_name ADD table_constraint ';'
643 my $table_name = $item[2];
644 my $constraint = $item[4];
645 push @{ $tables{ $table_name }{'constraints'} }, $constraint;
649 alter : alter_table table_name drop_column NAME restrict_or_cascade(?) ';'
651 $tables{ $item[2] }{'fields'}{ $item[4] }{'drop'} = 1;
655 alter : alter_table table_name alter_column NAME alter_default_val ';'
657 $tables{ $item[2] }{'fields'}{ $item[4] }{'default'} =
663 # These will just parse for now but won't affect the structure. - ky
665 alter : alter_table table_name /rename/i /to/i NAME ';'
668 alter : alter_table table_name alter_column NAME SET /statistics/i INTEGER ';'
671 alter : alter_table table_name alter_column NAME SET /storage/i storage_type ';'
674 alter : alter_table table_name rename_column NAME /to/i NAME ';'
677 alter : alter_table table_name DROP /constraint/i NAME restrict_or_cascade ';'
680 alter : alter_table table_name /owner/i /to/i NAME ';'
683 storage_type : /(plain|external|extended|main)/i
685 alter_default_val : SET default_val
687 $return = { value => $item[2]->{'value'} }
691 $return = { value => undef }
695 # This is a little tricky to get right, at least WRT to making the
696 # tests pass. The problem is that the constraints are stored just as
697 # a list (no name access), and the tests expect the constraints in a
698 # particular order. I'm going to leave the rule but disable the code
701 alter : alter_table table_name alter_column NAME alter_nullable ';'
703 # my $table_name = $item[2];
704 # my $field_name = $item[4];
705 # my $is_nullable = $item[5]->{'is_nullable'};
707 # $tables{ $table_name }{'fields'}{ $field_name }{'is_nullable'} =
710 # if ( $is_nullable ) {
712 # push @{ $tables{ $table_name }{'constraints'} }, {
713 # type => 'not_null',
714 # fields => [ $field_name ],
719 # 0 .. $#{ $tables{ $table_name }{'constraints'} || [] }
721 # my $c = $tables{ $table_name }{'constraints'}[ $i ] or next;
722 # my $fields = join( '', @{ $c->{'fields'} || [] } ) or next;
723 # if ( $c->{'type'} eq 'not_null' && $fields eq $field_name ) {
724 # delete $tables{ $table_name }{'constraints'}[ $i ];
733 alter_nullable : SET not_null
735 $return = { is_nullable => 0 }
739 $return = { is_nullable => 1 }
742 not_null : /not/i /null/i
744 add_column : ADD COLUMN(?)
746 alter_table : ALTER TABLE ONLY(?)
748 drop_column : DROP COLUMN(?)
750 alter_column : ALTER COLUMN(?)
752 rename_column : /rename/i COLUMN(?)
754 restrict_or_cascade : /restrict/i |
758 # End basically useless stuff. - ky
761 create_table : CREATE TABLE
763 create_index : CREATE /index/i
765 default_val : DEFAULT /(\d+|'[^']*'|\w+\(.*?\))|\w+/
767 my $val = defined $item[2] ? $item[2] : '';
770 supertype => 'constraint',
778 supertype => 'constraint',
784 name_with_opt_paren : NAME parens_value_list(s?)
785 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
787 unique : /unique/i { 1 }
789 key : /key/i | /index/i
791 table_option : /inherits/i '(' name_with_opt_quotes(s /,/) ')'
793 $return = { type => 'inherits', table_name => $item[3] }
798 $return = { type => $item[1] =~ /out/i ? 'without_oids' : 'with_oids' }
817 SEMICOLON : /\s*;\n?/
836 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
838 | /'.*?'/ # XXX doesn't handle embedded quotes
845 # -------------------------------------------------------------------
847 my ( $translator, $data ) = @_;
848 $parser ||= Parse::RecDescent->new($GRAMMAR);
850 $::RD_TRACE = $translator->trace ? 1 : undef;
851 $DEBUG = $translator->debug;
853 unless (defined $parser) {
854 return $translator->error("Error instantiating Parse::RecDescent ".
855 "instance: Bad grammer");
858 my $result = $parser->startrule($data);
859 die "Parse failed.\n" unless defined $result;
860 warn Dumper($result) if $DEBUG;
862 my $schema = $translator->schema;
864 $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
867 for my $table_name ( @tables ) {
868 my $tdata = $result->{ $table_name };
869 my $table = $schema->add_table(
870 name => $tdata->{'table_name'},
871 ) or die "Couldn't create table '$table_name': " . $schema->error;
874 $tdata->{'fields'}->{ $a }->{'order'}
876 $tdata->{'fields'}->{ $b }->{'order'}
877 } keys %{ $tdata->{'fields'} };
879 for my $fname ( @fields ) {
880 my $fdata = $tdata->{'fields'}{ $fname };
881 next if $fdata->{'drop'};
882 my $field = $table->add_field(
883 name => $fdata->{'name'},
884 data_type => $fdata->{'data_type'},
885 size => $fdata->{'size'},
886 default_value => $fdata->{'default'},
887 is_auto_increment => $fdata->{'is_auto_increment'},
888 is_nullable => $fdata->{'is_nullable'},
889 ) or die $table->error;
891 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
893 for my $cdata ( @{ $fdata->{'constraints'} } ) {
894 next unless $cdata->{'type'} eq 'foreign_key';
895 $cdata->{'fields'} ||= [ $field->name ];
896 push @{ $tdata->{'constraints'} }, $cdata;
900 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
901 my $index = $table->add_index(
902 name => $idata->{'name'},
903 type => uc $idata->{'type'},
904 fields => $idata->{'fields'},
905 ) or die $table->error;
908 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
909 my $constraint = $table->add_constraint(
910 name => $cdata->{'name'},
911 type => $cdata->{'type'},
912 fields => $cdata->{'fields'},
913 reference_table => $cdata->{'reference_table'},
914 reference_fields => $cdata->{'reference_fields'},
915 match_type => $cdata->{'match_type'} || '',
916 on_delete => $cdata->{'on_delete_do'},
917 on_update => $cdata->{'on_update_do'},
918 expression => $cdata->{'expression'},
919 ) or die "Can't add constraint of type '" .
920 $cdata->{'type'} . "' to table '" . $table->name .
921 "': " . $table->error;
930 # -------------------------------------------------------------------
931 # Rescue the drowning and tie your shoestrings.
932 # Henry David Thoreau
933 # -------------------------------------------------------------------
939 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
940 Allen Day E<lt>allenday@ucla.eduE<gt>.
944 perl(1), Parse::RecDescent.