package SQL::Translator::Producer::PostgreSQL;
-# -------------------------------------------------------------------
-# $Id: PostgreSQL.pm,v 1.22 2004-02-09 23:02:15 kycl4rk Exp $
-# -------------------------------------------------------------------
-# 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
-# published by the Free Software Foundation; version 2.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307 USA
-# -------------------------------------------------------------------
-
=head1 NAME
SQL::Translator::Producer::PostgreSQL - PostgreSQL producer for SQL::Translator
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 vars qw[ $DEBUG $WARN $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.22 $ =~ /(\d+)\.(\d+)/;
-$DEBUG = 1 unless defined $DEBUG;
+use warnings;
+our ( $DEBUG, $WARN );
+our $VERSION = '1.59';
+$DEBUG = 0 unless defined $DEBUG;
+use base qw(SQL::Translator::Producer);
use SQL::Translator::Schema::Constants;
-use SQL::Translator::Utils qw(header_comment);
+use SQL::Translator::Utils qw(debug header_comment parse_dbms_version batch_alter_table_statements);
+use SQL::Translator::Generator::DDL::PostgreSQL;
use Data::Dumper;
-my %translate = (
+my $generator = SQL::Translator::Generator::DDL::PostgreSQL->new;
+
+my ( %translate, %index_name );
+my $max_id_length;
+
+BEGIN {
+
+ %translate = (
#
# MySQL types
#
set => 'character varying',
date => 'date',
datetime => 'timestamp',
- time => 'date',
+ time => 'time',
timestamp => 'timestamp',
year => 'date',
float => 'numeric',
);
+ $max_id_length = 62;
+}
my %reserved = map { $_, 1 } qw[
- ALL ANALYSE ANALYZE AND ANY AS ASC
+ ALL ANALYSE ANALYZE AND ANY AS ASC
BETWEEN BINARY BOTH
CASE CAST CHECK COLLATE COLUMN CONSTRAINT CROSS
- CURRENT_DATE CURRENT_TIME CURRENT_TIMESTAMP CURRENT_USER
+ CURRENT_DATE CURRENT_TIME CURRENT_TIMESTAMP CURRENT_USER
DEFAULT DEFERRABLE DESC DISTINCT DO
ELSE END EXCEPT
- FALSE FOR FOREIGN FREEZE FROM FULL
- GROUP HAVING
- ILIKE IN INITIALLY INNER INTERSECT INTO IS ISNULL
- JOIN LEADING LEFT LIKE LIMIT
+ FALSE FOR FOREIGN FREEZE FROM FULL
+ GROUP HAVING
+ ILIKE IN INITIALLY INNER INTERSECT INTO IS ISNULL
+ JOIN LEADING LEFT LIKE LIMIT
NATURAL NEW NOT NOTNULL NULL
OFF OFFSET OLD ON ONLY OR ORDER OUTER OVERLAPS
- PRIMARY PUBLIC REFERENCES RIGHT
- SELECT SESSION_USER SOME TABLE THEN TO TRAILING TRUE
+ PRIMARY PUBLIC REFERENCES RIGHT
+ SELECT SESSION_USER SOME TABLE THEN TO TRAILING TRUE
UNION UNIQUE USER USING VERBOSE WHEN WHERE
];
-my $max_id_length = 62;
+# my $max_id_length = 62;
my %used_identifiers = ();
my %global_names;
-my %unreserve;
my %truncated;
=pod
=cut
-# -------------------------------------------------------------------
sub produce {
- 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;
-
- my @fks;
+ my $translator = shift;
+ local $DEBUG = $translator->debug;
+ local $WARN = $translator->show_warnings;
+ my $no_comments = $translator->no_comments;
+ my $add_drop_table = $translator->add_drop_table;
+ my $schema = $translator->schema;
+ my $pargs = $translator->producer_args;
+ 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{};
+ $generator->quote_chars([$qt]);
+
+ my @output;
+ push @output, header_comment unless ($no_comments);
+
+ my (@table_defs, @fks);
+ my %type_defs;
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;
- for my $field ( $table->get_fields ) {
- my $field_name = mk_name(
- $field->name, '', \%field_name_scope, 1
- );
- my $field_name_ur = unreserve( $field_name, $table_name );
- 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;
- }
-
- if ( $data_type =~ /timestamp/i ) {
- if ( defined $size[0] && $size[0] > 6 ) {
- $size[0] = 6;
- }
- }
-
- 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';
- }
- }
-
- #
- # 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 ) . ')';
- }
-
- #
- # 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;
-
- push @field_defs, $field_def;
- }
-
- #
- # Index Declarations
- #
- 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 {
- warn "Unknown index type ($type) on table $table_name.\n"
- if $WARN;
- }
- }
-
- #
- # Table constraints
- #
- 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 );
- }
+ my ($table_def, $fks) = create_table($table, {
+ quote_table_names => $qt,
+ quote_field_names => $qf,
+ no_comments => $no_comments,
+ postgres_version => $postgres_version,
+ add_drop_table => $add_drop_table,
+ type_defs => \%type_defs,
+ });
+
+ push @table_defs, $table_def;
+ push @fks, @$fks;
+ }
- push @fks, "$def;";
- }
- }
+ for my $view ( $schema->get_views ) {
+ push @table_defs, create_view($view, {
+ postgres_version => $postgres_version,
+ add_drop_view => $add_drop_table,
+ quote_table_names => $qt,
+ quote_field_names => $qf,
+ no_comments => $no_comments,
+ });
+ }
- 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,
- ''
- );
+ for my $trigger ( $schema->get_triggers ) {
+ push @table_defs, create_trigger( $trigger, {
+ add_drop_trigger => $add_drop_table,
+ no_comments => $no_comments,
+ });
}
+ push @output, map { "$_;\n\n" } values %type_defs;
+ push @output, map { "$_;\n\n" } @table_defs;
if ( @fks ) {
- $output .= "--\n-- Foreign Key Definitions\n--\n\n" unless $no_comments;
- $output .= join( "\n\n", @fks );
+ push @output, "--\n-- Foreign Key Definitions\n--\n\n" unless $no_comments;
+ push @output, map { "$_;\n\n" } @fks;
}
if ( $WARN ) {
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;
+ return wantarray
+ ? @output
+ : join ('', @output);
}
-# -------------------------------------------------------------------
sub mk_name {
- my $basename = shift || '';
- my $type = shift || '';
- my $scope = shift || '';
+ my $basename = shift || '';
+ my $type = shift || '';
+ my $scope = shift || '';
my $critical = shift || '';
my $basename_orig = $basename;
- my $max_name = $type
- ? $max_id_length - (length($type) + 1)
+# my $max_id_length = 62;
+ my $max_name = $type
+ ? $max_id_length - (length($type) + 1)
: $max_id_length;
- $basename = substr( $basename, 0, $max_name )
+ $basename = substr( $basename, 0, $max_name )
if length( $basename ) > $max_name;
my $name = $type ? "${type}_$basename" : $basename;
if ( my $prev = $scope->{ $name } ) {
my $name_orig = $name;
$name .= sprintf( "%02d", ++$prev );
- substr($name, $max_id_length - 3) = "00"
+ substr($name, $max_id_length - 3) = "00"
if length( $name ) > $max_id_length;
warn "The name '$name_orig' has been changed to ",
return $name;
}
-# -------------------------------------------------------------------
-sub unreserve {
- my $name = shift || '';
- my $schema_obj_name = shift || '';
+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 $qt = $options->{quote_table_names} || '';
+ my $qf = $options->{quote_field_names} || '';
+ $generator->quote_chars([$qt]);
+ 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 ? join('.', $table_name, $fql_tbl_name)
+ : $fql_tbl_name ? join('.', $table_name, $fql_tbl_name)
+ : $table_name;
+
+# print STDERR "$table_name table_name\n";
+ my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @fks );
+
+ push @comments, "--\n-- Table: $table_name_ur\n--\n" unless $no_comments;
+
+ if ( $table->comments and !$no_comments ){
+ my $c = "-- Comments: \n-- ";
+ $c .= join "\n-- ", $table->comments;
+ $c .= "\n--\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,
+ postgres_version => $postgres_version,
+ type_defs => $type_defs,
+ constraint_defs => \@constraint_defs,});
+ }
- my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
+ #
+ # 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,
+ });
+ $idef and 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 $temporary = "";
+
+ if(exists $table->extra->{temporary}) {
+ $temporary = $table->extra->{temporary} ? "TEMPORARY " : "";
+ }
+
+ my $create_statement;
+ $create_statement = join("\n", @comments);
+ if ($add_drop_table) {
+ if ($postgres_version >= 8.002) {
+ $create_statement .= 'DROP TABLE IF EXISTS ' . $generator->quote($table_name_ur) . " CASCADE;\n";
+ } else {
+ $create_statement .= 'DROP TABLE ' . $generator->quote($table_name_ur) . " CASCADE;\n";
+ }
+ }
+ $create_statement .= "CREATE ${temporary}TABLE " . $generator->quote($table_name_ur) . " (\n" .
+ join( ",\n", map { " $_" } @field_defs, @constraint_defs ).
+ "\n)"
+ ;
+ $create_statement .= @index_defs ? ';' : q{};
+ $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;
+}
+
+sub create_view {
+ my ($view, $options) = @_;
+ my $qt = $options->{quote_table_names} || '';
+ my $qf = $options->{quote_field_names} || '';
+ $generator->quote_chars([$qt]);
+ my $postgres_version = $options->{postgres_version} || 0;
+ my $add_drop_view = $options->{add_drop_view};
+
+ my $view_name = $view->name;
+ debug("PKG: Looking at view '${view_name}'\n");
+
+ my $create = '';
+ $create .= "--\n-- View: " . $generator->quote($view_name) . "\n--\n"
+ unless $options->{no_comments};
+ if ($add_drop_view) {
+ if ($postgres_version >= 8.002) {
+ $create .= "DROP VIEW IF EXISTS " . $generator->quote($view_name) . ";\n";
+ } else {
+ $create .= "DROP VIEW " . $generator->quote($view_name) . ";\n";
+ }
+ }
+ $create .= 'CREATE';
- # also trap fields that don't begin with a letter
- return $name if !$reserved{ uc $name } && $name =~ /^[a-z]/i;
+ my $extra = $view->extra;
+ $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
+ $create .= " VIEW " . $generator->quote($view_name);
- if ( $schema_obj_name ) {
- ++$unreserve{"$schema_obj_name.$name"};
+ if ( my @fields = $view->fields ) {
+ my $field_list = join ', ', map { $generator->quote($_) } @fields;
+ $create .= " ( ${field_list} )";
+ }
+
+ if ( my $sql = $view->sql ) {
+ $create .= " AS\n ${sql}\n";
+ }
+
+ if ( $extra->{check_option} ) {
+ $create .= ' WITH ' . uc $extra->{check_option} . ' CHECK OPTION';
+ }
+
+ return $create;
+}
+
+{
+
+ my %field_name_scope;
+
+ sub create_field
+ {
+ my ($field, $options) = @_;
+
+ my $qt = $options->{quote_table_names} || '';
+ my $qf = $options->{quote_field_names} || '';
+ $generator->quote_chars([$qt]);
+ 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} || {};
+
+ $field_name_scope{$table_name} ||= {};
+ my $field_name = $field->name;
+ my $field_comments = $field->comments
+ ? "-- " . $field->comments . "\n "
+ : '';
+
+ my $field_def = $field_comments . $generator->quote($field_name);
+
+ #
+ # 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 );
+
+ 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;
+ 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
+ #
+ 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} ||'';
+ $generator->quote_chars([$qt]);
+ my $table_name = $index->table->name;
+
+ my ($index_def, @constraint_defs);
+
+ my $name
+ = $index->name
+ || join('_', $table_name, 'idx', ++$index_name{ $table_name });
+
+ my $type = $index->type || NORMAL;
+ my @fields = $index->fields;
+ return unless @fields;
+
+ my $def_start = 'CONSTRAINT ' . $generator->quote($name) . ' ';
+ my $field_names = '(' . join(", ", (map { $_ =~ /\(.*\)/ ? $_ : ( $generator->quote($_) ) } @fields)) . ')';
+ if ( $type eq PRIMARY_KEY ) {
+ push @constraint_defs, "${def_start}PRIMARY KEY ".$field_names;
+ }
+ elsif ( $type eq UNIQUE ) {
+ push @constraint_defs, "${def_start}UNIQUE " .$field_names;
+ }
+ elsif ( $type eq NORMAL ) {
+ $index_def =
+ 'CREATE INDEX ' . $generator->quote($name) . ' on ' . $generator->quote($table_name) . ' ' . $field_names
+ ;
}
else {
- ++$unreserve{"$name (table name)"};
+ warn "Unknown index type ($type) on table $table_name.\n"
+ if $WARN;
}
- my $unreserve = sprintf '%s_', $name;
- return $unreserve.$suffix;
+ return $index_def, \@constraint_defs;
}
-# -------------------------------------------------------------------
-sub next_unused_name {
- my $name = shift || '';
- my $used_names = shift || '';
+sub create_constraint
+{
+ my ($c, $options) = @_;
+
+ my $qf = $options->{quote_field_names} ||'';
+ my $qt = $options->{quote_table_names} ||'';
+ $generator->quote_chars([$qt]);
+ my $table_name = $c->table->name;
+ my (@constraint_defs, @fks);
+
+ my $name = $c->name || '';
- my %used_names = %$used_names;
+ my @fields = grep { defined } $c->fields;
- if ( !defined($used_names{$name}) ) {
- $used_names{$name} = $name;
- return $name;
+ my @rfields = grep { defined } $c->reference_fields;
+
+ next if !@fields && $c->type ne CHECK_C;
+ my $def_start = $name ? 'CONSTRAINT ' . $generator->quote($name) . ' ' : '';
+ my $field_names = '(' . join(", ", (map { $_ =~ /\(.*\)/ ? $_ : ( $generator->quote($_) ) } @fields)) . ')';
+ if ( $c->type eq PRIMARY_KEY ) {
+ push @constraint_defs, "${def_start}PRIMARY KEY ".$field_names;
}
-
- my $i = 2;
- while ( defined($used_names{$name . $i}) ) {
- ++$i;
+ elsif ( $c->type eq UNIQUE ) {
+ push @constraint_defs, "${def_start}UNIQUE " .$field_names;
}
- $name .= $i;
- $used_names{$name} = $name;
- return $name;
+ 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 " . $generator->quote($table_name) . " ADD ${def_start}FOREIGN KEY $field_names"
+ . "\n REFERENCES " . $generator->quote($c->reference_table);
+
+ if ( @rfields ) {
+ $def .= ' (' . join( ', ', map { $generator->quote($_) } @rfields ) . ')';
+ }
+
+ if ( $c->match_type ) {
+ $def .= ' MATCH ' .
+ ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
+ }
+
+ if ( $c->on_delete ) {
+ $def .= ' ON DELETE '. $c->on_delete;
+ }
+
+ if ( $c->on_update ) {
+ $def .= ' ON UPDATE '. $c->on_update;
+ }
+
+ if ( $c->deferrable ) {
+ $def .= ' DEFERRABLE';
+ }
+
+ push @fks, "$def";
+ }
+
+ return \@constraint_defs, \@fks;
+}
+
+sub create_trigger {
+ my ($trigger,$options) = @_;
+
+ my @statements;
+
+ push @statements, sprintf( 'DROP TRIGGER IF EXISTS %s', $trigger->name )
+ if $options->{add_drop_trigger};
+
+ my $scope = $trigger->scope || '';
+ $scope = " FOR EACH $scope" if $scope;
+
+ push @statements, sprintf(
+ 'CREATE TRIGGER %s %s %s ON %s%s %s',
+ $trigger->name,
+ $trigger->perform_action_when,
+ join( ' OR ', @{ $trigger->database_events } ),
+ $trigger->on_table,
+ $scope,
+ $trigger->action,
+ );
+
+ return @statements;
+}
+
+sub convert_datatype
+{
+ my ($field) = @_;
+
+ my @size = $field->size;
+ my $data_type = lc $field->data_type;
+ my $array = $data_type =~ s/\[\]$//;
+
+ 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,
+# 'CONSTRAINT "$chk_name" CHECK (' . $generator->quote(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;
+ }
+
+ if ( $data_type =~ /^time/i || $data_type =~ /^interval/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';
+ }
+ }
+
+ my $type_with_size = join('|',
+ 'bit', 'varbit', 'character', 'bit varying', 'character varying',
+ 'time', 'timestamp', 'interval', 'numeric'
+ );
+
+ if ( $data_type !~ /$type_with_size/ ) {
+ @size = ();
+ }
+
+ if (defined $size[0] && $size[0] > 0 && $data_type =~ /^time/i ) {
+ $data_type =~ s/^(time.*?)( with.*)?$/$1($size[0])/;
+ $data_type .= $2 if(defined $2);
+ } 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;
+}
+
+
+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;
+
+ # 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);
+
+ # it's necessary to start with rename column cause this would affect
+ # all of the following statements which would be broken if do the
+ # rename later
+ # BUT: drop geometry is done before the rename, cause it work's on the
+ # $from_field directly
+ 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 NOT NULL',
+ $to_field->table->name,
+ $to_field->name) if(!$to_field->is_nullable and
+ $from_field->is_nullable);
+
+ push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s DROP NOT NULL',
+ $to_field->table->name,
+ $to_field->name)
+ if ( !$from_field->is_nullable and $to_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);
+
+ my $old_default = $from_field->default_value;
+ my $new_default = $to_field->default_value;
+ my $default_value = $to_field->default_value;
+
+ # fixes bug where output like this was created:
+ # ALTER TABLE users ALTER COLUMN column SET DEFAULT ThisIsUnescaped;
+ if(ref $default_value eq "SCALAR" ) {
+ $default_value = $$default_value;
+ } elsif( defined $default_value && $to_dt =~ /^(character|text)/xsmi ) {
+ $default_value =~ s/'/''/xsmg;
+ $default_value = q(') . $default_value . q(');
+ }
+
+ push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s SET DEFAULT %s',
+ $to_field->table->name,
+ $to_field->name,
+ $default_value)
+ if ( defined $new_default &&
+ (!defined $old_default || $old_default ne $new_default) );
+
+ # fixes bug where removing the DEFAULT statement of a column
+ # would result in no change
+
+ push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s DROP DEFAULT',
+ $to_field->table->name,
+ $to_field->name)
+ if ( !defined $new_default && defined $old_default );
+
+ # add geometry column and constraints
+ 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);
+}
+
+sub rename_field { alter_field(@_) }
+
+sub add_field
+{
+ my ($new_field) = @_;
+
+ 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;
+
+}
+
+sub drop_field
+{
+ my ($old_field, $options) = @_;
+
+ my $qt = $options->{quote_table_names} ||'';
+ my $qf = $options->{quote_field_names} ||'';
+ $generator->quote_chars([$qt]);
+
+ my $out = sprintf('ALTER TABLE %s DROP COLUMN %s',
+ $generator->quote($old_field->table->name),
+ $generator->quote($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} || '';
+ $generator->quote_chars([$qt]);
+ my $out = sprintf('ALTER TABLE %s %s',
+ $generator->quote($to_table->name),
+ $options->{alter_table_action});
+ $out .= "\n".$options->{geometry_changes} if $options->{geometry_changes};
+ return $out;
+}
+
+sub rename_table {
+ my ($old_table, $new_table, $options) = @_;
+ my $qt = $options->{quote_table_names} || '';
+ $generator->quote_chars([$qt]);
+ $options->{alter_table_action} = "RENAME TO " . $generator->quote($new_table);
+
+ 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 alter_create_index {
+ my ($index, $options) = @_;
+ my $qt = $options->{quote_table_names} || '';
+ my $qf = $options->{quote_field_names} || '';
+ $generator->quote_chars([$qt]);
+ my ($idef, $constraints) = create_index($index, {
+ quote_field_names => $qf,
+ quote_table_names => $qt,
+ table_name => $index->table->name,
+ });
+ return $index->type eq NORMAL ? $idef
+ : sprintf('ALTER TABLE %s ADD %s',
+ $generator->quote($index->table->name),
+ join(q{}, @$constraints)
+ );
+}
+
+sub alter_drop_index {
+ my ($index, $options) = @_;
+ my $index_name = $index->name;
+ return "DROP INDEX $index_name";
+}
+
+sub alter_drop_constraint {
+ my ($c, $options) = @_;
+ my $qt = $options->{quote_table_names} || '';
+ my $qc = $options->{quote_field_names} || '';
+ $generator->quote_chars([$qt]);
+
+ # attention: Postgres has a very special naming structure for naming
+ # foreign keys and primary keys. It names them using the name of the
+ # table as prefix and fkey or pkey as suffix, concatenated by an underscore
+ my $c_name;
+ if( $c->name ) {
+ # Already has a name, just quote it
+ $c_name = $qc . $c->name . $qc;
+ } elsif ( $c->type eq FOREIGN_KEY ) {
+ # Doesn't have a name, and is foreign key, append '_fkey'
+ $c_name = $qc . $c->table->name . '_' .
+ ($c->fields)[0] . '_fkey' . $qc;
+ } elsif ( $c->type eq PRIMARY_KEY ) {
+ # Doesn't have a name, and is primary key, append '_pkey'
+ $c_name = $qc . $c->table->name . '_pkey' . $qc;
+ }
+
+ return sprintf(
+ 'ALTER TABLE %s DROP CONSTRAINT %s',
+ $qt . $c->table->name . $qt, $c_name
+ );
+}
+
+sub alter_create_constraint {
+ my ($index, $options) = @_;
+ my $qt = $options->{quote_table_names} || '';
+ $generator->quote_chars([$qt]);
+ my ($defs, $fks) = create_constraint(@_);
+
+ # return if there are no constraint definitions so we don't run
+ # into output like this:
+ # ALTER TABLE users ADD ;
+
+ return unless(@{$defs} || @{$fks});
+ return $index->type eq FOREIGN_KEY ? join(q{}, @{$fks})
+ : join( ' ', 'ALTER TABLE', $generator->quote($index->table->name),
+ 'ADD', join(q{}, @{$defs}, @{$fks})
+ );
+}
+
+sub drop_table {
+ my ($table, $options) = @_;
+ my $qt = $options->{quote_table_names} || '';
+ $generator->quote_chars([$qt]);
+ my $out = "DROP TABLE " . $generator->quote($table) . " 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;
+}
+
+sub batch_alter_table {
+ my ( $table, $diff_hash, $options ) = @_;
+ my $qt = $options->{quote_table_names} || '';
+ $generator->quote_chars([$qt]);
+
+ # as long as we're not renaming the table we don't need to be here
+ if ( @{$diff_hash->{rename_table}} == 0 ) {
+ return batch_alter_table_statements($diff_hash, $options);
+ }
+
+ # first we need to perform drops which are on old table
+ my @sql = batch_alter_table_statements($diff_hash, $options, qw(
+ alter_drop_constraint
+ alter_drop_index
+ drop_field
+ ));
+
+ # next comes the rename_table
+ my $old_table = $diff_hash->{rename_table}[0][0];
+ push @sql, rename_table( $old_table, $table, $options );
+
+ # for alter_field (and so also rename_field) we need to make sure old
+ # field has table name set to new table otherwise calling alter_field dies
+ $diff_hash->{alter_field} =
+ [map { $_->[0]->table($table) && $_ } @{$diff_hash->{alter_field}}];
+ $diff_hash->{rename_field} =
+ [map { $_->[0]->table($table) && $_ } @{$diff_hash->{rename_field}}];
+
+ # now add everything else
+ push @sql, batch_alter_table_statements($diff_hash, $options, qw(
+ add_field
+ alter_field
+ rename_field
+ alter_create_index
+ alter_create_constraint
+ alter_table
+ ));
+
+ return @sql;
}
1;
=head1 AUTHOR
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
=cut