X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FProducer%2FPostgreSQL.pm;h=2a71463257c19c5defcfca297a26d66541b639f0;hb=b14cf6f45b6b76766529f0d6d9ced1cfd84aea41;hp=f711b4f8094a8ec6b809c7831b2089d22b684eb1;hpb=8d11f4cb2c75adafc4686ee3196331675c554162;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Producer/PostgreSQL.pm b/lib/SQL/Translator/Producer/PostgreSQL.pm index f711b4f..2a71463 100644 --- a/lib/SQL/Translator/Producer/PostgreSQL.pm +++ b/lib/SQL/Translator/Producer/PostgreSQL.pm @@ -1,25 +1,5 @@ package SQL::Translator::Producer::PostgreSQL; -# ------------------------------------------------------------------- -# $Id: PostgreSQL.pm,v 1.29 2007-06-04 04:01:14 mwz444 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 @@ -34,21 +14,40 @@ 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 warnings; -use vars qw[ $DEBUG $WARN $VERSION %used_names ]; -$VERSION = sprintf "%d.%02d", q$Revision: 1.29 $ =~ /(\d+)\.(\d+)/; +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(debug header_comment); +use SQL::Translator::Utils qw(debug header_comment parse_dbms_version batch_alter_table_statements normalize_quote_options); +use SQL::Translator::Generator::DDL::PostgreSQL; use Data::Dumper; -my %translate; -my $max_id_length; +use constant MAX_ID_LENGTH => 62; + +{ + my ($quoting_generator, $nonquoting_generator); + sub _generator { + my $options = shift; + return $options->{generator} if exists $options->{generator}; + + return normalize_quote_options($options) + ? $quoting_generator ||= SQL::Translator::Generator::DDL::PostgreSQL->new + : $nonquoting_generator ||= SQL::Translator::Generator::DDL::PostgreSQL->new( + quote_chars => [], + ); + } +} + +my ( %translate ); BEGIN { @@ -56,19 +55,15 @@ BEGIN { # # MySQL types # - bigint => 'bigint', - double => 'numeric', + double => 'double precision', decimal => 'numeric', - float => 'numeric', int => 'integer', mediumint => 'integer', - smallint => 'smallint', tinyint => 'smallint', char => 'character', varchar => 'character varying', longtext => 'text', mediumtext => 'text', - text => 'text', tinytext => 'text', tinyblob => 'bytea', blob => 'bytea', @@ -76,61 +71,28 @@ BEGIN { longblob => 'bytea', enum => 'character varying', set => 'character varying', - date => 'date', datetime => 'timestamp', - time => 'time', - timestamp => 'timestamp', year => 'date', # # Oracle types # number => 'integer', - char => 'character', varchar2 => 'character varying', long => 'text', - CLOB => 'bytea', - date => 'date', + clob => 'text', # # Sybase types # - int => 'integer', - money => 'money', - varchar => 'character varying', - datetime => 'timestamp', - text => 'text', - real => 'numeric', comment => 'text', - bit => 'bit', - tinyint => 'smallint', - float => 'numeric', -); - $max_id_length = 62; + # + # MS Access types + # + memo => 'text', +); } -my %reserved = map { $_, 1 } qw[ - 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 - 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 - 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 - UNION UNIQUE USER USING VERBOSE WHEN WHERE -]; - -# my $max_id_length = 62; -my %used_identifiers = (); -my %global_names; -my %unreserve; my %truncated; =pod @@ -174,54 +136,61 @@ and table_constraint is: =cut -# ------------------------------------------------------------------- sub produce { - 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; - local %used_names = (); - - my $postgres_version = $pargs->{postgres_version} || 0; - - 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 $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 $generator = _generator({ quote_identifiers => $translator->quote_identifiers }); + + my @output; + 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, - { quote_table_names => $qt, - quote_field_names => $qf, - no_comments => $no_comments, - postgres_version => $postgres_version, - add_drop_table => $add_drop_table,}); + my ($table_def, $fks) = create_table($table, { + generator => $generator, + 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; - } for my $view ( $schema->get_views ) { - push @table_defs, create_view($view, { - add_drop_view => $add_drop_table, - quote_table_names => $qt, - quote_field_names => $qf, - no_comments => $no_comments, - }); + push @table_defs, create_view($view, { + postgres_version => $postgres_version, + add_drop_view => $add_drop_table, + generator => $generator, + no_comments => $no_comments, + }); } - $output = join(";\n\n", @table_defs) . ";\n\n"; + for my $trigger ( $schema->get_triggers ) { + push @table_defs, create_trigger( $trigger, { + add_drop_trigger => $add_drop_table, + generator => $generator, + 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 ) . ";\n"; + push @output, "--\n-- Foreign Key Definitions\n--\n\n" unless $no_comments; + push @output, map { "$_;\n\n" } @fks; } if ( $WARN ) { @@ -229,151 +198,108 @@ sub produce { 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 $critical = shift || ''; - my $basename_orig = $basename; -# my $max_id_length = 62; - 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; - - if ( $basename ne $basename_orig and $critical ) { - my $show_type = $type ? "+'$type'" : ""; - warn "Truncating '$basename_orig'$show_type to $max_id_length ", - "character limit to make '$name'\n" if $WARN; - $truncated{ $basename_orig } = $name; - } - - $scope ||= \%global_names; - if ( my $prev = $scope->{ $name } ) { - my $name_orig = $name; - $name .= sprintf( "%02d", ++$prev ); - substr($name, $max_id_length - 3) = "00" - if length( $name ) > $max_id_length; - - warn "The name '$name_orig' has been changed to ", - "'$name' to make it unique.\n" if $WARN; - - $scope->{ $name_orig }++; - } - - $scope->{ $name }++; - return $name; -} - -# ------------------------------------------------------------------- -sub unreserve { - my $name = shift || ''; - my $schema_obj_name = shift || ''; +{ + my %global_names; + sub mk_name { + 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) + : MAX_ID_LENGTH; + $basename = substr( $basename, 0, $max_name ) + if length( $basename ) > $max_name; + my $name = $type ? "${type}_$basename" : $basename; + + if ( $basename ne $basename_orig and $critical ) { + my $show_type = $type ? "+'$type'" : ""; + warn "Truncating '$basename_orig'$show_type to ", MAX_ID_LENGTH, + " character limit to make '$name'\n" if $WARN; + $truncated{ $basename_orig } = $name; + } - my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : ''; + $scope ||= \%global_names; + if ( my $prev = $scope->{ $name } ) { + my $name_orig = $name; + $name .= sprintf( "%02d", ++$prev ); + substr($name, MAX_ID_LENGTH - 3) = "00" + if length( $name ) > MAX_ID_LENGTH; - # also trap fields that don't begin with a letter - return $name if (!$reserved{ uc $name }) && $name =~ /^[a-z]/i; + warn "The name '$name_orig' has been changed to ", + "'$name' to make it unique.\n" if $WARN; - if ( $schema_obj_name ) { - ++$unreserve{"$schema_obj_name.$name"}; - } - else { - ++$unreserve{"$name (table name)"}; - } - - my $unreserve = sprintf '%s_', $name; - return $unreserve.$suffix; -} + $scope->{ $name_orig }++; + } -# ------------------------------------------------------------------- -sub next_unused_name { - my $name = shift || ''; - if ( !defined( $used_names{$name} ) ) { - $used_names{$name} = $name; + $scope->{ $name }++; return $name; } +} - my $i = 2; - while ( defined( $used_names{ $name . $i } ) ) { - ++$i; - } - $name .= $i; - $used_names{$name} = $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 +sub create_table { my ($table, $options) = @_; - my $qt = $options->{quote_table_names} || ''; - my $qf = $options->{quote_field_names} || ''; + my $generator = _generator($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; - $table_name = mk_name( $table_name, '', undef, 1 ); - 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); - $table->name($table_name_ur); + my $table_name_qt = $generator->quote($table_name); # print STDERR "$table_name table_name\n"; - my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @type_defs, @type_drops, @fks ); + my ( @comments, @field_defs, @index_defs, @sequence_defs, @constraint_defs, @fks ); - push @comments, "--\n-- Table: $table_name_ur\n--\n" unless $no_comments; + push @comments, "--\n-- Table: $table_name\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; + if ( !$no_comments and my $comments = $table->comments ) { + $comments =~ s/^/-- /mg; + push @comments, "-- Comments:\n$comments\n--\n"; } # # 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, - type_drops => \@type_drops, - constraint_defs => \@constraint_defs,}); + push @field_defs, create_field($field, { + generator => $generator, + postgres_version => $postgres_version, + type_defs => $type_defs, + 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, - }); + my ($idef, $constraints) = create_index($index, { + generator => $generator, + }); $idef and push @index_defs, $idef; push @constraint_defs, @$constraints; } @@ -381,39 +307,25 @@ sub create_table # # 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, - }); + my ($cdefs, $fks) = create_constraint($c, { + generator => $generator, + }); 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); + my $create_statement = join("\n", @comments); if ($add_drop_table) { - if ($postgres_version >= 8.2) { - $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; + if ($postgres_version >= 8.002) { + $create_statement .= "DROP TABLE IF EXISTS $table_name_qt CASCADE;\n"; } else { - $create_statement .= qq[DROP TABLE $qt$table_name_ur$qt CASCADE;\n]; + $create_statement .= "DROP TABLE $table_name_qt CASCADE;\n"; } } - $create_statement .= join("\n", @type_defs) . "\n" - if $postgres_version >= 8.3; - $create_statement .= qq[CREATE ${temporary}TABLE $qt$table_name_ur$qt (\n]. + my $temporary = $table->extra->{temporary} ? "TEMPORARY " : ""; + $create_statement .= "CREATE ${temporary}TABLE $table_name_qt (\n" . join( ",\n", map { " $_" } @field_defs, @constraint_defs ). "\n)" ; @@ -421,35 +333,52 @@ sub create_table $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} || ''; + my $generator = _generator($options); + 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: ${qt}${view_name}${qt}\n--\n" + $create .= "--\n-- View: " . $generator->quote($view_name) . "\n--\n" unless $options->{no_comments}; - $create .= "DROP VIEW ${qt}${view_name}${qt};\n" if $add_drop_view; + 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'; my $extra = $view->extra; $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary}; - $create .= " VIEW ${qt}${view_name}${qt}"; + $create .= " VIEW " . $generator->quote($view_name); if ( my @fields = $view->fields ) { - my $field_list = join ', ', map { "${qf}${_}${qf}" } @fields; + my $field_list = join ', ', map { $generator->quote($_) } @fields; $create .= " ( ${field_list} )"; } if ( my $sql = $view->sql ) { - $create .= " AS (\n ${sql}\n )"; + $create .= " AS\n ${sql}\n"; } if ( $extra->{check_option} ) { @@ -459,7 +388,7 @@ sub create_view { return $create; } -{ +{ my %field_name_scope; @@ -467,25 +396,21 @@ sub create_view { { my ($field, $options) = @_; - my $qt = $options->{quote_table_names} || ''; - my $qf = $options->{quote_field_names} || ''; + my $generator = _generator($options); 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 = 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_name = $field->name; + my $field_comments = ''; + if (my $comments = $field->comments) { + $comments =~ s/(?quote($field_name); # # Datatype @@ -494,81 +419,132 @@ sub create_view { 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 $commalist = join( ', ', map { __PACKAGE__->_quote_string($_) } @$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 + # 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', - ], - ); - } + __PACKAGE__->_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($_, { + generator => $generator, + }); + 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; +} + +{ + my %index_name; sub create_index { my ($index, $options) = @_; - my $qt = $options->{quote_table_names} ||''; - my $qf = $options->{quote_field_names} ||''; + my $generator = _generator($options); my $table_name = $index->table->name; -# my $table_name_ur = $qt ? unreserve($table_name) : $table_name; my ($index_def, @constraint_defs); - my $name = $index->name || ''; - if ( $name ) { - $name = next_unused_name($name); - } + my $name + = $index->name + || join('_', $table_name, 'idx', ++$index_name{ $table_name }); my $type = $index->type || NORMAL; - my @fields = - map { $_ =~ s/\(.+\)//; $_ } - map { $qt ? $_ : unreserve($_, $table_name ) } - $index->fields; - next unless @fields; + my @fields = $index->fields; + return unless @fields; + + my $index_using; + my $index_where; + for my $opt ( $index->options ) { + if ( ref $opt eq 'HASH' ) { + foreach my $key (keys %$opt) { + my $value = $opt->{$key}; + next unless defined $value; + if ( uc($key) eq 'USING' ) { + $index_using = "USING $value"; + } + elsif ( uc($key) eq 'WHERE' ) { + $index_where = "WHERE $value"; + } + } + } + } - my $def_start = qq[CONSTRAINT "$name" ]; + 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 ". - '(' .$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 ). - ')' - ; + $index_def = + 'CREATE INDEX ' . $generator->quote($name) . ' on ' . $generator->quote($table_name) . ' ' . + join ' ', grep { defined } $index_using, $field_names, $index_where; } else { warn "Unknown index type ($type) on table $table_name.\n" @@ -577,77 +553,90 @@ sub create_view { return $index_def, \@constraint_defs; } +} - sub create_constraint - { - my ($c, $options) = @_; +sub create_constraint +{ + my ($c, $options) = @_; + + my $generator = _generator($options); + my $table_name = $c->table->name; + my (@constraint_defs, @fks); + + my $name = $c->name || ''; - my $qf = $options->{quote_field_names} ||''; - my $qt = $options->{quote_table_names} ||''; - my $table_name = $c->table->name; - my (@constraint_defs, @fks); + my @fields = grep { defined } $c->fields; - my $name = $c->name || ''; - if ( $name ) { - $name = next_unused_name($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; + } + elsif ( $c->type eq UNIQUE ) { + 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 " . $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 ) . ')'; } - 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.')'; + if ( $c->match_type ) { + $def .= ' MATCH ' . + ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL'; } - elsif ( $c->type eq UNIQUE ) { - $name = next_unused_name($name); - push @constraint_defs, "${def_start}UNIQUE " . - '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')'; + + if ( $c->on_delete ) { + $def .= ' ON DELETE '. $c->on_delete; } - elsif ( $c->type eq CHECK_C ) { - my $expression = $c->expression; - push @constraint_defs, "${def_start}CHECK ($expression)"; + + if ( $c->on_update ) { + $def .= ' ON UPDATE '. $c->on_update; } - 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->deferrable ) { + $def .= ' DEFERRABLE'; + } - if ( $c->match_type ) { - $def .= ' MATCH ' . - ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL'; - } + push @fks, "$def"; + } - if ( $c->on_delete ) { - $def .= ' ON DELETE '.join( ' ', $c->on_delete ); - } + return \@constraint_defs, \@fks; +} - if ( $c->on_update ) { - $def .= ' ON UPDATE '.join( ' ', $c->on_update ); - } +sub create_trigger { + my ($trigger,$options) = @_; + my $generator = _generator($options); - if ( $c->deferrable ) { - $def .= ' DEFERRABLE'; - } + my @statements; - push @fks, "$def"; - } + push @statements, sprintf( 'DROP TRIGGER IF EXISTS %s', $generator->quote($trigger->name) ) + if $options->{add_drop_trigger}; - return \@constraint_defs, \@fks; - } + my $scope = $trigger->scope || ''; + $scope = " FOR EACH $scope" if $scope; + + push @statements, sprintf( + 'CREATE TRIGGER %s %s %s ON %s%s %s', + $generator->quote($trigger->name), + $trigger->perform_action_when, + join( ' OR ', @{ $trigger->database_events } ), + $generator->quote($trigger->on_table), + $scope, + $trigger->action, + ); + + return @statements; +} sub convert_datatype { @@ -655,13 +644,14 @@ sub convert_datatype 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, -# qq[CONSTRAINT "$chk_name" CHECK ($qf$field_name$qf ]. +# push @$constraint_defs, +# 'CONSTRAINT "$chk_name" CHECK (' . $generator->quote(field_name) . # qq[IN ($commalist))]; $data_type = 'character varying'; } @@ -678,12 +668,12 @@ sub convert_datatype undef @size; } else { - $data_type = defined $translate{ $data_type } ? - $translate{ $data_type } : + $data_type = defined $translate{ lc $data_type } ? + $translate{ lc $data_type } : $data_type; } - if ( $data_type =~ /timestamp/i ) { + if ( $data_type =~ /^time/i || $data_type =~ /^interval/i ) { if ( defined $size[0] && $size[0] > 6 ) { $size[0] = 6; } @@ -705,22 +695,33 @@ sub convert_datatype $data_type = 'integer'; } } - my @type_without_size = qw/bigint boolean box bytea cidr circle date inet - integer smallint text line lseg macaddr money - path point polygon real/; - foreach (@type_without_size) { - if ( $data_type =~ qr/$_/ ) { - undef @size; last; - } + + my $type_with_size = join('|', + 'bit', 'varbit', 'character', 'bit varying', 'character varying', + 'time', 'timestamp', 'interval', 'numeric', 'float' + ); + + if ( $data_type !~ /$type_with_size/ ) { + @size = (); } - if ( defined $size[0] && $size[0] > 0 ) { + 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 ) . ')'; } - elsif (defined $size[0] && $data_type eq 'timestamp' ) { - $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; } @@ -730,15 +731,36 @@ sub alter_field { my ($from_field, $to_field) = @_; - die "Can't alter field in another table" + 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', @@ -746,21 +768,38 @@ sub alter_field $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); - 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 = __PACKAGE__->_quote_string($default_value); + } + push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s SET DEFAULT %s', $to_field->table->name, $to_field->name, - $to_field->default_value) + $default_value) if ( defined $new_default && (!defined $old_default || $old_default ne $new_default) ); - return wantarray ? @out : join("\n", @out); + # 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(@_) } @@ -772,49 +811,103 @@ sub add_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) = @_; + my ($old_field, $options) = @_; + + my $generator = _generator($options); my $out = sprintf('ALTER TABLE %s DROP COLUMN %s', - $old_field->table->name, - $old_field->name); + $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; + 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 $generator = _generator($options); my $out = sprintf('ALTER TABLE %s %s', - $qt . $to_table->name . $qt, + $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} || ''; - $options->{alter_table_action} = "RENAME TO $qt$new_table$qt"; + my $generator = _generator($options); + $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} || ''; + my $generator = _generator($options); my ($idef, $constraints) = create_index($index, { - quote_field_names => $qf, - quote_table_names => $qt, - table_name => $index->table->name, + generator => $generator, }); return $index->type eq NORMAL ? $idef : sprintf('ALTER TABLE %s ADD %s', - $qt . $index->table->name . $qt, + $generator->quote($index->table->name), join(q{}, @$constraints) ); } @@ -827,27 +920,94 @@ sub alter_drop_index { sub alter_drop_constraint { my ($c, $options) = @_; - my $qt = $options->{quote_table_names} || ''; - my $qc = $options->{quote_field_names} || ''; - my $out = sprintf('ALTER TABLE %s DROP CONSTRAINT %s', - $qt . $c->table->name . $qt, - $qc . $c->name . $qc ); - return $out; + my $generator = _generator($options); + + # 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 = $generator->quote($c->name); + } elsif ( $c->type eq FOREIGN_KEY ) { + # Doesn't have a name, and is foreign key, append '_fkey' + $c_name = $generator->quote($c->table->name . '_' . + ($c->fields)[0] . '_fkey'); + } elsif ( $c->type eq PRIMARY_KEY ) { + # Doesn't have a name, and is primary key, append '_pkey' + $c_name = $generator->quote($c->table->name . '_pkey'); + } + + return sprintf( + 'ALTER TABLE %s DROP CONSTRAINT %s', + $generator->quote($c->table->name), $c_name + ); } sub alter_create_constraint { my ($index, $options) = @_; - my $qt = $options->{quote_table_names} || ''; - return $index->type eq FOREIGN_KEY ? join(q{}, @{create_constraint(@_)}) - : join( ' ', 'ALTER TABLE', $qt.$index->table->name.$qt, - 'ADD', join(q{}, map { @{$_} } create_constraint(@_)) + my $generator = _generator($options); + 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} || ''; - return "DROP TABLE $qt$table$qt CASCADE"; + my $generator = _generator($options); + 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 ) = @_; + + # 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; @@ -866,6 +1026,6 @@ SQL::Translator, SQL::Translator::Producer::Oracle. =head1 AUTHOR -Ken Y. Clark Ekclark@cpan.orgE. +Ken Youens-Clark Ekclark@cpan.orgE. =cut