Added "show_warnings" and "add_drop_table" options to sql_translator.pl and
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / PostgreSQL.pm
index 4d147a5..5fc1ffa 100644 (file)
@@ -1,7 +1,7 @@
 package SQL::Translator::Producer::PostgreSQL;
 
 # -------------------------------------------------------------------
-# $Id: PostgreSQL.pm,v 1.2 2002-11-22 03:03:40 kycl4rk Exp $
+# $Id: PostgreSQL.pm,v 1.3 2002-11-26 03:59:58 kycl4rk Exp $
 # -------------------------------------------------------------------
 # Copyright (C) 2002 Ken Y. Clark <kclark@cpan.org>,
 #                    darren chamberlain <darren@cpan.org>
@@ -21,9 +21,15 @@ package SQL::Translator::Producer::PostgreSQL;
 # 02111-1307  USA
 # -------------------------------------------------------------------
 
+=head1 NAME
+
+SQL::Translator::Producer::PostgreSQL - PostgreSQL producer for SQL::Translator
+
+=cut
+
 use strict;
-use vars qw($VERSION $DEBUG);
-$VERSION = sprintf "%d.%02d", q$Revision: 1.2 $ =~ /(\d+)\.(\d+)/;
+use vars qw[ $DEBUG $WARN $VERSION ];
+$VERSION = sprintf "%d.%02d", q$Revision: 1.3 $ =~ /(\d+)\.(\d+)/;
 $DEBUG = 1 unless defined $DEBUG;
 
 use Data::Dumper;
@@ -61,51 +67,141 @@ my %translate  = (
     #
     # Oracle types
     #
+    number     => 'integer',
+    char       => 'char',
+    varchar2   => 'varchar',
+    long       => 'text',
+    CLOB       => 'bytea',
+    date       => 'date',
+
+    #
+    # Sybase types
+    #
+    int        => 'integer',
+    money      => 'money',
+    varchar    => 'varchar',
+    datetime   => 'timestamp',
+    text       => 'text',
+    real       => 'double precision',
+    comment    => 'text',
+    bit        => 'bit',
+    tinyint    => 'smallint',
+    float      => 'double precision',
 );
 
+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
+];
 
