1 package SQL::Translator::Parser::PostgreSQL;
3 # -------------------------------------------------------------------
4 # $Id: PostgreSQL.pm,v 1.13 2003-05-03 04:09:50 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.13 $ =~ /(\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 { our ( %tables, $table_order ) }
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 }
156 connect : /^\s*\\\connect.*\n/
158 set : /SET/ /[^;]*/ ';'
160 revoke : /revoke/i WORD(s /,/) /on/i table_name /from/i name_with_opt_quotes(s /,/) ';'
162 my $table_name = $item{'table_name'};
163 push @{ $tables{ $table_name }{'permissions'} }, {
170 grant : /grant/i WORD(s /,/) /on/i table_name /to/i name_with_opt_quotes(s /,/) ';'
172 my $table_name = $item{'table_name'};
173 push @{ $tables{ $table_name }{'permissions'} }, {
180 drop : /drop/i /[^;]*/ ';'
185 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
187 my $table_name = $item{'table_name'};
188 $tables{ $table_name }{'order'} = ++$table_order;
189 $tables{ $table_name }{'table_name'} = $table_name;
193 for my $definition ( @{ $item[4] } ) {
194 if ( $definition->{'type'} eq 'field' ) {
195 my $field_name = $definition->{'name'};
196 $tables{ $table_name }{'fields'}{ $field_name } =
197 { %$definition, order => $i };
200 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
201 $constraint->{'fields'} = [ $field_name ];
202 push @{ $tables{ $table_name }{'constraints'} },
206 elsif ( $definition->{'type'} eq 'constraint' ) {
207 $definition->{'type'} = $definition->{'constraint_type'};
208 # group FKs at the field level
209 if ( $definition->{'type'} eq 'foreign_key' ) {
210 for my $fld ( @{ $definition->{'fields'} || [] } ) {
212 $tables{$table_name}{'fields'}{$fld}{'constraints'}
217 push @{ $tables{ $table_name }{'constraints'} },
222 push @{ $tables{ $table_name }{'indices'} }, $definition;
226 for my $option ( @{ $item[6] } ) {
227 $tables{ $table_name }{'table_options(s?)'}{ $option->{'type'} } =
237 create : /create/i unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
239 push @{ $tables{ $item{'table_name'} }{'indices'} },
241 name => $item{'index_name'},
242 type => $item{'unique'}[0] ? 'unique' : 'normal',
244 method => $item{'using_method'}[0],
250 # Create anything else (e.g., domain, function, etc.)
252 create : /create/i WORD /[^;]+/ ';'
254 using_method : /using/i WORD { $item[2] }
256 where_predicate : /where/i /[^;]+/
258 create_definition : field
262 comment : /^\s*(?:#|-{2}).*\n/
264 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
266 my ( $default, @constraints, $is_pk );
267 for my $meta ( @{ $item[4] } ) {
268 $default = $meta if $meta->{'meta_type'} eq 'default';
269 push @constraints, $meta if $meta->{'meta_type'} eq 'constraint';
270 $is_pk = $meta->{'type'} eq 'primary_key';
273 my $null = ( grep { $_->{'type'} eq 'not_null' } @constraints ) ? 0 : 1;
275 my @comments = ( @{ $item[1] }, @{ $item[5] } );
279 name => $item{'field_name'},
280 data_type => $item{'data_type'}{'type'},
281 size => $item{'data_type'}{'size'},
282 list => $item{'data_type'}{'list'},
284 default => $default->{'value'},
285 constraints => [ @constraints ],
286 comments => [ @comments ],
287 is_primary_key => $is_pk || 0,
292 field_meta : default_val
296 column_constraint : constraint_name(?) column_constraint_type deferrable(?) deferred(?)
298 my $desc = $item{'column_constraint_type'};
299 my $type = $desc->{'type'};
300 my $fields = $desc->{'fields'} || [];
301 my $expression = $desc->{'expression'} || '';
304 meta_type => 'constraint',
305 name => $item{'constraint_name'}[0] || '',
307 expression => $type eq 'check' ? $expression : '',
308 deferreable => $item{'deferrable'},
309 deferred => $item{'deferred'},
310 reference_table => $desc->{'reference_table'},
311 reference_fields => $desc->{'reference_fields'},
312 match_type => $desc->{'match_type'},
313 on_delete_do => $desc->{'on_delete_do'},
314 on_update_do => $desc->{'on_update_do'},
318 constraint_name : /constraint/i name_with_opt_quotes { $item[2] }
320 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
323 { $return = { type => 'null' } }
326 { $return = { type => 'unique' } }
329 { $return = { type => 'primary_key' } }
331 /check/i '(' /[^)]+/ ')'
332 { $return = { type => 'check', expression => $item[2] } }
334 /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
336 my ( $on_delete, $on_update );
337 for my $action ( @{ $item[5] || [] } ) {
338 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
339 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
343 type => 'foreign_key',
344 reference_table => $item[2],
345 reference_fields => $item[3][0],
346 match_type => $item[4][0],
347 on_delete_do => $on_delete,
348 on_update_do => $on_update,
352 table_name : name_with_opt_quotes
354 field_name : name_with_opt_quotes
356 name_with_opt_quotes : double_quote(?) NAME double_quote(?) { $item[2] }
362 data_type : pg_data_type parens_value_list(?)
364 my $data_type = $item[1];
367 # We can deduce some sizes from the data type's name.
369 $data_type->{'size'} ||= $item[2][0];
371 $return = $data_type;
375 /(bigint|int8|bigserial|serial8)/
400 /(double precision|float8?)/
434 /(bit varying|varbit)/
436 $return = { type => 'varbit' };
441 $return = { type => 'varchar' };
446 $return = { type => 'char' };
451 $return = { type => 'boolean' };
454 /(bytea|binary data)/
456 $return = { type => 'binary' };
461 $return = { type => 'timestamp' };
464 /(bit|box|cidr|circle|date|inet|interval|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|text|time|varchar)/
466 $return = { type => $item[1] };
469 parens_value_list : '(' VALUE(s /,/) ')'
472 parens_word_list : '(' WORD(s /,/) ')'
475 field_size : '(' num_range ')' { $item{'num_range'} }
477 num_range : DIGITS ',' DIGITS
478 { $return = $item[1].','.$item[3] }
480 { $return = $item[1] }
482 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
484 my $desc = $item{'table_constraint_type'};
485 my $type = $desc->{'type'};
486 my $fields = $desc->{'fields'};
487 my $expression = $desc->{'expression'};
488 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
491 name => $item{'constraint_name'}[0] || '',
492 type => 'constraint',
493 constraint_type => $type,
494 fields => $type ne 'check' ? $fields : [],
495 expression => $type eq 'check' ? $expression : '',
496 deferreable => $item{'deferrable'},
497 deferred => $item{'deferred'},
498 reference_table => $desc->{'reference_table'},
499 reference_fields => $desc->{'reference_fields'},
500 match_type => $desc->{'match_type'}[0],
501 on_delete_do => $desc->{'on_delete_do'},
502 on_update_do => $desc->{'on_update_do'},
503 comments => [ @comments ],
507 table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
510 type => 'primary_key',
515 /unique/i '(' name_with_opt_quotes(s /,/) ')'
523 /check/ '(' /(.+)/ ')'
527 expression => $item[3],
531 /foreign key/i '(' name_with_opt_quotes(s /,/) ')' /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
533 my ( $on_delete, $on_update );
534 for my $action ( @{ $item[9] || [] } ) {
535 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
536 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
540 type => 'foreign_key',
542 reference_table => $item[6],
543 reference_fields => $item[7][0],
544 match_type => $item[8][0],
545 on_delete_do => $on_delete || '',
546 on_update_do => $on_update || '',
550 deferrable : /not/i /deferrable/i
552 $return = ( $item[1] =~ /not/i ) ? 0 : 1;
555 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
557 match_type : /match full/i { 'match_full' }
559 /match partial/i { 'match_partial' }
561 key_action : key_delete
565 key_delete : /on delete/i key_mutation
573 key_update : /on update/i key_mutation
581 key_mutation : /no action/i { $return = 'no_action' }
583 /restrict/i { $return = 'restrict' }
585 /cascade/i { $return = 'cascade' }
587 /set null/i { $return = 'set_null' }
589 /set default/i { $return = 'set_default' }
591 alter : alter_table table_name /add/i table_constraint ';'
593 my $table_name = $item[2];
594 my $constraint = $item[4];
595 $constraint->{'type'} = $constraint->{'constraint_type'};
596 push @{ $tables{ $table_name }{'constraints'} }, $constraint;
599 alter_table : /alter/i /table/i only(?)
603 create_table : /create/i /table/i
605 create_index : /create/i /index/i
607 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
609 my $val = $item[2] || '';
612 meta_type => 'default',
617 name_with_opt_paren : NAME parens_value_list(s?)
618 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
620 unique : /unique/i { 1 }
622 key : /key/i | /index/i
624 table_option : /inherits/i '(' name_with_opt_quotes(s /,/) ')'
626 $return = { type => 'inherits', table_name => $item[3] }
631 $return = { type => $item[1] =~ /out/i ? 'without_oids' : 'with_oids' }
634 SEMICOLON : /\s*;\n?/
649 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
651 | /'.*?'/ # XXX doesn't handle embedded quotes
658 # -------------------------------------------------------------------
660 my ( $translator, $data ) = @_;
661 $parser ||= Parse::RecDescent->new($GRAMMAR);
663 $::RD_TRACE = $translator->trace ? 1 : undef;
664 $DEBUG = $translator->debug;
666 unless (defined $parser) {
667 return $translator->error("Error instantiating Parse::RecDescent ".
668 "instance: Bad grammer");
671 my $result = $parser->startrule($data);
672 die "Parse failed.\n" unless defined $result;
673 warn Dumper($result) if $DEBUG;
679 #-----------------------------------------------------
680 # Where man is not nature is barren.
682 #-----------------------------------------------------
688 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
689 Allen Day <allenday@ucla.edu>.
693 perl(1), Parse::RecDescent.