package SQL::Translator::Producer::PostgreSQL;
# -------------------------------------------------------------------
-# $Id: PostgreSQL.pm,v 1.3 2002-11-26 03:59:58 kycl4rk Exp $
+# $Id: PostgreSQL.pm,v 1.20 2003-10-15 19:07:13 kycl4rk Exp $
# -------------------------------------------------------------------
-# Copyright (C) 2002 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>
+# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
+# darren chamberlain <darren@cpan.org>,
+# Chris Mungall <cjm@fruitfly.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
SQL::Translator::Producer::PostgreSQL - PostgreSQL producer for SQL::Translator
+=head1 SYNOPSIS
+
+ my $t = SQL::Translator->new( parser => '...', producer => 'PostgreSQL' );
+ $t->translate;
+
+=head1 DESCRIPTION
+
+Creates a DDL suitable for PostgreSQL. Very heavily based on the Oracle
+producer.
+
=cut
use strict;
use vars qw[ $DEBUG $WARN $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.3 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.20 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 1 unless defined $DEBUG;
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Utils qw(header_comment);
use Data::Dumper;
my %translate = (
# MySQL types
#
bigint => 'bigint',
- double => 'double precision',
- decimal => 'decimal',
- float => 'double precision',
+ double => 'numeric',
+ decimal => 'numeric',
+ float => 'numeric',
int => 'integer',
mediumint => 'integer',
smallint => 'smallint',
tinyint => 'smallint',
- char => 'char',
- varchar => 'varchar',
+ char => 'character',
+ varchar => 'character varying',
longtext => 'text',
mediumtext => 'text',
text => 'text',
blob => 'bytea',
mediumblob => 'bytea',
longblob => 'bytea',
- enum => 'varchar',
- set => 'varchar',
+ enum => 'character varying',
+ set => 'character varying',
date => 'date',
datetime => 'timestamp',
time => 'date',
# Oracle types
#
number => 'integer',
- char => 'char',
- varchar2 => 'varchar',
+ char => 'character',
+ varchar2 => 'character varying',
long => 'text',
CLOB => 'bytea',
date => 'date',
#
int => 'integer',
money => 'money',
- varchar => 'varchar',
+ varchar => 'character varying',
datetime => 'timestamp',
text => 'text',
- real => 'double precision',
+ real => 'numeric',
comment => 'text',
bit => 'bit',
tinyint => 'smallint',
- float => 'double precision',
+ float => 'numeric',
);
my %reserved = map { $_, 1 } qw[
[ MATCH FULL | MATCH PARTIAL ] [ ON DELETE action ] [ ON UPDATE action ] }
[ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
+=head1 Create Index Syntax
+
+ CREATE [ UNIQUE ] INDEX index_name ON table
+ [ USING acc_method ] ( column [ ops_name ] [, ...] )
+ [ WHERE predicate ]
+ CREATE [ UNIQUE ] INDEX index_name ON table
+ [ USING acc_method ] ( func_name( column [, ... ]) [ ops_name ] )
+ [ WHERE predicate ]
+
=cut
# -------------------------------------------------------------------
sub produce {
- my ( $translator, $data ) = @_;
- $DEBUG = $translator->debug;
- $WARN = $translator->show_warnings;
- my $no_comments = $translator->no_comments;
- my $add_drop_table = $translator->add_drop_table;
-
- my $create;
- unless ( $no_comments ) {
- $create .= sprintf
- "--\n-- Created by %s\n-- Created on %s\n--\n\n",
- __PACKAGE__, scalar localtime;
- }
+ my $translator = shift;
+ $DEBUG = $translator->debug;
+ $WARN = $translator->show_warnings;
+ my $no_comments = $translator->no_comments;
+ my $add_drop_table = $translator->add_drop_table;
+ my $schema = $translator->schema;
+
+ my $output;
+ $output .= header_comment unless ($no_comments);
+ my %used_index_names;
- for my $table (
- map { $_->[1] }
- sort { $a->[0] <=> $b->[0] }
- map { [ $_->{'order'}, $_ ] }
- values %$data
- ) {
- my $table_name = $table->{'table_name'};
- my @fields =
- map { $_->[1] }
- sort { $a->[0] <=> $b->[0] }
- map { [ $_->{'order'}, $_ ] }
- values %{ $table->{'fields'} };
-
- $create .= "--\n-- Table: $table_name\n--\n" unless $no_comments;
- $create = "DROP TABLE $table_name;\n" if $add_drop_table;
- $create .= "CREATE TABLE $table_name (\n";
+ my @fks;
+ for my $table ( $schema->get_tables ) {
+ my $table_name = $table->name or next;
+ $table_name = mk_name( $table_name, '', undef, 1 );
+ my $table_name_ur = unreserve($table_name);
+
+ my ( @comments, @field_defs, @sequence_defs, @constraint_defs );
+
+ push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;
#
# Fields
#
my %field_name_scope;
- my @field_statements;
- for my $field ( @fields ) {
- my @fdata = ("", $field);
-
+ for my $field ( $table->get_fields ) {
my $field_name = mk_name(
- $field->{'name'}, '', \%field_name_scope, 1
+ $field->name, '', \%field_name_scope, 1
);
my $field_name_ur = unreserve( $field_name, $table_name );
- my $field_str = $field_name_ur;
-
- # data type and size
- push @fdata, sprintf "%s%s",
- $field->{'data_type'},
- ( defined $field->{'size'} )
- ? "($field->{'size'})" : '';
+ my $field_def = qq["$field_name_ur"];
+
+ #
+ # Datatype
+ #
+ my @size = $field->size;
+ my $data_type = lc $field->data_type;
+ my %extra = $field->extra;
+ my $list = $extra{'list'} || [];
+ # todo deal with embedded quotes
+ my $commalist = join( ', ', map { qq['$_'] } @$list );
+ my $seq_name;
+
+ if ( $data_type eq 'enum' ) {
+ my $len = 0;
+ $len = ($len < length($_)) ? length($_) : $len for (@$list);
+ my $chk_name = mk_name( $table_name.'_'.$field_name, 'chk' );
+ push @constraint_defs,
+ qq[Constraint "$chk_name" CHECK ("$field_name" ].
+ qq[IN ($commalist))];
+ $data_type = 'character varying';
+ }
+ elsif ( $data_type eq 'set' ) {
+ $data_type = 'character varying';
+ }
+ elsif ( $field->is_auto_increment ) {
+ if ( defined $size[0] && $size[0] > 11 ) {
+ $data_type = 'bigserial';
+ }
+ else {
+ $data_type = 'serial';
+ }
+ undef @size;
+ }
+ else {
+ $data_type = defined $translate{ $data_type } ?
+ $translate{ $data_type } :
+ $data_type;
+ }
- # Null?
- push @fdata, "NOT NULL" unless $field->{'null'};
+ if ( $data_type =~ /timestamp/i ) {
+ if ( defined $size[0] && $size[0] > 6 ) {
+ $size[0] = 6;
+ }
+ }
- # Default? XXX Need better quoting!
- my $default = $field->{'default'};
- if ( defined $default ) {
- push @fdata, "DEFAULT '$default'";
-# if (int $default eq "$default") {
-# push @fdata, "DEFAULT $default";
-# } else {
-# push @fdata, "DEFAULT '$default'";
-# }
+ if ( $data_type eq 'integer' ) {
+ if ( defined $size[0] ) {
+ if ( $size[0] > 10 ) {
+ $data_type = 'bigint';
+ }
+ elsif ( $size[0] < 5 ) {
+ $data_type = 'smallint';
+ }
+ else {
+ $data_type = 'integer';
+ }
+ }
+ else {
+ $data_type = 'integer';
+ }
}
- # auto_increment?
- push @fdata, "auto_increment" if $field->{'is_auto_inc'};
+ #
+ # PG doesn't need a size for integers or text
+ #
+ undef @size if $data_type =~ m/(integer|smallint|bigint|text)/;
+
+ $field_def .= " $data_type";
+
+ if ( defined $size[0] && $size[0] > 0 ) {
+ $field_def .= '(' . join( ',', @size ) . ')';
+ }
- # primary key?
- push @fdata, "PRIMARY KEY" if $field->{'is_primary_key'};
+ #
+ # Default value -- disallow for timestamps
+ #
+ my $default = $data_type =~ /(timestamp|date)/i
+ ? undef : $field->default_value;
+ if ( defined $default ) {
+ $field_def .= sprintf( ' DEFAULT %s',
+ ( $field->is_auto_increment && $seq_name )
+ ? qq[nextval('"$seq_name"'::text)] :
+ ( $default =~ m/null/i ) ? 'NULL' : "'$default'"
+ );
+ }
- push @field_statements, join( " ", @fdata );
+ #
+ # Not null constraint
+ #
+ $field_def .= ' NOT NULL' unless $field->is_nullable;
+ push @field_defs, $field_def;
}
- $create .= join( ",\n", @field_statements );
#
- # Other keys
+ # Index Declarations
#
- my @indices = @{ $table->{'indices'} || [] };
- for ( my $i = 0; $i <= $#indices; $i++ ) {
- $create .= ",\n";
- my $key = $indices[$i];
- my ( $name, $type, $fields ) = @{ $key }{ qw( name type fields ) };
- if ( $type eq 'primary_key' ) {
- $create .= " PRIMARY KEY (@{$fields})"
- }
+ my @index_defs = ();
+ my $idx_name_default;
+ for my $index ( $table->get_indices ) {
+ my $name = $index->name || '';
+ if ( $name ) {
+ $name = next_unused_name($name, \%used_index_names);
+ $used_index_names{$name} = $name;
+ }
+
+ my $type = $index->type || NORMAL;
+ my @fields =
+ map { $_ =~ s/\(.+\)//; $_ }
+ map { unreserve( $_, $table_name ) }
+ $index->fields;
+ next unless @fields;
+
+ my $def_start = qq[Constraint "$name" ];
+ if ( $type eq PRIMARY_KEY ) {
+ push @constraint_defs, "${def_start}PRIMARY KEY ".
+ '("' . join( '", "', @fields ) . '")';
+ }
+ elsif ( $type eq UNIQUE ) {
+ push @constraint_defs, "${def_start}UNIQUE " .
+ '("' . join( '", "', @fields ) . '")';
+ }
+ elsif ( $type eq NORMAL ) {
+ push @index_defs,
+ 'CREATE INDEX "' . $name . "\" on $table_name_ur (".
+ join( ', ', map { qq["$_"] } @fields ).
+ ');'
+ ;
+ }
else {
- local $" = ", ";
- $create .= " KEY $name (@{$fields})"
+ warn "Unknown index type ($type) on table $table_name.\n"
+ if $WARN;
}
}
#
- # Footer
+ # Table constraints
#
- $create .= "\n);\n\n";
+ my $c_name_default;
+ for my $c ( $table->get_constraints ) {
+ my $name = $c->name || '';
+ if ( $name ) {
+ $name = next_unused_name($name, \%used_index_names);
+ $used_index_names{$name} = $name;
+ }
+
+ my @fields =
+ map { $_ =~ s/\(.+\)//; $_ }
+ map { unreserve( $_, $table_name ) }
+ $c->fields;
+
+ my @rfields =
+ map { $_ =~ s/\(.+\)//; $_ }
+ map { unreserve( $_, $table_name ) }
+ $c->reference_fields;
+
+ next if !@fields && $c->type ne CHECK_C;
+
+ my $def_start = $name ? qq[Constraint "$name" ] : '';
+ if ( $c->type eq PRIMARY_KEY ) {
+ push @constraint_defs, "${def_start}PRIMARY KEY ".
+ '("' . join( '", "', @fields ) . '")';
+ }
+ elsif ( $c->type eq UNIQUE ) {
+ $name = next_unused_name($name, \%used_index_names);
+ $used_index_names{$name} = $name;
+ push @constraint_defs, "${def_start}UNIQUE " .
+ '("' . join( '", "', @fields ) . '")';
+ }
+ elsif ( $c->type eq CHECK_C ) {
+ my $expression = $c->expression;
+ push @constraint_defs, "${def_start}CHECK ($expression)";
+ }
+ elsif ( $c->type eq FOREIGN_KEY ) {
+ my $def .= "ALTER TABLE $table_name ADD FOREIGN KEY (" .
+ join( ', ', map { qq["$_"] } @fields ) . ')' .
+ "\n REFERENCES " . $c->reference_table;
+
+ if ( @rfields ) {
+ $def .= ' ("' . join( '", "', @rfields ) . '")';
+ }
+
+ if ( $c->match_type ) {
+ $def .= ' MATCH ' .
+ ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
+ }
+
+ if ( $c->on_delete ) {
+ $def .= ' ON DELETE '.join( ' ', $c->on_delete );
+ }
+
+ if ( $c->on_update ) {
+ $def .= ' ON UPDATE '.join( ' ', $c->on_update );
+ }
+
+ push @fks, "$def;";
+ }
+ }
+
+ my $create_statement;
+ $create_statement = qq[DROP TABLE "$table_name_ur";\n]
+ if $add_drop_table;
+ $create_statement .= qq[CREATE TABLE "$table_name_ur" (\n].
+ join( ",\n", map { " $_" } @field_defs, @constraint_defs ).
+ "\n);"
+ ;
+
+ $output .= join( "\n\n",
+ @comments,
+ @sequence_defs,
+ $create_statement,
+ @index_defs,
+ ''
+ );
+ }
+
+ if ( @fks ) {
+ $output .= "--\n-- Foreign Key Definitions\n--\n\n" unless $no_comments;
+ $output .= join( "\n\n", @fks );
}
- return $create;
+ if ( $WARN ) {
+ if ( %truncated ) {
+ warn "Truncated " . keys( %truncated ) . " names:\n";
+ warn "\t" . join( "\n\t", sort keys %truncated ) . "\n";
+ }
+
+ if ( %unreserve ) {
+ warn "Encounted " . keys( %unreserve ) .
+ " unsafe names in schema (reserved or invalid):\n";
+ warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n";
+ }
+ }
+
+ return $output;
}
# -------------------------------------------------------------------
sub mk_name {
- my ($basename, $type, $scope, $critical) = @_;
+ my $basename = shift || '';
+ my $type = shift || '';
+ my $scope = shift || '';
+ my $critical = shift || '';
my $basename_orig = $basename;
- my $max_name = $max_id_length - (length($type) + 1);
+ my $max_name = $type
+ ? $max_id_length - (length($type) + 1)
+ : $max_id_length;
$basename = substr( $basename, 0, $max_name )
if length( $basename ) > $max_name;
my $name = $type ? "${type}_$basename" : $basename;
# -------------------------------------------------------------------
sub unreserve {
- my ( $name, $schema_obj_name ) = @_;
+ my $name = shift || '';
+ my $schema_obj_name = shift || '';
+
my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
# also trap fields that don't begin with a letter
- return $_[0] if !$reserved{ uc $name } && $name =~ /^[a-z]/i;
+ return $name if !$reserved{ uc $name } && $name =~ /^[a-z]/i;
if ( $schema_obj_name ) {
++$unreserve{"$schema_obj_name.$name"};
return $unreserve.$suffix;
}
+# -------------------------------------------------------------------
+sub next_unused_name {
+ my $name = shift || '';
+ my $used_names = shift || '';
+
+ my %used_names = %$used_names;
+
+ if ( !defined($used_names{$name}) ) {
+ $used_names{$name} = $name;
+ return $name;
+ }
+
+ my $i = 2;
+ while ( defined($used_names{$name . $i}) ) {
+ ++$i;
+ }
+ $name .= $i;
+ $used_names{$name} = $name;
+ return $name;
+}
+
1;
# -------------------------------------------------------------------
=pod
+=head1 SEE ALSO
+
+SQL::Translator, SQL::Translator::Producer::Oracle.
+
=head1 AUTHOR
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
=cut