-sub import {
-    warn "loading " . __PACKAGE__ . "...\n";
-}
+my $max_id_length    = 30;
+my %used_identifiers = ();
+my %global_names;
+my %unreserve;
+my %truncated;
+
+=pod
+
+=head1 PostgreSQL Create Table Syntax
+
+  CREATE [ [ LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name (
+      { column_name data_type [ DEFAULT default_expr ] [ column_constraint [, ... ] ]
+      | table_constraint }  [, ... ]
+  )
+  [ INHERITS ( parent_table [, ... ] ) ]
+  [ WITH OIDS | WITHOUT OIDS ]
+
+where column_constraint is:
+
+  [ CONSTRAINT constraint_name ]
+  { NOT NULL | NULL | UNIQUE | PRIMARY KEY |
+    CHECK (expression) |
+    REFERENCES reftable [ ( refcolumn ) ] [ MATCH FULL | MATCH PARTIAL ]
+      [ ON DELETE action ] [ ON UPDATE action ] }
+  [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
+
+and table_constraint is:
+
+  [ CONSTRAINT constraint_name ]
+  { UNIQUE ( column_name [, ... ] ) |
+    PRIMARY KEY ( column_name [, ... ] ) |
+    CHECK ( expression ) |
+    FOREIGN KEY ( column_name [, ... ] ) REFERENCES reftable [ ( refcolumn [, ... ] ) ]
+      [ MATCH FULL | MATCH PARTIAL ] [ ON DELETE action ] [ ON UPDATE action ] }
+  [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
+
+=cut
 
+# -------------------------------------------------------------------
 sub produce {
     my ( $translator, $data ) = @_;
-    debug("Beginning production\n");
-    my $create = sprintf "--\n-- Created by %s\n-- Created on %s\n-- \n\n",
-        __PACKAGE__, scalar localtime;
-
-    for my $table ( keys %{ $data } ) {
-        debug( "Looking at table '$table'\n" );
-        my $table_data = $data->{$table};
-        my @fields     = sort { 
-            $table_data->{'fields'}->{$a}->{'order'} 
-            <=>
-            $table_data->{'fields'}->{$b}->{'order'}
-        } keys %{ $table_data->{'fields'} };
-
-        $create .= "--\n-- Table: $table\n--\n";
-        $create .= "CREATE TABLE $table (\n";
+    $DEBUG                    = $translator->debug;
+    $WARN                     = $translator->show_warnings;
+    my $no_comments           = $translator->no_comments;
+    my $add_drop_table        = $translator->add_drop_table;
+
+    my $create;
+    unless ( $no_comments ) {
+        $create .=  sprintf 
+            "--\n-- Created by %s\n-- Created on %s\n--\n\n",
+            __PACKAGE__, scalar localtime;
+    }
+
+    for my $table ( 
+        map  { $_->[1] }
+        sort { $a->[0] <=> $b->[0] }
+        map  { [ $_->{'order'}, $_ ] }
+        values %$data
+   ) {
+        my $table_name = $table->{'table_name'};
+        my @fields     = 
+            map  { $_->[1] }
+            sort { $a->[0] <=> $b->[0] }
+            map  { [ $_->{'order'}, $_ ] }
+            values %{ $table->{'fields'} };
+
+        $create .= "--\n-- Table: $table_name\n--\n" unless $no_comments;
+        $create  = "DROP TABLE $table_name;\n" if $add_drop_table;
+        $create .= "CREATE TABLE $table_name (\n";
 
         #
         # Fields
         #
+        my %field_name_scope;
         my @field_statements;
         for my $field ( @fields ) {
-            debug("Looking at field '$field'\n");
-            my $field_data = $table_data->{'fields'}->{ $field };
-            my @fdata      = ("", $field);
+            my @fdata = ("", $field);
+
+            my $field_name    = mk_name(
+                $field->{'name'}, '', \%field_name_scope, 1 
+            );
+            my $field_name_ur = unreserve( $field_name, $table_name );
+            my $field_str     = $field_name_ur;
 
             # data type and size
             push @fdata, sprintf "%s%s", 
-                $field_data->{'data_type'},
-                ( defined $field_data->{'size'} ) 
-                    ? "($field_data->{'size'})" : '';
+                $field->{'data_type'},
+                ( defined $field->{'size'} ) 
+                    ? "($field->{'size'})" : '';
 
             # Null?
-            push @fdata, "NOT NULL" unless $field_data->{'null'};
+            push @fdata, "NOT NULL" unless $field->{'null'};
 
             # Default?  XXX Need better quoting!
-            my $default = $field_data->{'default'};
+            my $default = $field->{'default'};
             if ( defined $default ) {
                 push @fdata, "DEFAULT '$default'";
 #                if (int $default eq "$default") {
@@ -116,10 +212,10 @@ sub produce {
             }
 
             # auto_increment?
-            push @fdata, "auto_increment" if $field_data->{'is_auto_inc'};
+            push @fdata, "auto_increment" if $field->{'is_auto_inc'};
 
             # primary key?
-            push @fdata, "PRIMARY KEY" if $field_data->{'is_primary_key'};
+            push @fdata, "PRIMARY KEY" if $field->{'is_primary_key'};
 
             push @field_statements, join( " ", @fdata );
 
@@ -129,7 +225,7 @@ sub produce {
         #
         # Other keys
         #
-        my @indices = @{ $table_data->{'indices'} || [] };
+        my @indices = @{ $table->{'indices'} || [] };
         for ( my $i = 0; $i <= $#indices; $i++ ) {
             $create .= ",\n";
             my $key = $indices[$i];
@@ -152,19 +248,67 @@ sub produce {
     return $create;
 }
 
-use Carp;
-sub debug {
-    if ( $DEBUG ) {
-        map { carp "[" . __PACKAGE__ . "] $_" } @_;
+# -------------------------------------------------------------------
+sub mk_name {
+    my ($basename, $type, $scope, $critical) = @_;
+    my $basename_orig = $basename;
+    my $max_name      = $max_id_length - (length($type) + 1);
+    $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, $schema_obj_name ) = @_;
+    my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
+
+    # also trap fields that don't begin with a letter
+    return $_[0] if !$reserved{ uc $name } && $name =~ /^[a-z]/i; 
+
+    if ( $schema_obj_name ) {
+        ++$unreserve{"$schema_obj_name.$name"};
+    }
+    else {
+        ++$unreserve{"$name (table name)"};
+    }
+
+    my $unreserve = sprintf '%s_', $name;
+    return $unreserve.$suffix;
 }
 
 1;
-__END__
 
-=head1 NAME
+# -------------------------------------------------------------------
+# Life is full of misery, loneliness, and suffering --
+# and it's all over much too soon.
+# Woody Allen
+# -------------------------------------------------------------------
 
-SQL::Translator::Producer::PostgreSQL - PostgreSQL-specific producer for SQL::Translator
+=pod
 
 =head1 AUTHOR