1 package SQL::Translator::Parser::PostgreSQL;
3 # -------------------------------------------------------------------
4 # $Id: PostgreSQL.pm,v 1.3 2003-02-25 02:03:55 allenday Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7 # darren chamberlain <darren@cpan.org>,
8 # Chris Mungall <cjm@fruitfly.org>
10 # This program is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU General Public License as
12 # published by the Free Software Foundation; version 2.
14 # This program is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program; if not, write to the Free Software
21 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
23 # -------------------------------------------------------------------
27 SQL::Translator::Parser::PostgreSQL - parser for PostgreSQL
32 use SQL::Translator::Parser::PostgreSQL;
34 my $translator = SQL::Translator->new;
35 $translator->parser("SQL::Translator::Parser::PostgreSQL");
39 The grammar is influenced heavily by Tim Bunce's "mysql2ora" grammar.
44 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
45 $VERSION = sprintf "%d.%02d", q$Revision: 1.3 $ =~ /(\d+)\.(\d+)/;
46 $DEBUG = 0 unless defined $DEBUG;
49 use Parse::RecDescent;
51 use base qw(Exporter);
53 @EXPORT_OK = qw(parse);
55 # Enable warnings within the Parse::RecDescent module.
56 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
57 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
58 $::RD_HINT = 1; # Give out hints to help fix problems.
60 my $parser; # should we do this? There's no programmic way to
61 # change the grammar, so I think this is safe.
65 { our ( %tables, $table_order ) }
67 startrule : statement(s) { \%tables }
74 drop : /drop/i WORD(s) ';'
76 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
78 my $table_name = $item{'table_name'};
79 $tables{ $table_name }{'order'} = ++$table_order;
80 $tables{ $table_name }{'table_name'} = $table_name;
83 for my $definition ( @{ $item[4] } ) {
84 if ( $definition->{'type'} eq 'field' ) {
85 my $field_name = $definition->{'name'};
86 $tables{ $table_name }{'fields'}{ $field_name } =
87 { %$definition, order => $i };
90 if ( $definition->{'is_primary_key'} ) {
91 push @{ $tables{ $table_name }{'indices'} },
93 type => 'primary_key',
94 fields => [ $field_name ],
100 push @{ $tables{ $table_name }{'indices'} },
105 for my $opt ( @{ $item{'table_option'} } ) {
106 if ( my ( $key, $val ) = each %$opt ) {
107 $tables{ $table_name }{'table_options'}{ $key } = $val;
112 create : /CREATE/i unique(?) /(INDEX|KEY)/i index_name /on/i table_name '(' field_name(s /,/) ')' ';'
114 push @{ $tables{ $item{'table_name'} }{'indices'} },
117 type => $item[2] ? 'unique' : 'normal',
123 create_definition : index
127 comment : /^\s*(?:#|-{2}).*\n/
131 field : field_name data_type field_qualifier(s?)
133 my %qualifiers = map { %$_ } @{ $item{'field_qualifier'} || [] };
134 my $null = defined $item{'not_null'} ? $item{'not_null'} : 1;
135 delete $qualifiers{'not_null'};
136 if ( my @type_quals = @{ $item{'data_type'}{'qualifiers'} || [] } ) {
137 $qualifiers{ $_ } = 1 for @type_quals;
142 name => $item{'field_name'},
143 data_type => $item{'data_type'}{'type'},
144 size => $item{'data_type'}{'size'},
145 list => $item{'data_type'}{'list'},
152 field_qualifier : not_null
155 null => $item{'not_null'},
159 field_qualifier : default_val
162 default => $item{'default_val'},
166 field_qualifier : auto_inc
169 is_auto_inc => $item{'auto_inc'},
173 field_qualifier : ',' primary_key '(' field_name ')'
176 is_primary_key => $item{'primary_key'},
180 field_qualifier : ',' foreign_key '(' field_name ')' foreign_key_reference foreign_table_name '(' foreign_field_name ')'
183 is_foreign_key => $item{'foreign_key'},
184 foreign_table => $item{'foreign_table_name'},
185 foreign_field => $item{'foreign_field_name'},
186 name => $item{'field_name'},
190 field_qualifier : unsigned
193 is_unsigned => $item{'unsigned'},
197 index : primary_key_index
204 foreign_table_name : WORD
208 foreign_field_name : WORD
212 data_type : WORD parens_value_list(s?) type_qualifier(s?)
216 my $size; # field size, applicable only to non-set fields
217 my $list; # set list, applicable only to sets (duh)
220 if(uc($type) =~ /^SERIAL$/){
222 } elsif ( uc($type) =~ /^(SET|ENUM)$/ ) {
231 if(uc($type) =~ /^VARCHAR$/ and not defined($size)){ $size = [255] }
237 qualifiers => $item[3],
241 parens_value_list : '(' VALUE(s /,/) ')'
244 type_qualifier : /(BINARY|UNSIGNED|ZEROFILL)/i
249 field_size : '(' num_range ')' { $item{'num_range'} }
251 num_range : DIGITS ',' DIGITS
252 { $return = $item[1].','.$item[3] }
254 { $return = $item[1] }
256 create_table : /create/i /table/i
258 create_index : /create/i /index/i
260 not_null : /not/i /null/i { $return = 0 }
262 unsigned : /unsigned/i { $return = 0 }
264 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
270 auto_inc : /auto_increment/i { 1 } #see data_type
272 primary_key : /primary/i /key/i { 1 }
274 foreign_key : /foreign/i /key/i { 1 }
276 foreign_key_reference : /references/i { 1 }
278 primary_key_index : primary_key index_name(?) '(' field_name(s /,/) ')'
281 name => $item{'index_name'}[0],
282 type => 'primary_key',
287 normal_index : key index_name(?) '(' name_with_opt_paren(s /,/) ')'
290 name => $item{'index_name'}[0],
296 unique_index : unique key(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
299 name => $item{'index_name'}[0],
305 fulltext_index : fulltext key(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
308 name => $item{'index_name'}[0],
314 name_with_opt_paren : NAME parens_value_list(s?)
315 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
317 fulltext : /fulltext/i { 1 }
319 unique : /unique/i { 1 }
321 key : /key/i | /index/i
323 table_option : /[^\s;]*/
325 $return = { split /=/, $item[1] }
339 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
341 | /'.*?'/ # XXX doesn't handle embedded quotes
348 # -------------------------------------------------------------------
350 my ( $translator, $data ) = @_;
351 $parser ||= Parse::RecDescent->new($GRAMMAR);
353 $::RD_TRACE = $translator->trace ? 1 : undef;
354 $DEBUG = $translator->debug;
356 unless (defined $parser) {
357 return $translator->error("Error instantiating Parse::RecDescent ".
358 "instance: Bad grammer");
361 my $result = $parser->startrule($data);
362 die "Parse failed.\n" unless defined $result;
363 warn Dumper($result) if $DEBUG;
369 #-----------------------------------------------------
370 # Where man is not nature is barren.
372 #-----------------------------------------------------
378 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
383 perl(1), Parse::RecDescent.