Backout teejay's changes to get trunk stable again
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / PostgreSQL.pm
index 9647357..8c0ec5d 100644 (file)
@@ -1,9 +1,7 @@
 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
+# Copyright (C) 2002-2009 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
@@ -38,12 +36,13 @@ producer.
 
 use strict;
 use warnings;
-use vars qw[ $DEBUG $WARN $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.29 $ =~ /(\d+)\.(\d+)/;
-$DEBUG = 1 unless defined $DEBUG;
+use vars qw[ $DEBUG $WARN $VERSION %used_names ];
+$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);
 use Data::Dumper;
 
 my %translate;
@@ -176,20 +175,23 @@ and table_constraint is:
 # -------------------------------------------------------------------
 sub produce {
     my $translator     = shift;
-    $DEBUG             = $translator->debug;
-    $WARN              = $translator->show_warnings;
+    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 %used_index_names;
+    my @output;
+    push @output, header_comment unless ($no_comments);
 
     my (@table_defs, @fks);
     for my $table ( $schema->get_tables ) {
@@ -198,16 +200,26 @@ sub produce {
                                              { quote_table_names => $qt,
                                                quote_field_names => $qf,
                                                no_comments => $no_comments,
+                                               postgres_version => $postgres_version,
                                                add_drop_table => $add_drop_table,});
         push @table_defs, $table_def;
         push @fks, @$fks;
 
     }
 
-    $output = join("\n\n", @table_defs);
+    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 @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 ) {
@@ -223,7 +235,9 @@ sub produce {
         }
     }
 
-    return $output;
+    return wantarray
+        ? @output
+        : join ('', @output);
 }
 
 # -------------------------------------------------------------------
@@ -288,18 +302,14 @@ sub unreserve {
 
 # -------------------------------------------------------------------
 sub next_unused_name {
-    my $name       = shift || '';
-    my $used_names = shift || '';
-
-    my %used_names = %$used_names;
-
-    if ( !defined($used_names{$name}) ) {
+    my $name = shift || '';
+    if ( !defined( $used_names{$name} ) ) {
         $used_names{$name} = $name;
         return $name;
     }
-    
+
     my $i = 2;
-    while ( defined($used_names{$name . $i}) ) {
+    while ( defined( $used_names{ $name . $i } ) ) {
         ++$i;
     }
     $name .= $i;
@@ -307,6 +317,7 @@ sub next_unused_name {
     return $name;
 }
 
+
 sub create_table 
 {
     my ($table, $options) = @_;
@@ -315,14 +326,17 @@ sub create_table
     my $qf = $options->{quote_field_names} || '';
     my $no_comments = $options->{no_comments} || 0;
     my $add_drop_table = $options->{add_drop_table} || 0;
+    my $postgres_version = $options->{postgres_version} || 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);
+    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);
     $table->name($table_name_ur);
 
 # print STDERR "$table_name table_name\n";
-    my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @fks );
+    my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @type_defs, @type_drops, @fks );
 
     push @comments, "--\n-- Table: $table_name_ur\n--\n" unless $no_comments;
 
@@ -341,6 +355,9 @@ sub create_table
         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,});
     }
 
@@ -375,20 +392,72 @@ sub create_table
         push @fks, @$fks;
     }
 
+
+    my $temporary = "";
+
+    if(exists $table->{extra}{temporary}) {
+        $temporary = $table->{extra}{temporary} ? "TEMPORARY " : "";
+    } 
+
     my $create_statement;
     $create_statement = join("\n", @comments);
-    $create_statement .= qq[DROP TABLE $qt$table_name_ur$qt CASCADE;\n] 
-        if $add_drop_table;
-    $create_statement .= qq[CREATE TABLE $qt$table_name_ur$qt (\n].
+    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 && 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);"
+                            "\n)"
                             ;
+    $create_statement .= @index_defs ? ';' : q{};
+    $create_statement .= ( $create_statement =~ /;$/ ? "\n" : q{} )
+        . join(";\n", @index_defs);
 
-    $create_statement .= "\n" . join(";\n", @index_defs) . "\n";
-    
     return $create_statement, \@fks;
 }
 
+sub create_view {
+    my ($view, $options) = @_;
+    my $qt = $options->{quote_table_names} || '';
+    my $qf = $options->{quote_field_names} || '';
+    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"
+        unless $options->{no_comments};
+    $create .= "DROP VIEW ${qt}${view_name}${qt};\n" if $add_drop_view;
+    $create .= 'CREATE';
+
+    my $extra = $view->extra;
+    $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
+    $create .= " VIEW ${qt}${view_name}${qt}";
+
+    if ( my @fields = $view->fields ) {
+        my $field_list = join ', ', map { "${qf}${_}${qf}" } @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;
@@ -401,11 +470,12 @@ sub create_table
         my $qf = $options->{quote_field_names} || '';
         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} || [];
 
         $field_name_scope{$table_name} ||= {};
-        my $field_name    = mk_name(
-                                    $field->name, '', $field_name_scope{$table_name}, 1 
-                                    );
+        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 
@@ -423,25 +493,30 @@ sub create_table
         my $list      = $extra{'list'} || [];
         # todo deal with embedded quotes
         my $commalist = join( ', ', map { qq['$_'] } @$list );
-        my $seq_name;
 
-        $field_def .= ' '. convert_datatype($field);
+        if ($postgres_version >= 8.3 && $field->data_type eq 'enum') {
+            my $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";
+        } else {
+            $field_def .= ' '. convert_datatype($field);
+        }
 
         #
-        # Default value -- disallow for timestamps
+        # Default value 
         #
-#        my $default = $data_type =~ /(timestamp|date)/i
-#            ? undef : $field->default_value;
         my $default = $field->default_value;
         if ( defined $default ) {
-            my $qd = "'";
-            $qd = '' if ($default eq 'now()' || 
-                         $default eq 'CURRENT_TIMESTAMP');
-            $field_def .= sprintf( ' DEFAULT %s',
-                                   ( $field->is_auto_increment && $seq_name )
-                                   ? qq[nextval('"$seq_name"'::text)] :
-                                   ( $default =~ m/null/i ) ? 'NULL' : "$qd$default$qd"
-                                   );
+            SQL::Translator::Producer->_apply_default_value(
+              \$field_def,
+              $default,
+              [
+                'NULL'              => \'NULL',
+                'now()'             => 'now()',
+                'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
+              ],
+            );
         }
 
         #
@@ -453,9 +528,6 @@ sub create_table
     }
 }
 
