Awesome non-quoted numeric default patch by Stephen Clouse
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / PostgreSQL.pm
index a464a85..a881689 100644 (file)
@@ -37,15 +37,15 @@ producer.
 use strict;
 use warnings;
 use vars qw[ $DEBUG $WARN $VERSION %used_names ];
-$VERSION = '1.99';
+$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);
 use Data::Dumper;
 
-my %translate;
+my ( %translate, %index_name );
 my $max_id_length;
 
 BEGIN {
@@ -174,37 +174,36 @@ and table_constraint is:
 
 # -------------------------------------------------------------------
 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 $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{};
     
-    my $output;
-    $output .= header_comment unless ($no_comments);
+    my @output;
+    push @output, header_comment unless ($no_comments);
 
     my (@table_defs, @fks);
     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, { 
+            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;
-
     }
 
     for my $view ( $schema->get_views ) {
@@ -216,10 +215,10 @@ sub produce {
       });
     }
 
-    $output  = join(";\n\n", @table_defs) . ";\n\n";
+    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 ) {
@@ -235,7 +234,9 @@ sub produce {
         }
     }
 
-    return $output;
+    return wantarray
+        ? @output
+        : join ('', @output);
 }
 
 # -------------------------------------------------------------------
@@ -300,22 +301,22 @@ sub unreserve {
 
 # -------------------------------------------------------------------
 sub next_unused_name {
-    my $name = shift || '';
-    if ( !defined( $used_names{$name} ) ) {
-        $used_names{$name} = $name;
-        return $name;
-    }
+    my $orig_name = shift or return;
+    my $name      = $orig_name;
+
+    my $suffix_gen = sub {
+        my $suffix = 0;
+        return ++$suffix ? '' : $suffix;
+    };
 
-    my $i = 2;
-    while ( defined( $used_names{ $name . $i } ) ) {
-        ++$i;
+    for (;;) {
+        $name = $orig_name . $suffix_gen->();
+        last if $used_names{ $name }++;
     }
-    $name .= $i;
-    $used_names{$name} = $name;
+
     return $name;
 }
 
-
 sub create_table 
 {
     my ($table, $options) = @_;
@@ -327,7 +328,6 @@ sub create_table
     my $postgres_version = $options->{postgres_version} || 0;
 
     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))
@@ -401,16 +401,16 @@ sub create_table
     my $create_statement;
     $create_statement = join("\n", @comments);
     if ($add_drop_table) {
-        if ($postgres_version >= 8.2) {
+        if ($postgres_version >= 8.002) {
             $create_statement .= qq[DROP TABLE IF EXISTS $qt$table_name_ur$qt CASCADE;\n];
-            $create_statement .= join ("\n", @type_drops) . "\n"
-                if $postgres_version >= 8.3;
+            $create_statement .= join (";\n", @type_drops) . ";\n"
+                if $postgres_version >= 8.003 && 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;
+    $create_statement .= join(";\n", @type_defs) . ";\n"
+        if $postgres_version >= 8.003 && scalar @type_defs;
     $create_statement .= qq[CREATE ${temporary}TABLE $qt$table_name_ur$qt (\n].
                             join( ",\n", map { "  $_" } @field_defs, @constraint_defs ).
                             "\n)"
@@ -447,7 +447,7 @@ sub create_view {
     }
 
     if ( my $sql = $view->sql ) {
-        $create .= " AS (\n    ${sql}\n  )";
+        $create .= " AS\n    ${sql}\n";
     }
 
     if ( $extra->{check_option} ) {
@@ -474,9 +474,7 @@ sub create_view {
         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 
@@ -495,7 +493,7 @@ sub create_view {
         # todo deal with embedded quotes
         my $commalist = join( ', ', map { qq['$_'] } @$list );
 
-        if ($postgres_version >= 8.3 && $field->data_type eq 'enum') {
+        if ($postgres_version >= 8.003 && $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)";
@@ -507,18 +505,15 @@ sub create_view {
         #
         # Default value 
         #
-        my $default = $field->default_value;
-        if ( defined $default ) {
-            SQL::Translator::Producer->_apply_default_value(
-              \$field_def,
-              $default,
-              [
-                'NULL'              => \'NULL',
-                'now()'             => 'now()',
-                'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
-              ],
-            );
-        }
+        SQL::Translator::Producer->_apply_default_value(
+          $field,
+          \$field_def,
+          [
+            'NULL'              => \'NULL',
+            'now()'             => 'now()',
+            'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
+          ],
+        );
 
         #
         # Not null constraint
@@ -529,124 +524,124 @@ sub create_view {
     }
 }
 
-    sub create_index
-    {
-        my ($index, $options) = @_;
+sub create_index
+{
+    my ($index, $options) = @_;
 
-        my $qt = $options->{quote_table_names} ||'';
-        my $qf = $options->{quote_field_names} ||'';
-        my $table_name = $index->table->name;
+    my $qt = $options->{quote_table_names} ||'';
+    my $qf = $options->{quote_field_names} ||'';
+    my $table_name = $index->table->name;
 #        my $table_name_ur = $qt ? unreserve($table_name) : $table_name;
 
-        my ($index_def, @constraint_defs);
+    my ($index_def, @constraint_defs);
 
-        my $name = $index->name || '';
-        if ( $name ) {
-            $name = next_unused_name($name);
-        }
+    my $name = next_unused_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 $def_start = qq[CONSTRAINT "$name" ];
-        if ( $type eq PRIMARY_KEY ) {
-            push @constraint_defs, "${def_start}PRIMARY KEY ".
-                '(' .$qf . join( $qf. ', '.$qf, @fields ) . $qf . ')';
-        }
-        elsif ( $type eq UNIQUE ) {
-            push @constraint_defs, "${def_start}UNIQUE " .
-                '(' . $qf . join( $qf. ', '.$qf, @fields ) . $qf.')';
-        }
-        elsif ( $type eq NORMAL ) {
-            $index_def = 
-                "CREATE INDEX ${qf}${name}${qf} on ${qt}${table_name}${qt} (".
-                join( ', ', map { qq[$qf$_$qf] } @fields ).  
-                ')'
-                ; 
-        }
-        else {
-            warn "Unknown index type ($type) on table $table_name.\n"
-                if $WARN;
-        }
+    my $type = $index->type || NORMAL;
+    my @fields     = 
+        map { $_ =~ s/\(.+\)//; $_ }
+    map { $qt ? $_ : unreserve($_, $table_name ) }
+    $index->fields;
+    next unless @fields;
 
-        return $index_def, \@constraint_defs;
+    my $def_start = qq[CONSTRAINT "$name" ];
+    if ( $type eq PRIMARY_KEY ) {
+        push @constraint_defs, "${def_start}PRIMARY KEY ".
+            '(' .$qf . join( $qf. ', '.$qf, @fields ) . $qf . ')';
+    }
+    elsif ( $type eq UNIQUE ) {
+        push @constraint_defs, "${def_start}UNIQUE " .
+            '(' . $qf . join( $qf. ', '.$qf, @fields ) . $qf.')';
+    }
+    elsif ( $type eq NORMAL ) {
+        $index_def = 
+            "CREATE INDEX ${qf}${name}${qf} on ${qt}${table_name}${qt} (".
+            join( ', ', map { qq[$qf$_$qf] } @fields ).  
+            ')'
+            ; 
+    }
+    else {
+        warn "Unknown index type ($type) on table $table_name.\n"
+            if $WARN;
     }
 
-    sub create_constraint
-    {
-        my ($c, $options) = @_;
+    return $index_def, \@constraint_defs;
+}
 
-        my $qf = $options->{quote_field_names} ||'';
-        my $qt = $options->{quote_table_names} ||'';
-        my $table_name = $c->table->name;
-        my (@constraint_defs, @fks);
+sub create_constraint
+{
+    my ($c, $options) = @_;
 
-        my $name = $c->name || '';
-        if ( $name ) {
-            $name = next_unused_name($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     = 
-            map { $_ =~ s/\(.+\)//; $_ }
-        map { $qt ? $_ : unreserve( $_, $table_name )}
-        $c->fields;
-
-        my @rfields     = 
-            map { $_ =~ s/\(.+\)//; $_ }
-        map { $qt ? $_ : unreserve( $_, $table_name )}
-        $c->reference_fields;
-
-        next if !@fields && $c->type ne CHECK_C;
-        my $def_start = $name ? qq[CONSTRAINT "$name" ] : '';
-        if ( $c->type eq PRIMARY_KEY ) {
-            push @constraint_defs, "${def_start}PRIMARY KEY ".
-                '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
-        }
-        elsif ( $c->type eq UNIQUE ) {
-            $name = next_unused_name($name);
-            push @constraint_defs, "${def_start}UNIQUE " .
-                '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
-        }
-        elsif ( $c->type eq CHECK_C ) {
-            my $expression = $c->expression;
-            push @constraint_defs, "${def_start}CHECK ($expression)";
-        }
-        elsif ( $c->type eq FOREIGN_KEY ) {
-            my $def .= "ALTER TABLE ${qt}${table_name}${qt} ADD FOREIGN KEY (" . 
-                join( ', ', map { qq[$qf$_$qf] } @fields ) . ')' .
-                "\n  REFERENCES " . $qt . $c->reference_table . $qt;
+    my $name = $c->name || '';
+    if ( $name ) {
+        $name = next_unused_name($name);
+    }
 
-            if ( @rfields ) {
-                $def .= ' ('.$qf . join( $qf.', '.$qf, @rfields ) . $qf.')';
-            }
+    my @fields     = 
+        map { $_ =~ s/\(.+\)//; $_ }
+    map { $qt ? $_ : unreserve( $_, $table_name )}
+    $c->fields;
+
+    my @rfields     = 
+        map { $_ =~ s/\(.+\)//; $_ }
+    map { $qt ? $_ : unreserve( $_, $table_name )}
+    $c->reference_fields;
+
+    next if !@fields && $c->type ne CHECK_C;
+    my $def_start = $name ? qq[CONSTRAINT "$name" ] : '';
+    if ( $c->type eq PRIMARY_KEY ) {
+        push @constraint_defs, "${def_start}PRIMARY KEY ".
+            '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
+    }
+    elsif ( $c->type eq UNIQUE ) {
+        $name = next_unused_name($name);
+        push @constraint_defs, "${def_start}UNIQUE " .
+            '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')';
+    }
+    elsif ( $c->type eq CHECK_C ) {
+        my $expression = $c->expression;
+        push @constraint_defs, "${def_start}CHECK ($expression)";
+    }
+    elsif ( $c->type eq FOREIGN_KEY ) {
+        my $def .= "ALTER TABLE ${qt}${table_name}${qt} ADD FOREIGN KEY (" . 
+            join( ', ', map { qq[$qf$_$qf] } @fields ) . ')' .
+            "\n  REFERENCES " . $qt . $c->reference_table . $qt;
 
-            if ( $c->match_type ) {
-                $def .= ' MATCH ' . 
-                    ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
-            }
+        if ( @rfields ) {
+            $def .= ' ('.$qf . join( $qf.', '.$qf, @rfields ) . $qf.')';
+        }
 
-            if ( $c->on_delete ) {
-                $def .= ' ON DELETE '.join( ' ', $c->on_delete );
-            }
+        if ( $c->match_type ) {
+            $def .= ' MATCH ' . 
+                ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
+        }
 
-            if ( $c->on_update ) {
-                $def .= ' ON UPDATE '.join( ' ', $c->on_update );
-            }
+        if ( $c->on_delete ) {
+            $def .= ' ON DELETE '.join( ' ', $c->on_delete );
+        }
 
-            if ( $c->deferrable ) {
-                $def .= ' DEFERRABLE';
-            }
+        if ( $c->on_update ) {
+            $def .= ' ON UPDATE '.join( ' ', $c->on_update );
+        }
 
-            push @fks, "$def";
+        if ( $c->deferrable ) {
+            $def .= ' DEFERRABLE';
         }
 
-        return \@constraint_defs, \@fks;
+        push @fks, "$def";
     }
 
+    return \@constraint_defs, \@fks;
+}
+
 sub convert_datatype
 {
     my ($field) = @_;
@@ -681,7 +676,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;
         }
@@ -703,23 +698,23 @@ 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;
-        }
-    }
 
-    if ( defined $size[0] && $size[0] > 0 ) {
-        $data_type .= '(' . join( ',', @size ) . ')';
+    my $type_with_size = join('|',
+        'bit', 'varbit', 'character', 'bit varying', 'character varying',
+        'time', 'timestamp', 'interval', 'numeric'
+    );
+
+    if ( $data_type !~ /$type_with_size/ ) {
+        @size = (); 
     }
-    elsif (defined $size[0] && $data_type eq 'timestamp' ) {
+
+    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;
 }
 
@@ -737,6 +732,12 @@ sub alter_field
                        $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',
@@ -751,13 +752,33 @@ sub alter_field
 
     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)
+                       $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 );
+    
+
     return wantarray ? @out : join("\n", @out);
 }
 
@@ -836,9 +857,16 @@ sub alter_drop_constraint {
 sub alter_create_constraint {
     my ($index, $options) = @_;
     my $qt = $options->{quote_table_names} || '';
-    return $index->type eq FOREIGN_KEY ? join(q{}, @{create_constraint(@_)})
+    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{}, map { @{$_} } create_constraint(@_))
+              'ADD', join(q{}, @{$defs}, @{$fks})
           );
 }
 
@@ -864,6 +892,6 @@ SQL::Translator, SQL::Translator::Producer::Oracle.
 
 =head1 AUTHOR
 
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 
 =cut