1 package SQL::Translator::Parser::PostgreSQL;
3 # -------------------------------------------------------------------
4 # $Id: PostgreSQL.pm,v 1.34 2003-12-10 23:09:19 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7 # Allen Day <allenday@users.sourceforge.net>,
8 # darren chamberlain <darren@cpan.org>,
9 # Chris Mungall <cjm@fruitfly.org>
11 # This program is free software; you can redistribute it and/or
12 # modify it under the terms of the GNU General Public License as
13 # published by the Free Software Foundation; version 2.
15 # This program is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 # General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with this program; if not, write to the Free Software
22 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
24 # -------------------------------------------------------------------
28 SQL::Translator::Parser::PostgreSQL - parser for PostgreSQL
33 use SQL::Translator::Parser::PostgreSQL;
35 my $translator = SQL::Translator->new;
36 $translator->parser("SQL::Translator::Parser::PostgreSQL");
40 The grammar was started from the MySQL parsers. Here is the description
44 (http://www.postgresql.org/docs/view.php?version=7.3&idoc=1&file=sql-createtable.html)
46 CREATE [ [ LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name (
47 { column_name data_type [ DEFAULT default_expr ]
48 [ column_constraint [, ... ] ]
49 | table_constraint } [, ... ]
51 [ INHERITS ( parent_table [, ... ] ) ]
52 [ WITH OIDS | WITHOUT OIDS ]
54 where column_constraint is:
56 [ CONSTRAINT constraint_name ]
57 { NOT NULL | NULL | UNIQUE | PRIMARY KEY |
59 REFERENCES reftable [ ( refcolumn ) ] [ MATCH FULL | MATCH PARTIAL ]
60 [ ON DELETE action ] [ ON UPDATE action ] }
61 [ DEFERRABLE | NOT DEFERRABLE ]
62 [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
64 and table_constraint is:
66 [ CONSTRAINT constraint_name ]
67 { UNIQUE ( column_name [, ... ] ) |
68 PRIMARY KEY ( column_name [, ... ] ) |
69 CHECK ( expression ) |
70 FOREIGN KEY ( column_name [, ... ] )
71 REFERENCES reftable [ ( refcolumn [, ... ] ) ]
72 [ MATCH FULL | MATCH PARTIAL ]
73 [ ON DELETE action ] [ ON UPDATE action ] }
74 [ DEFERRABLE | NOT DEFERRABLE ]
75 [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
78 (http://www.postgresql.org/docs/view.php?version=7.3&idoc=1&file=sql-createindex.html)
80 CREATE [ UNIQUE ] INDEX index_name ON table
81 [ USING acc_method ] ( column [ ops_name ] [, ...] )
83 CREATE [ UNIQUE ] INDEX index_name ON table
84 [ USING acc_method ] ( func_name( column [, ... ]) [ ops_name ] )
89 ALTER TABLE [ ONLY ] table [ * ]
90 ADD [ COLUMN ] column type [ column_constraint [ ... ] ]
91 ALTER TABLE [ ONLY ] table [ * ]
92 ALTER [ COLUMN ] column { SET DEFAULT value | DROP DEFAULT }
93 ALTER TABLE [ ONLY ] table [ * ]
94 ALTER [ COLUMN ] column SET STATISTICS integer
95 ALTER TABLE [ ONLY ] table [ * ]
96 RENAME [ COLUMN ] column TO newcolumn
100 ADD table_constraint_definition
101 ALTER TABLE [ ONLY ] table
102 DROP CONSTRAINT constraint { RESTRICT | CASCADE }
108 CREATE [ OR REPLACE ] VIEW view [ ( column name list ) ] AS SELECT query
113 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
114 $VERSION = sprintf "%d.%02d", q$Revision: 1.34 $ =~ /(\d+)\.(\d+)/;
115 $DEBUG = 0 unless defined $DEBUG;
118 use Parse::RecDescent;
120 use base qw(Exporter);
122 @EXPORT_OK = qw(parse);
124 # Enable warnings within the Parse::RecDescent module.
125 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
126 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
127 $::RD_HINT = 1; # Give out hints to help fix problems.
129 my $parser; # should we do this? There's no programmic way to
130 # change the grammar, so I think this is safe.
134 { my ( %tables, $table_order, $field_order, @table_comments) }
137 # The "eofile" rule makes the parser fail if any "statement" rule
138 # fails. Otherwise, the first successful match by a "statement"
139 # won't cause the failure needed to know that the parse, as a whole,
142 startrule : statement(s) eofile { \%tables }
160 connect : /^\s*\\\connect.*\n/
162 set : /set/i /[^;]*/ ';'
164 revoke : /revoke/i WORD(s /,/) /on/i TABLE(?) table_name /from/i name_with_opt_quotes(s /,/) ';'
166 my $table_name = $item{'table_name'};
167 push @{ $tables{ $table_name }{'permissions'} }, {
174 grant : /grant/i WORD(s /,/) /on/i TABLE(?) table_name /to/i name_with_opt_quotes(s /,/) ';'
176 my $table_name = $item{'table_name'};
177 push @{ $tables{ $table_name }{'permissions'} }, {
184 drop : /drop/i /[^;]*/ ';'
186 insert : /insert/i /[^;]*/ ';'
188 update : /update/i /[^;]*/ ';'
193 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
195 my $table_name = $item{'table_name'};
196 $tables{ $table_name }{'order'} = ++$table_order;
197 $tables{ $table_name }{'table_name'} = $table_name;
199 if ( @table_comments ) {
200 $tables{ $table_name }{'comments'} = [ @table_comments ];
201 @table_comments = ();
205 for my $definition ( @{ $item[4] } ) {
206 if ( $definition->{'supertype'} eq 'field' ) {
207 my $field_name = $definition->{'name'};
208 $tables{ $table_name }{'fields'}{ $field_name } =
209 { %$definition, order => $field_order++ };
211 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
212 $constraint->{'fields'} = [ $field_name ];
213 push @{ $tables{ $table_name }{'constraints'} },
217 elsif ( $definition->{'supertype'} eq 'constraint' ) {
218 push @{ $tables{ $table_name }{'constraints'} }, $definition;
220 elsif ( $definition->{'supertype'} eq 'index' ) {
221 push @{ $tables{ $table_name }{'indices'} }, $definition;
225 for my $option ( @{ $item[6] } ) {
226 $tables{ $table_name }{'table_options(s?)'}{ $option->{'type'} } =
233 create : /create/i unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
235 push @{ $tables{ $item{'table_name'} }{'indices'} },
237 name => $item{'index_name'},
238 supertype => $item{'unique'}[0] ? 'constraint' : 'index',
239 type => $item{'unique'}[0] ? 'unique' : 'normal',
241 method => $item{'using_method'}[0],
248 # Create anything else (e.g., domain, function, etc.)
250 create : /create/i WORD /[^;]+/ ';'
251 { @table_comments = (); }
253 using_method : /using/i WORD { $item[2] }
255 where_predicate : /where/i /[^;]+/
257 create_definition : field
261 table_comment : comment
263 my $comment = $item[1];
265 push @table_comments, $comment;
268 comment : /^\s*(?:#|-{2}).*\n/
270 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
272 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
275 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
277 my $table_name = $item[4]->{'table'};
278 my $field_name = $item[4]->{'field'};
279 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
280 $item{'comment_phrase'};
283 column_name : NAME '.' NAME
284 { $return = { table => $item[1], field => $item[3] } }
286 comment_phrase : /'.*?'|NULL/
288 my $val = $item[1] || '';
293 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
295 my ( $default, @constraints, $is_pk );
297 for my $meta ( @{ $item[4] } ) {
298 if ( $meta->{'type'} eq 'default' ) {
302 elsif ( $meta->{'type'} eq 'not_null' ) {
305 elsif ( $meta->{'type'} eq 'primary_key' ) {
309 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
312 my @comments = ( @{ $item[1] }, @{ $item[5] } );
315 supertype => 'field',
316 name => $item{'field_name'},
317 data_type => $item{'data_type'}{'type'},
318 size => $item{'data_type'}{'size'},
319 is_nullable => $is_nullable,
320 default => $default->{'value'},
321 constraints => [ @constraints ],
322 comments => [ @comments ],
323 is_primary_key => $is_pk || 0,
324 is_auto_increment => $item{'data_type'}{'is_auto_increment'},
329 field_meta : default_val
332 column_constraint : constraint_name(?) column_constraint_type deferrable(?) deferred(?)
334 my $desc = $item{'column_constraint_type'};
335 my $type = $desc->{'type'};
336 my $fields = $desc->{'fields'} || [];
337 my $expression = $desc->{'expression'} || '';
340 supertype => 'constraint',
341 name => $item{'constraint_name'}[0] || '',
343 expression => $type eq 'check' ? $expression : '',
344 deferrable => $item{'deferrable'},
345 deferred => $item{'deferred'},
346 reference_table => $desc->{'reference_table'},
347 reference_fields => $desc->{'reference_fields'},
348 match_type => $desc->{'match_type'},
349 on_delete_do => $desc->{'on_delete_do'},
350 on_update_do => $desc->{'on_update_do'},
354 constraint_name : /constraint/i name_with_opt_quotes { $item[2] }
356 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
359 { $return = { type => 'null' } }
362 { $return = { type => 'unique' } }
365 { $return = { type => 'primary_key' } }
367 /check/i '(' /[^)]+/ ')'
368 { $return = { type => 'check', expression => $item[3] } }
370 /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
372 my ( $on_delete, $on_update );
373 for my $action ( @{ $item[5] || [] } ) {
374 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
375 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
379 type => 'foreign_key',
380 reference_table => $item[2],
381 reference_fields => $item[3][0],
382 match_type => $item[4][0],
383 on_delete_do => $on_delete,
384 on_update_do => $on_update,
388 table_name : name_with_opt_quotes
390 field_name : name_with_opt_quotes
392 name_with_opt_quotes : double_quote(?) NAME double_quote(?) { $item[2] }
398 data_type : pg_data_type parens_value_list(?)
400 my $data_type = $item[1];
403 # We can deduce some sizes from the data type's name.
405 $data_type->{'size'} ||= $item[2][0];
407 $return = $data_type;
427 /(integer|int4?)/i # interval must come before this
443 /(double precision|float8?)/i
451 /(bigserial|serial8)/i
456 is_auto_increment => 1,
465 is_auto_increment => 1,
469 /(bit varying|varbit)/i
471 $return = { type => 'varbit' };
476 $return = { type => 'varchar' };
481 $return = { type => 'char' };
486 $return = { type => 'boolean' };
491 $return = { type => 'bytea' };
494 /(timestamptz|timestamp)/i
496 $return = { type => 'timestamp' };
507 /(bit|box|cidr|circle|date|inet|interval|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|timetz|time|varchar)/i
509 $return = { type => $item[1] };
512 parens_value_list : '(' VALUE(s /,/) ')'
515 parens_word_list : '(' WORD(s /,/) ')'
518 field_size : '(' num_range ')' { $item{'num_range'} }
520 num_range : DIGITS ',' DIGITS
521 { $return = $item[1].','.$item[3] }
523 { $return = $item[1] }
525 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
527 my $desc = $item{'table_constraint_type'};
528 my $type = $desc->{'type'};
529 my $fields = $desc->{'fields'};
530 my $expression = $desc->{'expression'};
531 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
534 name => $item{'constraint_name'}[0] || '',
535 supertype => 'constraint',
537 fields => $type ne 'check' ? $fields : [],
538 expression => $type eq 'check' ? $expression : '',
539 deferrable => $item{'deferrable'},
540 deferred => $item{'deferred'},
541 reference_table => $desc->{'reference_table'},
542 reference_fields => $desc->{'reference_fields'},
543 match_type => $desc->{'match_type'}[0],
544 on_delete_do => $desc->{'on_delete_do'},
545 on_update_do => $desc->{'on_update_do'},
546 comments => [ @comments ],
550 table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
553 type => 'primary_key',
558 /unique/i '(' name_with_opt_quotes(s /,/) ')'
566 /check/i '(' /[^)]+/ ')'
570 expression => $item[3],
574 /foreign key/i '(' name_with_opt_quotes(s /,/) ')' /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
576 my ( $on_delete, $on_update );
577 for my $action ( @{ $item[9] || [] } ) {
578 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
579 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
583 supertype => 'constraint',
584 type => 'foreign_key',
586 reference_table => $item[6],
587 reference_fields => $item[7][0],
588 match_type => $item[8][0],
589 on_delete_do => $on_delete || '',
590 on_update_do => $on_update || '',
594 deferrable : /not/i /deferrable/i
596 $return = ( $item[1] =~ /not/i ) ? 0 : 1;
599 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
601 match_type : /match full/i { 'match_full' }
603 /match partial/i { 'match_partial' }
605 key_action : key_delete
609 key_delete : /on delete/i key_mutation
617 key_update : /on update/i key_mutation
625 key_mutation : /no action/i { $return = 'no_action' }
627 /restrict/i { $return = 'restrict' }
629 /cascade/i { $return = 'cascade' }
631 /set null/i { $return = 'set null' }
633 /set default/i { $return = 'set default' }
635 alter : alter_table table_name add_column field ';'
637 my $field_def = $item[4];
638 $tables{ $item[2] }{'fields'}{ $field_def->{'name'} } = {
639 %$field_def, order => $field_order++
644 alter : alter_table table_name ADD table_constraint ';'
646 my $table_name = $item[2];
647 my $constraint = $item[4];
648 push @{ $tables{ $table_name }{'constraints'} }, $constraint;
652 alter : alter_table table_name drop_column NAME restrict_or_cascade(?) ';'
654 $tables{ $item[2] }{'fields'}{ $item[4] }{'drop'} = 1;
658 alter : alter_table table_name alter_column NAME alter_default_val ';'
660 $tables{ $item[2] }{'fields'}{ $item[4] }{'default'} =
666 # These will just parse for now but won't affect the structure. - ky
668 alter : alter_table table_name /rename/i /to/i NAME ';'
671 alter : alter_table table_name alter_column NAME SET /statistics/i INTEGER ';'
674 alter : alter_table table_name alter_column NAME SET /storage/i storage_type ';'
677 alter : alter_table table_name rename_column NAME /to/i NAME ';'
680 alter : alter_table table_name DROP /constraint/i NAME restrict_or_cascade ';'
683 alter : alter_table table_name /owner/i /to/i NAME ';'
686 storage_type : /(plain|external|extended|main)/i
688 alter_default_val : SET default_val
690 $return = { value => $item[2]->{'value'} }
694 $return = { value => undef }
698 # This is a little tricky to get right, at least WRT to making the
699 # tests pass. The problem is that the constraints are stored just as
700 # a list (no name access), and the tests expect the constraints in a
701 # particular order. I'm going to leave the rule but disable the code
704 alter : alter_table table_name alter_column NAME alter_nullable ';'
706 # my $table_name = $item[2];
707 # my $field_name = $item[4];
708 # my $is_nullable = $item[5]->{'is_nullable'};
710 # $tables{ $table_name }{'fields'}{ $field_name }{'is_nullable'} =
713 # if ( $is_nullable ) {
715 # push @{ $tables{ $table_name }{'constraints'} }, {
716 # type => 'not_null',
717 # fields => [ $field_name ],
722 # 0 .. $#{ $tables{ $table_name }{'constraints'} || [] }
724 # my $c = $tables{ $table_name }{'constraints'}[ $i ] or next;
725 # my $fields = join( '', @{ $c->{'fields'} || [] } ) or next;
726 # if ( $c->{'type'} eq 'not_null' && $fields eq $field_name ) {
727 # delete $tables{ $table_name }{'constraints'}[ $i ];
736 alter_nullable : SET not_null
738 $return = { is_nullable => 0 }
742 $return = { is_nullable => 1 }
745 not_null : /not/i /null/i
747 add_column : ADD COLUMN(?)
749 alter_table : ALTER TABLE ONLY(?)
751 drop_column : DROP COLUMN(?)
753 alter_column : ALTER COLUMN(?)
755 rename_column : /rename/i COLUMN(?)
757 restrict_or_cascade : /restrict/i |
761 # End basically useless stuff. - ky
764 create_table : /create/i TABLE
766 create_index : /create/i /index/i
768 default_val : DEFAULT /(\d+|'[^']*'|\w+\(.*?\))|\w+/
770 my $val = defined $item[2] ? $item[2] : '';
773 supertype => 'constraint',
781 supertype => 'constraint',
787 name_with_opt_paren : NAME parens_value_list(s?)
788 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
790 unique : /unique/i { 1 }
792 key : /key/i | /index/i
794 table_option : /inherits/i '(' name_with_opt_quotes(s /,/) ')'
796 $return = { type => 'inherits', table_name => $item[3] }
801 $return = { type => $item[1] =~ /out/i ? 'without_oids' : 'with_oids' }
818 SEMICOLON : /\s*;\n?/
837 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
839 | /'.*?'/ # XXX doesn't handle embedded quotes
846 # -------------------------------------------------------------------
848 my ( $translator, $data ) = @_;
849 $parser ||= Parse::RecDescent->new($GRAMMAR);
851 $::RD_TRACE = $translator->trace ? 1 : undef;
852 $DEBUG = $translator->debug;
854 unless (defined $parser) {
855 return $translator->error("Error instantiating Parse::RecDescent ".
856 "instance: Bad grammer");
859 my $result = $parser->startrule($data);
860 die "Parse failed.\n" unless defined $result;
861 warn Dumper($result) if $DEBUG;
863 my $schema = $translator->schema;
865 $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
868 for my $table_name ( @tables ) {
869 my $tdata = $result->{ $table_name };
870 my $table = $schema->add_table(
871 name => $tdata->{'table_name'},
872 ) or die "Couldn't create table '$table_name': " . $schema->error;
875 $tdata->{'fields'}->{ $a }->{'order'}
877 $tdata->{'fields'}->{ $b }->{'order'}
878 } keys %{ $tdata->{'fields'} };
880 for my $fname ( @fields ) {
881 my $fdata = $tdata->{'fields'}{ $fname };
882 next if $fdata->{'drop'};
883 my $field = $table->add_field(
884 name => $fdata->{'name'},
885 data_type => $fdata->{'data_type'},
886 size => $fdata->{'size'},
887 default_value => $fdata->{'default'},
888 is_auto_increment => $fdata->{'is_auto_increment'},
889 is_nullable => $fdata->{'is_nullable'},
890 ) or die $table->error;
892 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
894 for my $cdata ( @{ $fdata->{'constraints'} } ) {
895 next unless $cdata->{'type'} eq 'foreign_key';
896 $cdata->{'fields'} ||= [ $field->name ];
897 push @{ $tdata->{'constraints'} }, $cdata;
901 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
902 my $index = $table->add_index(
903 name => $idata->{'name'},
904 type => uc $idata->{'type'},
905 fields => $idata->{'fields'},
906 ) or die $table->error;
909 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
910 my $constraint = $table->add_constraint(
911 name => $cdata->{'name'},
912 type => $cdata->{'type'},
913 fields => $cdata->{'fields'},
914 reference_table => $cdata->{'reference_table'},
915 reference_fields => $cdata->{'reference_fields'},
916 match_type => $cdata->{'match_type'} || '',
917 on_delete => $cdata->{'on_delete_do'},
918 on_update => $cdata->{'on_update_do'},
919 expression => $cdata->{'expression'},
920 ) or die "Can't add constraint of type '" .
921 $cdata->{'type'} . "' to table '" . $table->name .
922 "': " . $table->error;
931 # -------------------------------------------------------------------
932 # Rescue the drowning and tie your shoestrings.
933 # Henry David Thoreau
934 # -------------------------------------------------------------------
940 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
941 Allen Day E<lt>allenday@ucla.eduE<gt>.
945 perl(1), Parse::RecDescent.