-{
-    my %used_index_names;
-
     sub create_index
     {
         my ($index, $options) = @_;
@@ -467,11 +539,9 @@ sub create_table
 
         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;
+            $name = next_unused_name($name);
         }
 
         my $type = $index->type || NORMAL;
@@ -481,7 +551,7 @@ sub create_table
         $index->fields;
         next unless @fields;
 
-        my $def_start = qq[Constraint "$name" ];
+        my $def_start = qq[CONSTRAINT "$name" ];
         if ( $type eq PRIMARY_KEY ) {
             push @constraint_defs, "${def_start}PRIMARY KEY ".
                 '(' .$qf . join( $qf. ', '.$qf, @fields ) . $qf . ')';
@@ -494,7 +564,7 @@ sub create_table
             $index_def = 
                 "CREATE INDEX ${qf}${name}${qf} on ${qt}${table_name}${qt} (".
                 join( ', ', map { qq[$qf$_$qf] } @fields ).  
-                ');'
+                ')'
                 ; 
         }
         else {
@@ -516,8 +586,7 @@ sub create_table
 
         my $name = $c->name || '';
         if ( $name ) {
-            $name = next_unused_name($name, \%used_index_names);
-            $used_index_names{$name} = $name;
+            $name = next_unused_name($name);
         }
 
         my @fields     = 
@@ -531,14 +600,13 @@ sub create_table
         $c->reference_fields;
 
         next if !@fields && $c->type ne CHECK_C;
-        my $def_start = $name ? qq[Constraint "$name" ] : '';
+        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;
+            $name = next_unused_name($name);
             push @constraint_defs, "${def_start}UNIQUE " .
                 '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
         }
@@ -568,12 +636,15 @@ sub create_table
                 $def .= ' ON UPDATE '.join( ' ', $c->on_update );
             }
 
-            push @fks, "$def;";
+            if ( $c->deferrable ) {
+                $def .= ' DEFERRABLE';
+            }
+
+            push @fks, "$def";
         }
 
         return \@constraint_defs, \@fks;
     }
-}
 
 sub convert_datatype
 {
@@ -587,7 +658,7 @@ sub convert_datatype
 #        $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[CONSTRAINT "$chk_name" CHECK ($qf$field_name$qf ].
 #           qq[IN ($commalist))];
         $data_type = 'character varying';
     }
@@ -609,7 +680,7 @@ sub convert_datatype
             $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;
         }
@@ -640,12 +711,13 @@ sub convert_datatype
         }
     }
 
-    if ( defined $size[0] && $size[0] > 0 ) {
-        $data_type .= '(' . join( ',', @size ) . ')';
-    }
-    elsif (defined $size[0] && $data_type eq 'timestamp' ) {
-        $data_type .= '(' . join( ',', @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 ) . ')';
     }
+    
 
 
     return $data_type;
@@ -660,39 +732,68 @@ sub alter_field
         if($from_field->table->name ne $to_field->table->name);
 
     my @out;
-    push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s SET NOT NULL;',
+    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;',
+    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;',
+    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;',
+    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,
-                       $to_field->default_value) 
-        if(defined $to_field->default_value && 
-           $from_field->default_value ne $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 );
     
+
+    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;',
+    my $out = sprintf('ALTER TABLE %s ADD COLUMN %s',
                       $new_field->table->name,
                       create_field($new_field));
     return $out;
@@ -703,13 +804,83 @@ sub drop_field
 {
     my ($old_field) = @_;
 
-    my $out = sprintf('ALTER TABLE %s DROP COLUMN %s;',
+    my $out = sprintf('ALTER TABLE %s DROP COLUMN %s',
                       $old_field->table->name,
                       $old_field->name);
 
     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});
+    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";
+    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 ($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',
+              $qt . $index->table->name . $qt,
+              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} || '';
+    my $out = sprintf('ALTER TABLE %s DROP CONSTRAINT %s',
+                      $qt . $c->table->name . $qt,
+                      $qc . $c->name . $qc );
+    return $out;
+}
+
+sub alter_create_constraint {
+    my ($index, $options) = @_;
+    my $qt = $options->{quote_table_names} || '';
+    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', $qt.$index->table->name.$qt,
+              'ADD', join(q{}, @{$defs}, @{$fks})
+          );
+}
+
+sub drop_table {
+    my ($table, $options) = @_;
+    my $qt = $options->{quote_table_names} || '';
+    return "DROP TABLE $qt$table$qt CASCADE";
+}
+
 1;
 
 # -------------------------------------------------------------------