package SQL::Translator::Producer::PostgreSQL;
# -------------------------------------------------------------------
-# $Id: PostgreSQL.pm,v 1.8 2003-04-25 11:47:25 dlc Exp $
+# $Id: PostgreSQL.pm,v 1.25 2006-08-04 21:38:20 schiffbruechige Exp $
# -------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>,
-# Chris Mungall <cjm@fruitfly.org>
+# Copyright (C) 2002-4 SQLFairy Authors
#
# 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 warnings;
use vars qw[ $DEBUG $WARN $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.25 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 1 unless defined $DEBUG;
+use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(header_comment);
use Data::Dumper;
-my %translate = (
+my %translate;
+my $max_id_length;
+
+BEGIN {
+
+ %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',
+ char => 'character',
varchar => 'character varying',
longtext => 'text',
mediumtext => 'text',
# Oracle types
#
number => 'integer',
- char => 'char',
+ char => 'character',
varchar2 => 'character varying',
long => 'text',
CLOB => 'bytea',
varchar => 'character varying',
datetime => 'timestamp',
text => 'text',
- real => 'double precision',
+ real => 'numeric',
comment => 'text',
bit => 'bit',
tinyint => 'smallint',
- float => 'double precision',
+ float => 'numeric',
);
+ $max_id_length = 62;
+}
my %reserved = map { $_, 1 } qw[
ALL ANALYSE ANALYZE AND ANY AS ASC
BETWEEN BINARY BOTH
UNION UNIQUE USER USING VERBOSE WHEN WHERE
];
-my $max_id_length = 30;
+# my $max_id_length = 62;
my %used_identifiers = ();
my %global_names;
my %unreserve;
# -------------------------------------------------------------------
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 $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 $qt = '';
+ $qt = '"' if ($translator->quote_table_names);
+ my $qf = '';
+ $qf = '"' if ($translator->quote_field_names);
+
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'};
- $table_name = mk_name( $table_name, '', undef, 1 );
- my $table_name_ur = unreserve($table_name);
-
- my ( @comments, @field_decs, @sequence_decs, @constraints );
-
- push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;
-
- #
- # Fields
- #
- my %field_name_scope;
- for my $field (
- map { $_->[1] }
- sort { $a->[0] <=> $b->[0] }
- map { [ $_->{'order'}, $_ ] }
- values %{ $table->{'fields'} }
- ) {
- my $field_name = mk_name(
- $field->{'name'}, '', \%field_name_scope, 1
- );
- my $field_name_ur = unreserve( $field_name, $table_name );
- my $field_str = qq["$field_name_ur"];
-
- #
- # Datatype
- #
- my $data_type = lc $field->{'data_type'};
- my $list = $field->{'list'} || [];
- my $commalist = join ",", @$list;
- my $seq_name;
-
- if ( $data_type eq 'enum' ) {
- my $len = 0;
- $len = ($len < length($_)) ? length($_) : $len for (@$list);
- my $check_name = mk_name( $table_name.'_'.$field_name, 'chk' );
- push @constraints,
- "CONSTRAINT $check_name CHECK ($field_name IN ($commalist))";
- $field_str .= " character varying($len)";
- }
- elsif ( $data_type eq 'set' ) {
- # XXX add a CHECK constraint maybe
- # (trickier and slower, than enum :)
- my $len = length $commalist;
- $field_str .= " character varying($len) /* set $commalist */";
- }
- elsif ( $field->{'is_auto_inc'} ) {
- $field_str .= ' serial';
- $seq_name = mk_name( $table_name.'_'.$field_name, 'sq' );
- push @sequence_decs, qq[DROP SEQUENCE "$seq_name";];
- push @sequence_decs, qq[CREATE SEQUENCE "$seq_name";];
- }
- else {
- $data_type = defined $translate{ $data_type } ?
- $translate{ $data_type } :
- die "Unknown datatype: $data_type\n";
- $field_str .= ' '.$data_type;
- if ( $data_type =~ /(char|varbit|numeric|decimal)/i ) {
- $field_str .= '('.join(',', @{ $field->{'size'} }).')'
- if @{ $field->{'size'} || [] };
- }
- }
-
- #
- # Default value
- #
- if ( defined $field->{'default'} ) {
- $field_str .= sprintf( ' DEFAULT %s',
- ( $field->{'is_auto_inc'} && $seq_name )
- ? qq[nextval('"$seq_name"'::text)] :
- ( $field->{'default'} =~ m/null/i )
- ? 'NULL' :
- "'".$field->{'default'}."'"
- );
- }
-
- #
- # Not null constraint
- #
- unless ( $field->{'null'} ) {
- my $constraint_name = mk_name($field_name_ur, 'nn');
-# $field_str .= ' CONSTRAINT '.$constraint_name.' NOT NULL';
- $field_str .= ' NOT NULL';
- }
+ my (@table_defs, @fks);
+ for my $table ( $schema->get_tables ) {
- #
- # Primary key
- #
-# if ( $field->{'is_primary_key'} ) {
-# my $constraint_name = mk_name($field_name_ur, 'pk');
-# $field_str .= ' CONSTRAINT '.$constraint_name.' PRIMARY KEY';
-# }
+ my ($table_def, $fks) = create_table($table,
+ { quote_table_names => $qt,
+ quote_field_names => $qf,
+ no_comments => $no_comments,
+ add_drop_table => $add_drop_table,});
+ push @table_defs, $table_def;
+ push @fks, @$fks;
- push @field_decs, $field_str;
- }
-
- #
- # Index Declarations
- #
- my @index_decs = ();
- my $idx_name_default;
- for my $index ( @{ $table->{'indices'} } ) {
- my $index_name = $index->{'name'} || '';
- my $index_type = $index->{'type'} || 'normal';
- my @fields =
- map { $_ =~ s/\(.+\)//; $_ }
- map { unreserve( $_, $table_name ) }
- @{ $index->{'fields'} };
- next unless @fields;
-
- if ( $index_type eq 'primary_key' ) {
- $index_name = mk_name( $table_name, 'pk' );
- push @constraints, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
- '(' . join( ', ', @fields ) . ')';
- }
- elsif ( $index_type eq 'unique' ) {
- $index_name = mk_name(
- $table_name, $index_name || ++$idx_name_default
- );
- push @constraints, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
- '(' . join( ', ', @fields ) . ')';
- }
- elsif ( $index_type eq 'normal' ) {
- $index_name = mk_name(
- $table_name, $index_name || ++$idx_name_default
- );
- push @index_decs,
- qq[CREATE INDEX "$index_name" on $table_name_ur (].
- join( ', ', @fields ).
- ');';
- }
- else {
- warn "Unknown index type ($index_type) on table $table_name.\n"
- if $WARN;
- }
- }
+ }
- 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_decs, @constraints ).
- "\n);"
- ;
-
- $output .= join( "\n\n",
- @comments,
- @sequence_decs,
- $create_statement,
- @index_decs,
- ''
- );
+ $output = join("\n\n", @table_defs);
+ if ( @fks ) {
+ $output .= "--\n-- Foreign Key Definitions\n--\n\n" unless $no_comments;
+ $output .= join( "\n\n", @fks );
}
if ( $WARN ) {
# -------------------------------------------------------------------
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_id_length = 62;
my $max_name = $type
? $max_id_length - (length($type) + 1)
: $max_id_length;
# -------------------------------------------------------------------
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;
+}
+
+sub create_table
+{
+ my ($table, $options) = @_;
+
+ my $qt = $options->{quote_table_names} || '';
+ my $qf = $options->{quote_field_names} || '';
+ my $no_comments = $options->{no_comments} || 0;
+ my $add_drop_table = $options->{add_drop_table} || 0;
+
+ my $table_name = $table->name or next;
+ $table_name = mk_name( $table_name, '', undef, 1 );
+ my $table_name_ur = $qt ? $table_name : unreserve($table_name);
+ $table->name($table_name_ur);
+
+# print STDERR "$table_name table_name\n";
+ my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @fks );
+
+ push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;
+
+ if ( $table->comments and !$no_comments ){
+ my $c = "-- Comments: \n-- ";
+ $c .= join "\n-- ", $table->comments;
+ $c .= "\n--";
+ push @comments, $c;
+ }
+
+ #
+ # Fields
+ #
+ my %field_name_scope;
+ for my $field ( $table->get_fields ) {
+ push @field_defs, create_field($field, { quote_table_names => $qt,
+ quote_field_names => $qf,
+ table_name => $table_name_ur,
+ constraint_defs => \@constraint_defs,});
+ }
+
+ #
+ # Index Declarations
+ #
+ my @index_defs = ();
+ # my $idx_name_default;
+ for my $index ( $table->get_indices ) {
+ my ($idef, $constraints) = create_index($index,
+ {
+ quote_field_names => $qf,
+ quote_table_names => $qt,
+ table_name => $table_name,
+ });
+ push @index_defs, $idef;
+ push @constraint_defs, @$constraints;
+ }
+
+ #
+ # Table constraints
+ #
+ my $c_name_default;
+ for my $c ( $table->get_constraints ) {
+ my ($cdefs, $fks) = create_constraint($c,
+ {
+ quote_field_names => $qf,
+ quote_table_names => $qt,
+ table_name => $table_name,
+ });
+ push @constraint_defs, @$cdefs;
+ push @fks, @$fks;
+ }
+
+ my $create_statement;
+ $create_statement = join("\n", @comments);
+ $create_statement .= qq[DROP TABLE $qt$table_name_ur$qt;\n]
+ if $add_drop_table;
+ $create_statement .= qq[CREATE TABLE $qt$table_name_ur$qt (\n].
+ join( ",\n", map { " $_" } @field_defs, @constraint_defs ).
+ "\n);"
+ ;
+
+ $create_statement .= "\n" . join(";\n", @index_defs) . "\n";
+
+ return $create_statement, \@fks;
+}
+
+{
+
+ my %field_name_scope;
+
+ sub create_field
+ {
+ my ($field, $options) = @_;
+
+ my $qt = $options->{quote_table_names} || '';
+ my $qf = $options->{quote_field_names} || '';
+ my $table_name = $field->table->name;
+ my $constraint_defs = $options->{constraint_defs} || [];
+
+ $field_name_scope{$table_name} ||= {};
+ my $field_name = mk_name(
+ $field->name, '', $field_name_scope{$table_name}, 1
+ );
+ my $field_name_ur = $qf ? $field_name : unreserve($field_name, $table_name );
+ $field->name($field_name_ur);
+ my $field_comments = $field->comments
+ ? "-- " . $field->comments . "\n "
+ : '';
+
+ my $field_def = $field_comments.qq[$qf$field_name_ur$qf];
+
+ #
+ # 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;
+
+ $field_def .= ' '. convert_datatype($field);
+
+ #
+ # 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'"
+ );
+ }
+
+ #
+ # Not null constraint
+ #
+ $field_def .= ' NOT NULL' unless $field->is_nullable;
+
+ return $field_def;
+ }
+}
+
+{
+ my %used_index_names;
+
+ sub create_index
+ {
+ my ($index, $options) = @_;
+
+ my $qt = $options->{quote_table_names} ||'';
+ my $qf = $options->{quote_field_names} ||'';
+ my $table_name = $index->table->name;
+# my $table_name_ur = $qt ? unreserve($table_name) : $table_name;
+
+ my ($index_def, @constraint_defs);
+
+ $used_index_names{$table_name} ||= {};
+ my $name = $index->name || '';
+ if ( $name ) {
+ $name = next_unused_name($name, $used_index_names{$table_name});
+ $used_index_names{$name} = $name;
+ }
+
+ my $type = $index->type || NORMAL;
+ my @fields =
+ map { $_ =~ s/\(.+\)//; $_ }
+ map { $qt ? $_ : 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 ".
+ '(' .$qf . join( $qf. ', '.$qf, @fields ) . $qf . ')';
+ }
+ elsif ( $type eq UNIQUE ) {
+ push @constraint_defs, "${def_start}UNIQUE " .
+ '(' . $qf . join( $qf. ', '.$qf, @fields ) . $qf.')';
+ }
+ elsif ( $type eq NORMAL ) {
+ $index_def =
+ "CREATE INDEX ${qf}${name}${qf} on ${qt}${table_name}${qt} (".
+ join( ', ', map { qq[$qf$_$qf] } @fields ).
+ ');'
+ ;
+ }
+ else {
+ warn "Unknown index type ($type) on table $table_name.\n"
+ if $WARN;
+ }
+
+ return $index_def, \@constraint_defs;
+ }
+
+ sub create_constraint
+ {
+ my ($c, $options) = @_;
+
+ my $qf = $options->{quote_field_names} ||'';
+ my $qt = $options->{quote_table_names} ||'';
+ my $table_name = $c->table->name;
+ my (@constraint_defs, @fks);
+
+ my $name = $c->name || '';
+ if ( $name ) {
+ $name = next_unused_name($name, \%used_index_names);
+ $used_index_names{$name} = $name;
+ }
+
+ my @fields =
+ map { $_ =~ s/\(.+\)//; $_ }
+ map { $qt ? $_ : unreserve( $_, $table_name )}
+ $c->fields;
+
+ my @rfields =
+ map { $_ =~ s/\(.+\)//; $_ }
+ map { $qt ? $_ : 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 ".
+ '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
+ }
+ elsif ( $c->type eq UNIQUE ) {
+ $name = next_unused_name($name, \%used_index_names);
+ $used_index_names{$name} = $name;
+ push @constraint_defs, "${def_start}UNIQUE " .
+ '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
+ }
+ 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 ${qt}${table_name}${qt} ADD FOREIGN KEY (" .
+ join( ', ', map { qq[$qf$_$qf] } @fields ) . ')' .
+ "\n REFERENCES " . $qt . $c->reference_table . $qt;
+
+ if ( @rfields ) {
+ $def .= ' ('.$qf . join( $qf.', '.$qf, @rfields ) . $qf.')';
+ }
+
+ 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;";
+ }
+
+ return \@constraint_defs, \@fks;
+ }
+}
+
+sub convert_datatype
+{
+ my ($field) = @_;
+
+ my @size = $field->size;
+ my $data_type = lc $field->data_type;
+
+ 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 ($qf$field_name$qf ].
+# 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;
+ }
+
+ if ( $data_type =~ /timestamp/i ) {
+ if ( defined $size[0] && $size[0] > 6 ) {
+ $size[0] = 6;
+ }
+ }
+
+ if ( $data_type eq 'integer' ) {
+ if ( defined $size[0] && $size[0] > 0) {
+ if ( $size[0] > 10 ) {
+ $data_type = 'bigint';
+ }
+ elsif ( $size[0] < 5 ) {
+ $data_type = 'smallint';
+ }
+ else {
+ $data_type = 'integer';
+ }
+ }
+ else {
+ $data_type = 'integer';
+ }
+ }
+
+ #
+ # PG doesn't need a size for integers or text
+ #
+ undef @size if $data_type =~ m/(integer|smallint|bigint|text)/;
+
+ if ( defined $size[0] && $size[0] > 0 ) {
+ $data_type .= '(' . join( ',', @size ) . ')';
+ }
+ elsif (defined $size[0] && $data_type eq 'timestamp' ) {
+ $data_type .= '(' . join( ',', @size ) . ')';
+ }
+
+
+ return $data_type;
+}
+
+
+sub alter_field
+{
+ my ($from_field, $to_field) = @_;
+
+ die "Can't alter field in another table"
+ if($from_field->table->name ne $to_field->table->name);
+
+ my @out;
+ push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s SET NOT NULL;',
+ $to_field->table->name,
+ $to_field->name) if(!$to_field->is_nullable and
+ $from_field->is_nullable);
+
+ my $from_dt = convert_datatype($from_field);
+ my $to_dt = convert_datatype($to_field);
+ push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s TYPE %s;',
+ $to_field->table->name,
+ $to_field->name,
+ $to_dt) if($to_dt ne $from_dt);
+
+ push @out, sprintf('ALTER TABLE %s RENAME COLUMN %s TO %s;',
+ $to_field->table->name,
+ $from_field->name,
+ $to_field->name) if($from_field->name ne $to_field->name);
+
+ push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s SET DEFAULT %s;',
+ $to_field->table->name,
+ $to_field->name,
+ $to_field->default_value)
+ if(defined $to_field->default_value &&
+ $from_field->default_value ne $to_field->default_value);
+
+ return wantarray ? @out : join("\n", @out);
+
+}
+
+sub add_field
+{
+ my ($new_field) = @_;
+
+ my $out = sprintf('ALTER TABLE %s ADD COLUMN %s;',
+ $new_field->table->name,
+ create_field($new_field));
+ return $out;
+
+}
+
+sub drop_field
+{
+ my ($old_field) = @_;
+
+ my $out = sprintf('ALTER TABLE %s DROP COLUMN %s;',
+ $old_field->table->name,
+ $old_field->name);
+
+ return $out;
+}
+
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
projects / dbsrgits/SQL-Translator.git / blobdiff