1 package SQL::Translator::Parser::PostgreSQL;
3 # -------------------------------------------------------------------
4 # $Id: PostgreSQL.pm,v 1.31 2003-08-21 18:08:04 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.31 $ =~ /(\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 ) }
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->{'supertype'} 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->{'supertype'} eq 'constraint' ) {
213 push @{ $tables{ $table_name }{'constraints'} }, $definition;
215 elsif ( $definition->{'supertype'} eq 'index' ) {
216 push @{ $tables{ $table_name }{'indices'} }, $definition;
220 for my $option ( @{ $item[6] } ) {
221 $tables{ $table_name }{'table_options(s?)'}{ $option->{'type'} } =
228 create : /create/i unique(?) /(index|key)/i index_name /on/i table_name using_method(?) '(' field_name(s /,/) ')' where_predicate(?) ';'
230 push @{ $tables{ $item{'table_name'} }{'indices'} },
232 name => $item{'index_name'},
233 supertype => $item{'unique'}[0] ? 'constraint' : 'index',
234 type => $item{'unique'}[0] ? 'unique' : 'normal',
236 method => $item{'using_method'}[0],
242 # Create anything else (e.g., domain, function, etc.)
244 create : /create/i WORD /[^;]+/ ';'
246 using_method : /using/i WORD { $item[2] }
248 where_predicate : /where/i /[^;]+/
250 create_definition : field
254 comment : /^\s*(?:#|-{2}).*\n/
256 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
258 my ( $default, @constraints, $is_pk );
260 for my $meta ( @{ $item[4] } ) {
261 if ( $meta->{'type'} eq 'default' ) {
265 elsif ( $meta->{'type'} eq 'not_null' ) {
269 elsif ( $meta->{'type'} eq 'primary_key' ) {
273 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
276 my @comments = ( @{ $item[1] }, @{ $item[5] } );
279 supertype => 'field',
280 name => $item{'field_name'},
281 data_type => $item{'data_type'}{'type'},
282 size => $item{'data_type'}{'size'},
284 default => $default->{'value'},
285 constraints => [ @constraints ],
286 comments => [ @comments ],
287 is_primary_key => $is_pk || 0,
288 is_auto_increment => $item{'data_type'}{'is_auto_increment'},
293 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 supertype => 'constraint',
305 name => $item{'constraint_name'}[0] || '',
307 expression => $type eq 'check' ? $expression : '',
308 deferrable => $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[3] } }
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;
391 /(integer|int4?)/i # interval must come before this
407 /(double precision|float8?)/i
415 /(bigserial|serial8)/i
420 is_auto_increment => 1,
429 is_auto_increment => 1,
433 /(bit varying|varbit)/i
435 $return = { type => 'varbit' };
440 $return = { type => 'varchar' };
445 $return = { type => 'char' };
450 $return = { type => 'boolean' };
455 $return = { type => 'bytea' };
458 /(timestamptz|timestamp)/i
460 $return = { type => 'timestamp' };
471 /(bit|box|cidr|circle|date|inet|interval|line|lseg|macaddr|money|numeric|decimal|path|point|polygon|timetz|time|varchar)/i
473 $return = { type => $item[1] };
476 parens_value_list : '(' VALUE(s /,/) ')'
479 parens_word_list : '(' WORD(s /,/) ')'
482 field_size : '(' num_range ')' { $item{'num_range'} }
484 num_range : DIGITS ',' DIGITS
485 { $return = $item[1].','.$item[3] }
487 { $return = $item[1] }
489 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
491 my $desc = $item{'table_constraint_type'};
492 my $type = $desc->{'type'};
493 my $fields = $desc->{'fields'};
494 my $expression = $desc->{'expression'};
495 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
498 name => $item{'constraint_name'}[0] || '',
499 supertype => 'constraint',
501 fields => $type ne 'check' ? $fields : [],
502 expression => $type eq 'check' ? $expression : '',
503 deferrable => $item{'deferrable'},
504 deferred => $item{'deferred'},
505 reference_table => $desc->{'reference_table'},
506 reference_fields => $desc->{'reference_fields'},
507 match_type => $desc->{'match_type'}[0],
508 on_delete_do => $desc->{'on_delete_do'},
509 on_update_do => $desc->{'on_update_do'},
510 comments => [ @comments ],
514 table_constraint_type : /primary key/i '(' name_with_opt_quotes(s /,/) ')'
517 type => 'primary_key',
522 /unique/i '(' name_with_opt_quotes(s /,/) ')'
530 /check/i '(' /[^)]+/ ')'
534 expression => $item[3],
538 /foreign key/i '(' name_with_opt_quotes(s /,/) ')' /references/i table_name parens_word_list(?) match_type(?) key_action(s?)
540 my ( $on_delete, $on_update );
541 for my $action ( @{ $item[9] || [] } ) {
542 $on_delete = $action->{'action'} if $action->{'type'} eq 'delete';
543 $on_update = $action->{'action'} if $action->{'type'} eq 'update';
547 supertype => 'constraint',
548 type => 'foreign_key',
550 reference_table => $item[6],
551 reference_fields => $item[7][0],
552 match_type => $item[8][0],
553 on_delete_do => $on_delete || '',
554 on_update_do => $on_update || '',
558 deferrable : /not/i /deferrable/i
560 $return = ( $item[1] =~ /not/i ) ? 0 : 1;
563 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
565 match_type : /match full/i { 'match_full' }
567 /match partial/i { 'match_partial' }
569 key_action : key_delete
573 key_delete : /on delete/i key_mutation
581 key_update : /on update/i key_mutation
589 key_mutation : /no action/i { $return = 'no_action' }
591 /restrict/i { $return = 'restrict' }
593 /cascade/i { $return = 'cascade' }
595 /set null/i { $return = 'set null' }
597 /set default/i { $return = 'set default' }
599 alter : alter_table table_name /add/i table_constraint ';'
601 my $table_name = $item[2];
602 my $constraint = $item[4];
603 push @{ $tables{ $table_name }{'constraints'} }, $constraint;
606 alter_table : /alter/i /table/i only(?)
610 create_table : /create/i TABLE
612 create_index : /create/i /index/i
614 default_val : /default/i /(\d+|'[^']*'|\w+\(.*?\))|\w+/
616 my $val = defined $item[2] ? $item[2] : '';
619 supertype => 'constraint',
627 supertype => 'constraint',
633 name_with_opt_paren : NAME parens_value_list(s?)
634 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
636 unique : /unique/i { 1 }
638 key : /key/i | /index/i
640 table_option : /inherits/i '(' name_with_opt_quotes(s /,/) ')'
642 $return = { type => 'inherits', table_name => $item[3] }
647 $return = { type => $item[1] =~ /out/i ? 'without_oids' : 'with_oids' }
652 SEMICOLON : /\s*;\n?/
667 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
669 | /'.*?'/ # XXX doesn't handle embedded quotes
676 # -------------------------------------------------------------------
678 my ( $translator, $data ) = @_;
679 $parser ||= Parse::RecDescent->new($GRAMMAR);
681 $::RD_TRACE = $translator->trace ? 1 : undef;
682 $DEBUG = $translator->debug;
684 unless (defined $parser) {
685 return $translator->error("Error instantiating Parse::RecDescent ".
686 "instance: Bad grammer");
689 my $result = $parser->startrule($data);
690 die "Parse failed.\n" unless defined $result;
691 warn Dumper($result) if $DEBUG;
693 my $schema = $translator->schema;
695 $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
698 for my $table_name ( @tables ) {
699 my $tdata = $result->{ $table_name };
700 my $table = $schema->add_table(
701 name => $tdata->{'table_name'},
702 ) or die "Couldn't create table '$table_name': " . $schema->error;
705 $tdata->{'fields'}->{ $a }->{'order'}
707 $tdata->{'fields'}->{ $b }->{'order'}
708 } keys %{ $tdata->{'fields'} };
710 for my $fname ( @fields ) {
711 my $fdata = $tdata->{'fields'}{ $fname };
712 my $field = $table->add_field(
713 name => $fdata->{'name'},
714 data_type => $fdata->{'data_type'},
715 size => $fdata->{'size'},
716 default_value => $fdata->{'default'},
717 is_auto_increment => $fdata->{'is_auto_increment'},
718 is_nullable => $fdata->{'null'},
719 ) or die $table->error;
721 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
723 for my $cdata ( @{ $fdata->{'constraints'} } ) {
724 next unless $cdata->{'type'} eq 'foreign_key';
725 $cdata->{'fields'} ||= [ $field->name ];
726 push @{ $tdata->{'constraints'} }, $cdata;
730 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
731 my $index = $table->add_index(
732 name => $idata->{'name'},
733 type => uc $idata->{'type'},
734 fields => $idata->{'fields'},
735 ) or die $table->error;
738 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
739 my $constraint = $table->add_constraint(
740 name => $cdata->{'name'},
741 type => $cdata->{'type'},
742 fields => $cdata->{'fields'},
743 reference_table => $cdata->{'reference_table'},
744 reference_fields => $cdata->{'reference_fields'},
745 match_type => $cdata->{'match_type'} || '',
746 on_delete => $cdata->{'on_delete_do'},
747 on_update => $cdata->{'on_update_do'},
748 expression => $cdata->{'expression'},
749 ) or die "Can't add constraint of type '" .
750 $cdata->{'type'} . "' to table '" . $table->name .
751 "': " . $table->error;
760 # -------------------------------------------------------------------
761 # Rescue the drowning and tie your shoestrings.
762 # Henry David Thoreau
763 # -------------------------------------------------------------------
769 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
770 Allen Day E<lt>allenday@ucla.eduE<gt>.
774 perl(1), Parse::RecDescent.