1 package SQL::Translator::Producer::PostgreSQL;
3 # -------------------------------------------------------------------
4 # $Id: PostgreSQL.pm,v 1.14 2003-08-18 15:43:15 kycl4rk 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::Producer::PostgreSQL - PostgreSQL producer for SQL::Translator
32 use vars qw[ $DEBUG $WARN $VERSION ];
33 $VERSION = sprintf "%d.%02d", q$Revision: 1.14 $ =~ /(\d+)\.(\d+)/;
34 $DEBUG = 1 unless defined $DEBUG;
36 use SQL::Translator::Schema::Constants;
37 use SQL::Translator::Utils qw(header_comment);
45 double => 'double precision',
47 float => 'double precision',
49 mediumint => 'integer',
50 smallint => 'smallint',
51 tinyint => 'smallint',
53 varchar => 'character varying',
60 mediumblob => 'bytea',
62 enum => 'character varying',
63 set => 'character varying',
65 datetime => 'timestamp',
67 timestamp => 'timestamp',
75 varchar2 => 'character varying',
85 varchar => 'character varying',
86 datetime => 'timestamp',
88 real => 'double precision',
91 tinyint => 'smallint',
92 float => 'double precision',
95 my %reserved = map { $_, 1 } qw[
96 ALL ANALYSE ANALYZE AND ANY AS ASC
98 CASE CAST CHECK COLLATE COLUMN CONSTRAINT CROSS
99 CURRENT_DATE CURRENT_TIME CURRENT_TIMESTAMP CURRENT_USER
100 DEFAULT DEFERRABLE DESC DISTINCT DO
102 FALSE FOR FOREIGN FREEZE FROM FULL
104 ILIKE IN INITIALLY INNER INTERSECT INTO IS ISNULL
105 JOIN LEADING LEFT LIKE LIMIT
106 NATURAL NEW NOT NOTNULL NULL
107 OFF OFFSET OLD ON ONLY OR ORDER OUTER OVERLAPS
108 PRIMARY PUBLIC REFERENCES RIGHT
109 SELECT SESSION_USER SOME TABLE THEN TO TRAILING TRUE
110 UNION UNIQUE USER USING VERBOSE WHEN WHERE
113 my $max_id_length = 30;
114 my %used_identifiers = ();
121 =head1 PostgreSQL Create Table Syntax
123 CREATE [ [ LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name (
124 { column_name data_type [ DEFAULT default_expr ] [ column_constraint [, ... ] ]
125 | table_constraint } [, ... ]
127 [ INHERITS ( parent_table [, ... ] ) ]
128 [ WITH OIDS | WITHOUT OIDS ]
130 where column_constraint is:
132 [ CONSTRAINT constraint_name ]
133 { NOT NULL | NULL | UNIQUE | PRIMARY KEY |
135 REFERENCES reftable [ ( refcolumn ) ] [ MATCH FULL | MATCH PARTIAL ]
136 [ ON DELETE action ] [ ON UPDATE action ] }
137 [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
139 and table_constraint is:
141 [ CONSTRAINT constraint_name ]
142 { UNIQUE ( column_name [, ... ] ) |
143 PRIMARY KEY ( column_name [, ... ] ) |
144 CHECK ( expression ) |
145 FOREIGN KEY ( column_name [, ... ] ) REFERENCES reftable [ ( refcolumn [, ... ] ) ]
146 [ MATCH FULL | MATCH PARTIAL ] [ ON DELETE action ] [ ON UPDATE action ] }
147 [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
149 =head1 Create Index Syntax
151 CREATE [ UNIQUE ] INDEX index_name ON table
152 [ USING acc_method ] ( column [ ops_name ] [, ...] )
154 CREATE [ UNIQUE ] INDEX index_name ON table
155 [ USING acc_method ] ( func_name( column [, ... ]) [ ops_name ] )
160 # -------------------------------------------------------------------
162 my $translator = shift;
163 $DEBUG = $translator->debug;
164 $WARN = $translator->show_warnings;
165 my $no_comments = $translator->no_comments;
166 my $add_drop_table = $translator->add_drop_table;
167 my $schema = $translator->schema;
170 $output .= header_comment unless ($no_comments);
171 my %used_index_names;
173 for my $table ( $schema->get_tables ) {
174 my $table_name = $table->name or next;
175 $table_name = mk_name( $table_name, '', undef, 1 );
176 my $table_name_ur = unreserve($table_name);
178 my ( @comments, @field_defs, @sequence_defs, @constraint_defs );
180 push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;
185 my %field_name_scope;
186 for my $field ( $table->get_fields ) {
187 my $field_name = mk_name(
188 $field->name, '', \%field_name_scope, 1
190 my $field_name_ur = unreserve( $field_name, $table_name );
191 my $field_def = qq["$field_name_ur"];
196 my @size = $field->size;
197 my $data_type = lc $field->data_type;
198 my %extra = $field->extra;
199 my $list = $extra{'list'} || [];
200 # todo deal with embedded quotes
201 my $commalist = join( ', ', map { qq['$_'] } @$list );
204 if ( $data_type eq 'enum' ) {
206 $len = ($len < length($_)) ? length($_) : $len for (@$list);
207 my $chk_name = mk_name( $table_name.'_'.$field_name, 'chk' );
208 push @constraint_defs,
209 qq[CONSTRAINT $chk_name CHECK ("$field_name" IN ($commalist))];
210 $data_type = 'character varying';
212 elsif ( $data_type eq 'set' ) {
213 # XXX add a CHECK constraint maybe
214 # (trickier and slower, than enum :)
215 # my $len = length $commalist;
216 # $field_def .= " character varying($len) /* set $commalist */";
217 $data_type = 'character varying';
219 elsif ( $field->is_auto_increment ) {
220 if ( defined $size[0] && $size[0] > 11 ) {
221 $data_type = ' bigserial';
224 $data_type = ' serial';
228 # $seq_name = mk_name( $table_name.'_'.$field_name, 'sq' );
229 # push @sequence_defs, qq[DROP SEQUENCE "$seq_name";];
230 # push @sequence_defs, qq[CREATE SEQUENCE "$seq_name";];
233 $data_type = defined $translate{ $data_type } ?
234 $translate{ $data_type } :
238 if ( $data_type =~ /timestamp/i ) {
239 if ( defined $size[0] && $size[0] > 13 ) {
244 if ( $data_type eq 'integer' ) {
245 if ( defined $size[0] ) {
246 if ( $size[0] > 10 ) { #
247 $data_type = ' bigint';
249 elsif ( $size[0] < 5 ) {
250 $data_type = ' smallint';
253 $data_type = ' integer';
257 $data_type = ' integer';
262 $field_def .= " $data_type";
264 if ( defined $size[0] && $size[0] > 0 ) {
265 $field_def .= '(' . join( ', ', @size ) . ')';
271 my $default = $field->default_value;
272 if ( defined $default ) {
273 $field_def .= sprintf( ' DEFAULT %s',
274 ( $field->is_auto_increment && $seq_name )
275 ? qq[nextval('"$seq_name"'::text)] :
276 ( $default =~ m/null/i ) ? 'NULL' : "'$default'"
281 # Not null constraint
283 $field_def .= ' NOT NULL' unless $field->is_nullable;
285 push @field_defs, $field_def;
292 my $idx_name_default;
293 for my $index ( $table->get_indices ) {
294 my $name = $index->name || '';
295 my $type = $index->type || NORMAL;
297 map { $_ =~ s/\(.+\)//; $_ }
298 map { unreserve( $_, $table_name ) }
302 if ( $type eq PRIMARY_KEY ) {
303 $name ||= mk_name( $table_name, 'pk' );
304 $name = next_unused_name($name, \%used_index_names);
305 # how do I get next_unused_name() to do: ?
306 $used_index_names{$name} = $name;
307 push @constraint_defs, 'CONSTRAINT '.$name.' PRIMARY KEY '.
308 '("' . join( '", "', @fields ) . '")';
310 elsif ( $type eq UNIQUE ) {
312 $table_name, $name || ++$idx_name_default
314 $name = next_unused_name($name, \%used_index_names);
315 $used_index_names{$name} = $name;
316 push @constraint_defs, 'CONSTRAINT ' . $name . ' UNIQUE ' .
317 '("' . join( '", "', @fields ) . '")';
319 elsif ( $type eq NORMAL ) {
321 $table_name, $name || ++$idx_name_default
323 $name = next_unused_name($name, \%used_index_names);
324 $used_index_names{$name} = $name;
326 qq[CREATE INDEX "$name" on $table_name_ur ("].
327 join( '", "', @fields ).
331 warn "Unknown index type ($type) on table $table_name.\n"
340 for my $c ( $table->get_constraints ) {
341 my $name = $c->name || '';
343 map { $_ =~ s/\(.+\)//; $_ }
344 map { unreserve( $_, $table_name ) }
347 map { $_ =~ s/\(.+\)//; $_ }
348 map { unreserve( $_, $table_name ) }
349 $c->reference_fields;
352 if ( $c->type eq PRIMARY_KEY ) {
353 $name ||= mk_name( $table_name, 'pk' );
354 $name = next_unused_name($name, \%used_index_names);
355 $used_index_names{$name} = $name;
356 push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ".
357 '("' . join( '", "', @fields ) . '")';
359 elsif ( $c->type eq UNIQUE ) {
361 $table_name, $name || ++$c_name_default
363 $name = next_unused_name($name, \%used_index_names);
364 $used_index_names{$name} = $name;
365 push @constraint_defs, "CONSTRAINT $name UNIQUE " .
366 '("' . join( '", "', @fields ) . '")';
368 elsif ( $c->type eq FOREIGN_KEY ) {
370 map { $_ || () } 'FOREIGN KEY', $c->name
373 $def .= ' ("' . join( '", "', @fields ) . '")';
375 $def .= ' REFERENCES ' . $c->reference_table;
378 $def .= ' ("' . join( '", "', @rfields ) . '")';
381 if ( $c->match_type ) {
383 ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
386 if ( $c->on_delete ) {
387 $def .= ' ON DELETE '.join( ' ', $c->on_delete );
390 if ( $c->on_update ) {
391 $def .= ' ON UPDATE '.join( ' ', $c->on_update );
394 push @constraint_defs, $def;
398 my $create_statement;
399 $create_statement = qq[DROP TABLE "$table_name_ur";\n]
401 $create_statement .= qq[CREATE TABLE "$table_name_ur" (\n].
402 join( ",\n", map { " $_" } @field_defs, @constraint_defs ).
406 $output .= join( "\n\n",
417 warn "Truncated " . keys( %truncated ) . " names:\n";
418 warn "\t" . join( "\n\t", sort keys %truncated ) . "\n";
422 warn "Encounted " . keys( %unreserve ) .
423 " unsafe names in schema (reserved or invalid):\n";
424 warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n";
431 # -------------------------------------------------------------------
433 my $basename = shift || '';
434 my $type = shift || '';
435 my $scope = shift || '';
436 my $critical = shift || '';
437 my $basename_orig = $basename;
439 ? $max_id_length - (length($type) + 1)
441 $basename = substr( $basename, 0, $max_name )
442 if length( $basename ) > $max_name;
443 my $name = $type ? "${type}_$basename" : $basename;
445 if ( $basename ne $basename_orig and $critical ) {
446 my $show_type = $type ? "+'$type'" : "";
447 warn "Truncating '$basename_orig'$show_type to $max_id_length ",
448 "character limit to make '$name'\n" if $WARN;
449 $truncated{ $basename_orig } = $name;
452 $scope ||= \%global_names;
453 if ( my $prev = $scope->{ $name } ) {
454 my $name_orig = $name;
455 $name .= sprintf( "%02d", ++$prev );
456 substr($name, $max_id_length - 3) = "00"
457 if length( $name ) > $max_id_length;
459 warn "The name '$name_orig' has been changed to ",
460 "'$name' to make it unique.\n" if $WARN;
462 $scope->{ $name_orig }++;
469 # -------------------------------------------------------------------
471 my $name = shift || '';
472 my $schema_obj_name = shift || '';
474 my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
476 # also trap fields that don't begin with a letter
477 return $name if !$reserved{ uc $name } && $name =~ /^[a-z]/i;
479 if ( $schema_obj_name ) {
480 ++$unreserve{"$schema_obj_name.$name"};
483 ++$unreserve{"$name (table name)"};
486 my $unreserve = sprintf '%s_', $name;
487 return $unreserve.$suffix;
490 # -------------------------------------------------------------------
491 sub next_unused_name {
492 my $name = shift || '';
493 my $used_names = shift || '';
495 my %used_names = %$used_names;
497 if ( !defined($used_names{$name}) ) {
498 $used_names{$name} = $name;
503 while ( defined($used_names{$name . $i}) ) {
507 $used_names{$name} = $name;
513 # -------------------------------------------------------------------
514 # Life is full of misery, loneliness, and suffering --
515 # and it's all over much too soon.
517 # -------------------------------------------------------------------
523 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>