Creates a DDL suitable for PostgreSQL. Very heavily based on the Oracle
producer.
+Now handles PostGIS Geometry and Geography data types on table definitions.
+Does not yet support PostGIS Views.
+
=cut
use strict;
use base qw(SQL::Translator::Producer);
use SQL::Translator::Schema::Constants;
-use SQL::Translator::Utils qw(debug header_comment);
+use SQL::Translator::Utils qw(debug header_comment parse_dbms_version);
use Data::Dumper;
my ( %translate, %index_name );
# my $max_id_length = 62;
my %used_identifiers = ();
my %global_names;
-my %unreserve;
my %truncated;
=pod
my $add_drop_table = $translator->add_drop_table;
my $schema = $translator->schema;
my $pargs = $translator->producer_args;
- my $postgres_version = $pargs->{postgres_version} || 0;
+ my $postgres_version = parse_dbms_version(
+ $pargs->{postgres_version}, 'perl'
+ );
my $qt = $translator->quote_table_names ? q{"} : q{};
my $qf = $translator->quote_field_names ? q{"} : q{};
push @output, header_comment unless ($no_comments);
my (@table_defs, @fks);
+ my %type_defs;
for my $table ( $schema->get_tables ) {
my ($table_def, $fks) = create_table($table, {
no_comments => $no_comments,
postgres_version => $postgres_version,
add_drop_table => $add_drop_table,
+ type_defs => \%type_defs,
});
push @table_defs, $table_def;
});
}
+ push @output, map { "$_;\n\n" } values %type_defs;
push @output, map { "$_;\n\n" } @table_defs;
if ( @fks ) {
push @output, "--\n-- Foreign Key Definitions\n--\n\n" unless $no_comments;
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 wantarray
}
# -------------------------------------------------------------------
-sub unreserve {
- 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 $name if (!$reserved{ uc $name }) && $name =~ /^[a-z]/i;
-
- if ( $schema_obj_name ) {
- ++$unreserve{"$schema_obj_name.$name"};
- }
- else {
- ++$unreserve{"$name (table name)"};
- }
-
- my $unreserve = sprintf '%s_', $name;
- return $unreserve.$suffix;
-}
-
-# -------------------------------------------------------------------
sub next_unused_name {
my $orig_name = shift or return;
my $name = $orig_name;
return $name;
}
+sub is_geometry
+{
+ my $field = shift;
+ return 1 if $field->data_type eq 'geometry';
+}
+
+sub is_geography
+{
+ my $field = shift;
+ return 1 if $field->data_type eq 'geography';
+}
+
sub create_table
{
my ($table, $options) = @_;
my $no_comments = $options->{no_comments} || 0;
my $add_drop_table = $options->{add_drop_table} || 0;
my $postgres_version = $options->{postgres_version} || 0;
+ my $type_defs = $options->{type_defs} || {};
my $table_name = $table->name or next;
my ( $fql_tbl_name ) = ( $table_name =~ s/\W(.*)$// ) ? $1 : q{};
my $table_name_ur = $qt ? $table_name
- : $fql_tbl_name ? join('.', $table_name, unreserve($fql_tbl_name))
- : unreserve($table_name);
+ : $fql_tbl_name ? join('.', $table_name, $fql_tbl_name)
+ : $table_name;
$table->name($table_name_ur);
# print STDERR "$table_name table_name\n";
- my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @type_defs, @type_drops, @fks );
+ my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @fks );
push @comments, "--\n-- Table: $table_name_ur\n--\n" unless $no_comments;
quote_field_names => $qf,
table_name => $table_name_ur,
postgres_version => $postgres_version,
- type_defs => \@type_defs,
- type_drops => \@type_drops,
+ type_defs => $type_defs,
constraint_defs => \@constraint_defs,});
}
my $create_statement;
$create_statement = join("\n", @comments);
if ($add_drop_table) {
- if ($postgres_version >= 8.2) {
+ if ($postgres_version >= 8.002) {
$create_statement .= qq[DROP TABLE IF EXISTS $qt$table_name_ur$qt CASCADE;\n];
- $create_statement .= join (";\n", @type_drops) . ";\n"
- if $postgres_version >= 8.3 && scalar @type_drops;
} else {
$create_statement .= qq[DROP TABLE $qt$table_name_ur$qt CASCADE;\n];
}
}
- $create_statement .= join(";\n", @type_defs) . ";\n"
- if $postgres_version >= 8.3 && scalar @type_defs;
$create_statement .= qq[CREATE ${temporary}TABLE $qt$table_name_ur$qt (\n].
join( ",\n", map { " $_" } @field_defs, @constraint_defs ).
"\n)"
$create_statement .= ( $create_statement =~ /;$/ ? "\n" : q{} )
. join(";\n", @index_defs);
+ #
+ # Geometry
+ #
+ if(grep { is_geometry($_) } $table->get_fields){
+ $create_statement .= ";";
+ my @geometry_columns;
+ foreach my $col ($table->get_fields) { push(@geometry_columns,$col) if is_geometry($col); }
+ $create_statement .= "\n".join("\n", map{ drop_geometry_column($_) } @geometry_columns) if $options->{add_drop_table};
+ $create_statement .= "\n".join("\n", map{ add_geometry_column($_) } @geometry_columns);
+ }
+
return $create_statement, \@fks;
}
my $table_name = $field->table->name;
my $constraint_defs = $options->{constraint_defs} || [];
my $postgres_version = $options->{postgres_version} || 0;
- my $type_defs = $options->{type_defs} || [];
- my $type_drops = $options->{type_drops} || [];
+ my $type_defs = $options->{type_defs} || {};
$field_name_scope{$table_name} ||= {};
my $field_name = $field->name;
- 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];
+ my $field_def = $field_comments.qq[$qf$field_name$qf];
#
# Datatype
# todo deal with embedded quotes
my $commalist = join( ', ', map { qq['$_'] } @$list );
- if ($postgres_version >= 8.3 && $field->data_type eq 'enum') {
- my $type_name = $field->table->name . '_' . $field->name . '_type';
+ if ($postgres_version >= 8.003 && $field->data_type eq 'enum') {
+ my $type_name = $extra{'custom_type_name'} || $field->table->name . '_' . $field->name . '_type';
$field_def .= ' '. $type_name;
- push @$type_defs, "CREATE TYPE $type_name AS ENUM ($commalist)";
- push @$type_drops, "DROP TYPE IF EXISTS $type_name";
+ my $new_type_def = "DROP TYPE IF EXISTS $type_name CASCADE;\n" .
+ "CREATE TYPE $type_name AS ENUM ($commalist)";
+ if (! exists $type_defs->{$type_name} ) {
+ $type_defs->{$type_name} = $new_type_def;
+ } elsif ( $type_defs->{$type_name} ne $new_type_def ) {
+ die "Attempted to redefine type name '$type_name' as a different type.\n";
+ }
} else {
$field_def .= ' '. convert_datatype($field);
}
#
# Default value
#
- my $default = $field->default_value;
- if ( defined $default ) {
- SQL::Translator::Producer->_apply_default_value(
- \$field_def,
- $default,
- [
- 'NULL' => \'NULL',
- 'now()' => 'now()',
- 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
- ],
- );
- }
+ SQL::Translator::Producer->_apply_default_value(
+ $field,
+ \$field_def,
+ [
+ 'NULL' => \'NULL',
+ 'now()' => 'now()',
+ 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
+ ],
+ );
#
# Not null constraint
#
$field_def .= ' NOT NULL' unless $field->is_nullable;
+ #
+ # Geometry constraints
+ #
+ if(is_geometry($field)){
+ foreach ( create_geometry_constraints($field) ) {
+ my ($cdefs, $fks) = create_constraint($_,
+ {
+ quote_field_names => $qf,
+ quote_table_names => $qt,
+ table_name => $table_name,
+ });
+ push @$constraint_defs, @$cdefs;
+ push @$fks, @$fks;
+ }
+ }
+
return $field_def;
}
}
+sub create_geometry_constraints{
+ my $field = shift;
+
+ my @constraints;
+ push @constraints, SQL::Translator::Schema::Constraint->new(
+ name => "enforce_dims_".$field->name,
+ expression => "(ST_NDims($field) = ".$field->{extra}{dimensions}.")",
+ table => $field->table,
+ type => CHECK_C,
+ );
+
+ push @constraints, SQL::Translator::Schema::Constraint->new(
+ name => "enforce_srid_".$field->name,
+ expression => "(ST_SRID($field) = ".$field->{extra}{srid}.")",
+ table => $field->table,
+ type => CHECK_C,
+ );
+ push @constraints, SQL::Translator::Schema::Constraint->new(
+ name => "enforce_geotype_".$field->name,
+ expression => "(GeometryType($field) = '".$field->{extra}{geometry_type}."'::text OR $field IS NULL)",
+ table => $field->table,
+ type => CHECK_C,
+ );
+
+ return @constraints;
+}
+
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);
);
my $type = $index->type || NORMAL;
- my @fields =
- map { $_ =~ s/\(.+\)//; $_ }
- map { $qt ? $_ : unreserve($_, $table_name ) }
- $index->fields;
+ my @fields = $index->fields;
next unless @fields;
- my $def_start = qq[CONSTRAINT "$name" ];
+ my $def_start = qq[CONSTRAINT ${qf}$name${qf} ];
+ my $field_names = '(' . join(", ", (map { $_ =~ /\(.*\)/ ? $_ : ($qf . $_ . $qf ) } @fields)) . ')';
if ( $type eq PRIMARY_KEY ) {
- push @constraint_defs, "${def_start}PRIMARY KEY ".
- '(' .$qf . join( $qf. ', '.$qf, @fields ) . $qf . ')';
+ push @constraint_defs, "${def_start}PRIMARY KEY ".$field_names;
}
elsif ( $type eq UNIQUE ) {
- push @constraint_defs, "${def_start}UNIQUE " .
- '(' . $qf . join( $qf. ', '.$qf, @fields ) . $qf.')';
+ push @constraint_defs, "${def_start}UNIQUE " .$field_names;
}
elsif ( $type eq NORMAL ) {
$index_def =
- "CREATE INDEX ${qf}${name}${qf} on ${qt}${table_name}${qt} (".
- join( ', ', map { qq[$qf$_$qf] } @fields ).
- ')'
+ "CREATE INDEX ${qf}${name}${qf} on ${qt}${table_name}${qt} ".$field_names
;
}
else {
$name = next_unused_name($name);
}
- my @fields =
- map { $_ =~ s/\(.+\)//; $_ }
- map { $qt ? $_ : unreserve( $_, $table_name )}
- $c->fields;
+ my @fields = grep { defined } $c->fields;
- my @rfields =
- map { $_ =~ s/\(.+\)//; $_ }
- map { $qt ? $_ : unreserve( $_, $table_name )}
- $c->reference_fields;
+ my @rfields = grep { defined } $c->reference_fields;
next if !@fields && $c->type ne CHECK_C;
- my $def_start = $name ? qq[CONSTRAINT "$name" ] : '';
+ my $def_start = $name ? qq[CONSTRAINT ${qf}$name${qf} ] : '';
+ my $field_names = '(' . join(", ", (map { $_ =~ /\(.*\)/ ? $_ : ($qf . $_ . $qf ) } @fields)) . ')';
if ( $c->type eq PRIMARY_KEY ) {
- push @constraint_defs, "${def_start}PRIMARY KEY ".
- '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
+ push @constraint_defs, "${def_start}PRIMARY KEY ".$field_names;
}
elsif ( $c->type eq UNIQUE ) {
- $name = next_unused_name($name);
- push @constraint_defs, "${def_start}UNIQUE " .
- '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
+ push @constraint_defs, "${def_start}UNIQUE " .$field_names;
}
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 ) . ')' .
+ my $def .= "ALTER TABLE ${qt}${table_name}${qt} ADD FOREIGN KEY " . $field_names .
"\n REFERENCES " . $qt . $c->reference_table . $qt;
if ( @rfields ) {
my @size = $field->size;
my $data_type = lc $field->data_type;
+ my $array = $data_type =~ s/\[\]$//;
if ( $data_type eq 'enum' ) {
# my $len = 0;
my $type_with_size = join('|',
'bit', 'varbit', 'character', 'bit varying', 'character varying',
- 'time', 'timestamp', 'interval'
+ 'time', 'timestamp', 'interval', 'numeric'
);
if ( $data_type !~ /$type_with_size/ ) {
} elsif ( defined $size[0] && $size[0] > 0 ) {
$data_type .= '(' . join( ',', @size ) . ')';
}
+ if($array)
+ {
+ $data_type .= '[]';
+ }
+
+ #
+ # Geography
+ #
+ if($data_type eq 'geography'){
+ $data_type .= '('.$field->{extra}{geography_type}.','. $field->{extra}{srid} .')'
+ }
return $data_type;
}
if($from_field->table->name ne $to_field->table->name);
my @out;
+
+ # drop geometry column and constraints
+ push @out, drop_geometry_column($from_field) if is_geometry($from_field);
+ push @out, drop_geometry_constraints($from_field) if is_geometry($from_field);
+
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
$to_field->name)
if ( !defined $new_default && defined $old_default );
-
+ # add geometry column and contraints
+ push @out, add_geometry_column($to_field) if is_geometry($to_field);
+ push @out, add_geometry_constraints($to_field) if is_geometry($to_field);
+
return wantarray ? @out : join("\n", @out);
}
my $out = sprintf('ALTER TABLE %s ADD COLUMN %s',
$new_field->table->name,
create_field($new_field));
+ $out .= "\n".add_geometry_column($new_field) if is_geometry($new_field);
+ $out .= "\n".add_geometry_constraints($new_field) if is_geometry($new_field);
return $out;
}
my $out = sprintf('ALTER TABLE %s DROP COLUMN %s',
$old_field->table->name,
$old_field->name);
-
+ $out .= "\n".drop_geometry_column($old_field) if is_geometry($old_field);
return $out;
}
+sub add_geometry_column{
+ my ($field,$options) = @_;
+
+ my $out = sprintf("INSERT INTO geometry_columns VALUES ('%s','%s','%s','%s','%s','%s','%s')",
+ '',
+ $field->table->schema->name,
+ $options->{table} ? $options->{table} : $field->table->name,
+ $field->name,
+ $field->{extra}{dimensions},
+ $field->{extra}{srid},
+ $field->{extra}{geometry_type});
+ return $out;
+}
+
+sub drop_geometry_column
+{
+ my $field = shift;
+
+ my $out = sprintf("DELETE FROM geometry_columns WHERE f_table_schema = '%s' AND f_table_name = '%s' AND f_geometry_column = '%s'",
+ $field->table->schema->name,
+ $field->table->name,
+ $field->name);
+ return $out;
+}
+
+sub add_geometry_constraints{
+ my $field = shift;
+
+ my @constraints = create_geometry_constraints($field);
+
+ my $out = join("\n", map { alter_create_constraint($_); } @constraints);
+
+ return $out;
+}
+
+sub drop_geometry_constraints{
+ my $field = shift;
+
+ my @constraints = create_geometry_constraints($field);
+
+ my $out = join("\n", map { alter_drop_constraint($_); } @constraints);
+
+ return $out;
+}
+
sub alter_table {
my ($to_table, $options) = @_;
my $qt = $options->{quote_table_names} || '';
my $out = sprintf('ALTER TABLE %s %s',
$qt . $to_table->name . $qt,
$options->{alter_table_action});
+ $out .= "\n".$options->{geometry_changes} if $options->{geometry_changes};
return $out;
}
my ($old_table, $new_table, $options) = @_;
my $qt = $options->{quote_table_names} || '';
$options->{alter_table_action} = "RENAME TO $qt$new_table$qt";
+
+ my @geometry_changes;
+ push @geometry_changes, map { drop_geometry_column($_); } grep { is_geometry($_) } $old_table->get_fields;
+ push @geometry_changes, map { add_geometry_column($_, { table => $new_table }); } grep { is_geometry($_) } $old_table->get_fields;
+
+ $options->{geometry_changes} = join ("\n",@geometry_changes) if scalar(@geometry_changes);
+
return alter_table($old_table, $options);
}
sub drop_table {
my ($table, $options) = @_;
my $qt = $options->{quote_table_names} || '';
- return "DROP TABLE $qt$table$qt CASCADE";
+ my $out = "DROP TABLE $qt$table$qt CASCADE";
+
+ my @geometry_drops = map { drop_geometry_column($_); } grep { is_geometry($_) } $table->get_fields;
+
+ $out .= "\n".join("\n",@geometry_drops) if scalar(@geometry_drops);
+ return $out;
}
1;