1 package SQL::Translator::Parser::PostgreSQL;
3 # -------------------------------------------------------------------
4 # $Id: PostgreSQL.pm,v 1.29 2003-08-20 22:49:52 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.29 $ =~ /(\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 }
158 connect : /^\s*\\\connect.*\n/
160 set : /set/i /[^;]*/ ';'
162 revoke : /revoke/i WORD(s /,/) /on/i TABLE(?) table_name /from/i name_with_opt_quotes(s /,/) ';'
164 my $table_name = $item{'table_name'};
165 push @{ $tables{ $table_name }{'permissions'} }, {
172 grant : /grant/i WORD(s /,/) /on/i TABLE(?) table_name /to/i name_with_opt_quotes(s /,/) ';'
174 my $table_name = $item{'table_name'};
175 push @{ $tables{ $table_name }{'permissions'} }, {
182 drop : /drop/i /[^;]*/ ';'
184 insert : /insert/i /[^;]*/ ';'
186 update : /update/i /[^;]*/ ';'
191 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
193 my $table_name = $item{'table_name'};
194 $tables{ $table_name }{'order'} = ++$table_order;
195 $tables{ $table_name }{'table_name'} = $table_name;
199 for my $definition ( @{ $item[4] } ) {
200 if ( $definition->{'type'} eq 'field' ) {
201 my $field_name = $definition->{'name'};
202 $tables{ $table_name }{'fields'}{ $field_name } =
203 { %$definition, order => $i };
206 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
207 $constraint->{'fields'} = [ $field_name ];
208 push @{ $tables{ $table_name }{'constraints'} },
212 elsif ( $definition->{'type'} eq 'constraint' ) {
213 $definition->{'type'} = $definition->{'constraint_type'};
214 # group FKs at the field level
215 # if ( $definition->{'type'} eq 'foreign_key' ) {
216 # for my $fld ( @{ $definition->{'fields'} || [] } ) {
218 # $tables{$table_name}{'fields'}{$fld}{'constraints'}
223 push @{ $tables{ $table_name }{'constraints'} },
228 push @{ $tables{ $table_name }{'indices'} }, $definition;
232 for my $option ( @{ $item[6] } ) {
233 $tables{ $table_name }{'table_options(s?)'}{ $option->{'type'} } =
243 create : /create/i unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
245 push @{ $tables{ $item{'table_name'} }{'indices'} },
247 name => $item{'index_name'},
248 type => $item{'unique'}[0] ? 'unique' : 'normal',
250 method => $item{'using_method'}[0],
256 # Create anything else (e.g., domain, function, etc.)
258 create : /create/i WORD /[^;]+/ ';'
260 using_method : /using/i WORD { $item[2] }
262 where_predicate : /where/i /[^;]+/
264 create_definition : field
268 comment : /^\s*(?:#|-{2}).*\n/
270 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
272 my ( $default, @constraints, $is_pk );
274 for my $meta ( @{ $item[4] } ) {
275 if ( $meta->{'type'} eq 'default' ) {
279 elsif ( $meta->{'type'} eq 'not_null' ) {
283 elsif ( $meta->{'type'} eq 'primary_key' ) {
287 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
290 my @comments = ( @{ $item[1] }, @{ $item[5] } );
294 name => $item{'field_name'},
295 data_type => $item{'data_type'}{'type'},
296 size => $item{'data_type'}{'size'},
298 default => $default->{'value'},
299 constraints => [ @constraints ],
300 comments => [ @comments ],
301 is_primary_key => $is_pk || 0,
302 is_auto_increment => $item{'data_type'}{'is_auto_increment'},
307 field_meta : default_val
310 column_constraint : constraint_name(?) column_constraint_type deferrable(?) deferred(?)
312 my $desc = $item{'column_constraint_type'};
313 my $type = $desc->{'type'};
314 my $fields = $desc->{'fields'} || [];
315 my $expression = $desc->{'expression'} || '';
318 supertype => 'constraint',
319 name => $item{'constraint_name'}[0] || '',
321 expression => $type eq 'check' ? $expression : '',
322 deferrable => $item{'deferrable'},
323 deferred => $item{'deferred'},
324 reference_table => $desc->{'reference_table'},
325 reference_fields => $desc->{'reference_fields'},
326 match_type => $desc->{'match_type'},
327 on_delete_do => $desc->{'on_delete_do'},
328 on_update_do => $desc->{'on_update_do'},
332 constraint_name : /constraint/i name_with_opt_quotes { $item[2] }
334 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
337 { $return = { type => 'null' } }
340 { $return = { type => 'unique' } }
343 { $return = { type => 'primary_key' } }
345 /check/i '(' /[^)]+/ ')'
346 { $return = { type => 'check', expression => $item[2] } }
348 /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
350 my ( $on_delete, $on_update );
351 for my $action ( @{ $item[5] || [] } ) {
352 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
353 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
357 type => 'foreign_key',
358 reference_table => $item[2],
359 reference_fields => $item[3][0],
360 match_type => $item[4][0],
361 on_delete_do => $on_delete,
362 on_update_do => $on_update,
366 table_name : name_with_opt_quotes
368 field_name : name_with_opt_quotes
370 name_with_opt_quotes : double_quote(?) NAME double_quote(?) { $item[2] }
376 data_type : pg_data_type parens_value_list(?)
378 my $data_type = $item[1];
381 # We can deduce some sizes from the data type's name.
383 $data_type->{'size'} ||= $item[2][0];
385 $return = $data_type;
405 /(integer|int4?)/i # interval must come before this
421 /(double precision|float8?)/i
429 /(bigserial|serial8)/i
434 is_auto_increment => 1,
443 is_auto_increment => 1,
447 /(bit varying|varbit)/i
449 $return = { type => 'varbit' };
454 $return = { type => 'varchar' };
459 $return = { type => 'char' };
464 $return = { type => 'boolean' };
469 $return = { type => 'bytea' };
472 /(timestamptz|timestamp)/i
474 $return = { type => 'timestamp' };
485 /(bit|box|cidr|circle|date|inet|interval|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|timetz|time|varchar)/i
487 $return = { type => $item[1] };
490 parens_value_list : '(' VALUE(s /,/) ')'
493 parens_word_list : '(' WORD(s /,/) ')'
496 field_size : '(' num_range ')' { $item{'num_range'} }
498 num_range : DIGITS ',' DIGITS
499 { $return = $item[1].','.$item[3] }
501 { $return = $item[1] }
503 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
505 my $desc = $item{'table_constraint_type'};
506 my $type = $desc->{'type'};
507 my $fields = $desc->{'fields'};
508 my $expression = $desc->{'expression'};
509 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
512 name => $item{'constraint_name'}[0] || '',
513 type => 'constraint',
514 constraint_type => $type,
515 fields => $type ne 'check' ? $fields : [],
516 expression => $type eq 'check' ? $expression : '',
517 deferrable => $item{'deferrable'},
518 deferred => $item{'deferred'},
519 reference_table => $desc->{'reference_table'},
520 reference_fields => $desc->{'reference_fields'},
521 match_type => $desc->{'match_type'}[0],
522 on_delete_do => $desc->{'on_delete_do'},
523 on_update_do => $desc->{'on_update_do'},
524 comments => [ @comments ],
528 table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
531 type => 'primary_key',
536 /unique/i '(' name_with_opt_quotes(s /,/) ')'
544 /check/i '(' /(.+)/ ')'
548 expression => $item[3],
552 /foreign key/i '(' name_with_opt_quotes(s /,/) ')' /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
554 my ( $on_delete, $on_update );
555 for my $action ( @{ $item[9] || [] } ) {
556 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
557 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
561 type => 'foreign_key',
563 reference_table => $item[6],
564 reference_fields => $item[7][0],
565 match_type => $item[8][0],
566 on_delete_do => $on_delete || '',
567 on_update_do => $on_update || '',
571 deferrable : /not/i /deferrable/i
573 $return = ( $item[1] =~ /not/i ) ? 0 : 1;
576 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
578 match_type : /match full/i { 'match_full' }
580 /match partial/i { 'match_partial' }
582 key_action : key_delete
586 key_delete : /on delete/i key_mutation
594 key_update : /on update/i key_mutation
602 key_mutation : /no action/i { $return = 'no_action' }
604 /restrict/i { $return = 'restrict' }
606 /cascade/i { $return = 'cascade' }
608 /set null/i { $return = 'set null' }
610 /set default/i { $return = 'set default' }
612 alter : alter_table table_name /add/i table_constraint ';'
614 my $table_name = $item[2];
615 my $constraint = $item[4];
616 $constraint->{'type'} = $constraint->{'constraint_type'};
617 push @{ $tables{ $table_name }{'constraints'} }, $constraint;
620 alter_table : /alter/i /table/i only(?)
624 create_table : /create/i TABLE
626 create_index : /create/i /index/i
628 default_val : /default/i /(\d+|'[^']*'|\w+\(.*?\))|\w+/
630 my $val = defined $item[2] ? $item[2] : '';
633 supertype => 'constraint',
641 supertype => 'constraint',
647 name_with_opt_paren : NAME parens_value_list(s?)
648 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
650 unique : /unique/i { 1 }
652 key : /key/i | /index/i
654 table_option : /inherits/i '(' name_with_opt_quotes(s /,/) ')'
656 $return = { type => 'inherits', table_name => $item[3] }
661 $return = { type => $item[1] =~ /out/i ? 'without_oids' : 'with_oids' }
666 SEMICOLON : /\s*;\n?/
681 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
683 | /'.*?'/ # XXX doesn't handle embedded quotes
690 # -------------------------------------------------------------------
692 my ( $translator, $data ) = @_;
693 $parser ||= Parse::RecDescent->new($GRAMMAR);
695 $::RD_TRACE = $translator->trace ? 1 : undef;
696 $DEBUG = $translator->debug;
698 unless (defined $parser) {
699 return $translator->error("Error instantiating Parse::RecDescent ".
700 "instance: Bad grammer");
703 my $result = $parser->startrule($data);
704 die "Parse failed.\n" unless defined $result;
705 warn Dumper($result) if $DEBUG;
707 my $schema = $translator->schema;
709 $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
712 for my $table_name ( @tables ) {
713 my $tdata = $result->{ $table_name };
714 my $table = $schema->add_table(
715 name => $tdata->{'table_name'},
716 ) or die "Couldn't create table '$table_name': " . $schema->error;
719 $tdata->{'fields'}->{$a}->{'order'}
721 $tdata->{'fields'}->{$b}->{'order'}
722 } keys %{ $tdata->{'fields'} };
724 for my $fname ( @fields ) {
725 my $fdata = $tdata->{'fields'}{ $fname };
726 my $field = $table->add_field(
727 name => $fdata->{'name'},
728 data_type => $fdata->{'data_type'},
729 size => $fdata->{'size'},
730 default_value => $fdata->{'default'},
731 is_auto_increment => $fdata->{'is_auto_increment'},
732 is_nullable => $fdata->{'null'},
733 ) or die $table->error;
735 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
737 for my $cdata ( @{ $fdata->{'constraints'} } ) {
738 next unless $cdata->{'type'} eq 'foreign_key';
739 $cdata->{'fields'} ||= [ $field->name ];
740 push @{ $tdata->{'constraints'} }, $cdata;
744 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
745 my $index = $table->add_index(
746 name => $idata->{'name'},
747 type => uc $idata->{'type'},
748 fields => $idata->{'fields'},
749 ) or die $table->error;
752 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
753 my $constraint = $table->add_constraint(
754 name => $cdata->{'name'},
755 type => $cdata->{'type'},
756 fields => $cdata->{'fields'},
757 reference_table => $cdata->{'reference_table'},
758 reference_fields => $cdata->{'reference_fields'},
759 match_type => $cdata->{'match_type'} || '',
760 on_delete => $cdata->{'on_delete_do'},
761 on_update => $cdata->{'on_update_do'},
762 ) or die $table->error;
771 # -------------------------------------------------------------------
772 # Rescue the drowning and tie your shoestrings.
773 # Henry David Thoreau
774 # -------------------------------------------------------------------
780 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
781 Allen Day <allenday@ucla.edu>.
785 perl(1), Parse::RecDescent.