[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / Oracle.pm

package SQL::Translator::Producer::Oracle;

# -------------------------------------------------------------------
# $Id: Oracle.pm,v 1.21 2003-08-19 14:44:00 kycl4rk Exp $
# -------------------------------------------------------------------
# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
#                    darren chamberlain <darren@cpan.org>,
#                    Chris Mungall <cjm@fruitfly.org>
#
# 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
# -------------------------------------------------------------------

use strict;
use vars qw[ $VERSION $DEBUG $WARN ];
$VERSION = sprintf "%d.%02d", q$Revision: 1.21 $ =~ /(\d+)\.(\d+)/;
$DEBUG   = 0 unless defined $DEBUG;

use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(header_comment);

my %translate  = (
    #
    # MySQL types
    #
    bigint     => 'number',
    double     => 'number',
    decimal    => 'number',
    float      => 'number',
    int        => 'number',
    integer    => 'number',
    mediumint  => 'number',
    smallint   => 'number',
    tinyint    => 'number',
    char       => 'char',
    varchar    => 'varchar2',
    tinyblob   => 'blob',
    blob       => 'blob',
    mediumblob => 'blob',
    longblob   => 'blob',
    tinytext   => 'varchar2',
    text       => 'clob',
    longtext   => 'clob',
    mediumtext => 'clob',
    enum       => 'varchar2',
    set        => 'varchar2',
    date       => 'date',
    datetime   => 'date',
    time       => 'date',
    timestamp  => 'date',
    year       => 'date',

    #
    # PostgreSQL types
    #
    numeric             => 'number',
    'double precision'  => 'number',
    serial              => 'number',
    bigserial           => 'number',
    money               => 'number',
    character           => 'char',
    'character varying' => 'varchar2',
    bytea               => 'BLOB',
    interval            => 'number',
    boolean             => 'number',
    point               => 'number',
    line                => 'number',
    lseg                => 'number',
    box                 => 'number',
    path                => 'number',
    polygon             => 'number',
    circle              => 'number',
    cidr                => 'number',
    inet                => 'varchar2',
    macaddr             => 'varchar2',
    bit                 => 'number',
    'bit varying'       => 'number',
);

#
# Oracle reserved words from:
# http://technet.oracle.com/docs/products/oracle8i/doc_library/\
# 817_doc/server.817/a85397/ap_keywd.htm
#
my %ora_reserved = map { $_, 1 } qw(
    ACCESS ADD ALL ALTER AND ANY AS ASC AUDIT 
    BETWEEN BY
    CHAR CHECK CLUSTER COLUMN COMMENT COMPRESS CONNECT CREATE CURRENT
    DATE DECIMAL DEFAULT DELETE DESC DISTINCT DROP
    ELSE EXCLUSIVE EXISTS 
    FILE FLOAT FOR FROM
    GRANT GROUP 
    HAVING
    IDENTIFIED IMMEDIATE IN INCREMENT INDEX INITIAL INSERT
    INTEGER INTERSECT INTO IS
    LEVEL LIKE LOCK LONG 
    MAXEXTENTS MINUS MLSLABEL MODE MODIFY 
    NOAUDIT NOCOMPRESS NOT NOWAIT NULL NUMBER 
    OF OFFLINE ON ONLINE OPTION OR ORDER
    PCTFREE PRIOR PRIVILEGES PUBLIC
    RAW RENAME RESOURCE REVOKE ROW ROWID ROWNUM ROWS
    SELECT SESSION SET SHARE SIZE SMALLINT START 
    SUCCESSFUL SYNONYM SYSDATE 
    TABLE THEN TO TRIGGER 
    UID UNION UNIQUE UPDATE USER
    VALIDATE VALUES VARCHAR VARCHAR2 VIEW
    WHENEVER WHERE WITH
);

my $max_id_length    = 30;
my %used_identifiers = ();
my %global_names;
my %unreserve;
my %truncated;

# -------------------------------------------------------------------
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);

    if ( $translator->parser_type =~ /mysql/i ) {
        $output .= 
        "-- We assume that default NLS_DATE_FORMAT has been changed\n".
        "-- but we set it here anyway to be self-consistent.\n".
        "ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD HH24:MI:SS';\n\n";
    }

    #
    # Print create for each table
    #
    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) or next;

        my ( @comments, @field_defs, @trigger_defs, @constraint_defs );

        push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;

        my ( %field_name_scope, @field_comments );
        for my $field ( $table->get_fields ) {
            #
            # Field name
            #
            my $field_name    = mk_name(
                $field->name, '', \%field_name_scope, 1 
            );
            my $field_name_ur = unreserve( $field_name, $table_name );
            my $field_def     = $field_name_ur;

            #
            # Datatype
            #
            my $check;
            my $data_type = lc $field->data_type;
            my @size      = $field->size;
            my %extra     = $field->extra;
            my $list      = $extra{'list'} || [];
            # \todo deal with embedded quotes
            my $commalist = join( ', ', map { qq['$_'] } @$list );

            if ( $data_type eq 'enum' ) {
                $check = "CHECK ($field_name_ur IN ($commalist))";
                $data_type = 'varchar2';
            }
            elsif ( $data_type eq 'set' ) {
                # XXX add a CHECK constraint maybe 
                # (trickier and slower, than enum :)
                $data_type = 'varchar2';
            }
            else {
                $data_type  = defined $translate{ $data_type } ?
                              $translate{ $data_type } :
                              die "Unknown datatype: $data_type\n";
            }
            
            #
            # Fixes ORA-02329: column of datatype LOB cannot be 
            # unique or a primary key
            #
            if ( $data_type eq 'clob' && $field->is_primary_key ) {
                $data_type = 'varchar2';
                $size[0]   = 4000;
                warn "CLOB cannot be a primary key, changing to VARCHAR2\n"
                    if $WARN;
            }

            #
            # Fixes ORA-00907: missing right parenthesis
            #
            if ( $data_type =~ /(date|clob)/i ) {
                undef @size;
            }

            $field_def .= " $data_type";
            if ( defined $size[0] && $size[0] > 0 ) {
                $field_def .= '(' . join( ', ', @size ) . ')';
            }

            #
            # Default value
            #
            my $default = $field->default_value;
            if ( defined $default ) {
                $field_def .= sprintf(
                    ' DEFAULT %s',
                    $default =~ m/null/i ? 'NULL' : "'$default'"
                );
            }

            #
            # Not null constraint
            #
            unless ( $field->is_nullable ) {
                my $constraint_name = mk_name($field_name_ur, 'nn');
                $field_def .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
            }

            $field_def .= " $check" if $check;

            #
            # Auto_increment
            #
            if ( $field->is_auto_increment ) {
                my $base_name    = $table_name . "_". $field_name;
                my $seq_name     = mk_name( $base_name, 'sq' );
                my $trigger_name = mk_name( $base_name, 'ai' );

                push @trigger_defs, 
                    "CREATE SEQUENCE $seq_name;\n" .
                    "CREATE OR REPLACE TRIGGER $trigger_name\n" .
                    "BEFORE INSERT ON $table_name\n" .
                    "FOR EACH ROW WHEN (\n" .
                        " new.$field_name_ur IS NULL".
                        " OR new.$field_name_ur = 0\n".
                    ")\n".
                    "BEGIN\n" .
                        " SELECT $seq_name.nextval\n" .
                        " INTO :new." . $field->name."\n" .
                        " FROM dual;\n" .
                    "END;\n/";
                ;
            }

            if ( lc $field->data_type eq 'timestamp' ) {
                my $base_name = $table_name . "_". $field_name_ur;
                my $trig_name = mk_name( $base_name, 'ts' );
                push @trigger_defs, 
                    "CREATE OR REPLACE TRIGGER $trig_name\n".
                    "BEFORE INSERT OR UPDATE ON $table_name_ur\n".
                    "FOR EACH ROW WHEN (new.$field_name_ur IS NULL)\n".
                    "BEGIN \n".
                    " SELECT sysdate INTO :new.$field_name_ur FROM dual;\n".
                    "END;\n/";
            }

            push @field_defs, $field_def;

            if ( my $comment = $field->comments ) {
                push @field_comments, 
                    "COMMENT ON COLUMN $table_name.$field_name_ur is\n  '".
                    $comment."';";
            }
        }

        #
        # Table constraints
        #
        my $constraint_name_default;
        for my $c ( $table->get_constraints ) {
            my $name    = $c->name || '';
            my @fields  = map { unreserve( $_, $table_name ) } $c->fields;
            my @rfields = map { unreserve( $_, $table_name ) } 
                $c->reference_fields;
            next unless @fields;

            if ( $c->type eq PRIMARY_KEY ) {
                $name ||= mk_name( $table_name, 'pk' );
                push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ".
                    '(' . join( ', ', @fields ) . ')';
            }
            elsif ( $c->type eq UNIQUE ) {
                $name ||= mk_name( $table_name, ++$constraint_name_default );
                push @constraint_defs, "CONSTRAINT $name UNIQUE " .
                    '(' . join( ', ', @fields ) . ')';
            }
            elsif ( $c->type eq FOREIGN_KEY ) {
                $name ||= mk_name( $table_name, ++$constraint_name_default );
                my $def = "CONSTRAINT $name FOREIGN KEY ";

                if ( @fields ) {
                    $def .= join( ', ', @fields );
                }

                $def .= ' 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 );
                }

                push @constraint_defs, $def;
            }
        }

        #
        # Index Declarations
        #
        my @index_defs = ();
        my $idx_name_default;
        for my $index ( $table->get_indices ) {
            my $index_name = $index->name || '';
            my $index_type = $index->type || NORMAL;
            my @fields     = map { unreserve( $_, $table_name ) }
                             $index->fields;
            next unless @fields;

            if ( $index_type eq PRIMARY_KEY ) {
                $index_name = mk_name( $table_name, 'pk' );
                push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
                    '(' . join( ', ', @fields ) . ')';
            }
            elsif ( $index_type eq UNIQUE ) {
                $index_name = mk_name( 
                    $table_name, $index_name || ++$idx_name_default
                );
                push @field_defs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
                    '(' . join( ', ', @fields ) . ')';
            }

            elsif ( $index_type eq NORMAL ) {
                $index_name = mk_name( 
                    $table_name, $index_name || ++$idx_name_default
                );
                push @index_defs, 
                    "CREATE INDEX $index_name on $table_name_ur (".
                        join( ', ', @fields ).  
                    ");"; 
            }
            else {
                warn "Unknown index type ($index_type) on table $table_name.\n"
                    if $WARN;
            }
        }

        my $create_statement;
        $create_statement  = "DROP TABLE $table_name_ur;\n" if $add_drop_table;

        if ( my @table_comments = $table->comments ) {
            for my $comment ( @table_comments ) {
                next unless $comment;
                push @field_comments, "COMMENT ON TABLE $table_name is\n  '".
                    $comment."';"
                ;
            }
        }

        $create_statement .= "CREATE TABLE $table_name_ur (\n" .
            join( ",\n", map { "  $_" } @field_defs, @constraint_defs ) .
            "\n);"
        ;

        $output .= join( "\n\n", 
            @comments,
            $create_statement, 
            @trigger_defs, 
            @index_defs, 
            @field_comments, 
            '' 
        );
    }

    if ( $WARN ) {
        if ( %truncated ) {
            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;
}

# -------------------------------------------------------------------
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;
    }

    $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 ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';

    # also trap fields that don't begin with a letter
    return $name if !$ora_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;

# -------------------------------------------------------------------
# All bad art is the result of good intentions.
# Oscar Wilde
# -------------------------------------------------------------------

=head1 NAME

SQL::Translator::Producer::Oracle - Oracle SQL producer

=head1 SYNOPSIS

  use SQL::Translator::Parser::MySQL;
  use SQL::Translator::Producer::Oracle;

  my $original_create = ""; # get this from somewhere...
  my $translator = SQL::Translator->new;

  $translator->parser("SQL::Translator::Parser::MySQL");
  $translator->producer("SQL::Translator::Producer::Oracle");

  my $new_create = $translator->translate($original_create);

=head1 DESCRIPTION

SQL::Translator::Producer::Oracle takes a parsed data structure,
created by a SQL::Translator::Parser subclass, and turns it into a
create string suitable for use with an Oracle database.

=head1 CREDITS

A hearty "thank-you" to Tim Bunce for much of the logic stolen from 
his "mysql2ora" script.

=head1 AUTHOR

Ken Y. Clark E<lt>kclark@cpan.orgE<gt>

=head1 SEE ALSO

perl(1).

=cut
Commit	Line	Data
16dc9970	1	package SQL::Translator::Producer::Oracle;
16dc9970	2
077ebf34	3	# -------------------------------------------------------------------
9fc9bfb1	4	# $Id: Oracle.pm,v 1.21 2003-08-19 14:44:00 kycl4rk Exp $
077ebf34	5	# -------------------------------------------------------------------
abfa405a	6	# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
	7	# darren chamberlain <darren@cpan.org>,
	8	# Chris Mungall <cjm@fruitfly.org>
16dc9970	9	#
077ebf34	10	# This program is free software; you can redistribute it and/or
	11	# modify it under the terms of the GNU General Public License as
	12	# published by the Free Software Foundation; version 2.
	13	#
	14	# This program is distributed in the hope that it will be useful, but
	15	# WITHOUT ANY WARRANTY; without even the implied warranty of
	16	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	# General Public License for more details.
	18	#
	19	# You should have received a copy of the GNU General Public License
	20	# along with this program; if not, write to the Free Software
	21	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	22	# 02111-1307 USA
	23	# -------------------------------------------------------------------
	24
16dc9970	25	use strict;
96844cae	26	use vars qw[ $VERSION $DEBUG $WARN ];
9fc9bfb1	27	$VERSION = sprintf "%d.%02d", q$Revision: 1.21 $ =~ /(\d+)\.(\d+)/;
d529894e	28	$DEBUG = 0 unless defined $DEBUG;
16dc9970	29
57f77285	30	use SQL::Translator::Schema::Constants;
5ee19df8	31	use SQL::Translator::Utils qw(header_comment);
5ee19df8	32
16dc9970	33	my %translate = (
d529894e	34	#
	35	# MySQL types
	36	#
16dc9970	37	bigint => 'number',
	38	double => 'number',
	39	decimal => 'number',
	40	float => 'number',
	41	int => 'number',
25966689	42	integer => 'number',
16dc9970	43	mediumint => 'number',
	44	smallint => 'number',
	45	tinyint => 'number',
16dc9970	46	char => 'char',
16dc9970	47	varchar => 'varchar2',
1f58ba76	48	tinyblob => 'blob',
	49	blob => 'blob',
	50	mediumblob => 'blob',
	51	longblob => 'blob',
9fc9bfb1	52	tinytext => 'varchar2',
9fc9bfb1	53	text => 'clob',
1f58ba76	54	longtext => 'clob',
1f58ba76	55	mediumtext => 'clob',
16dc9970	56	enum => 'varchar2',
16dc9970	57	set => 'varchar2',
16dc9970	58	date => 'date',
	59	datetime => 'date',
	60	time => 'date',
	61	timestamp => 'date',
	62	year => 'date',
d529894e	63
	64	#
	65	# PostgreSQL types
	66	#
57f77285	67	numeric => 'number',
	68	'double precision' => 'number',
	69	serial => 'number',
	70	bigserial => 'number',
	71	money => 'number',
	72	character => 'char',
	73	'character varying' => 'varchar2',
	74	bytea => 'BLOB',
	75	interval => 'number',
	76	boolean => 'number',
	77	point => 'number',
	78	line => 'number',
	79	lseg => 'number',
	80	box => 'number',
	81	path => 'number',
	82	polygon => 'number',
	83	circle => 'number',
	84	cidr => 'number',
	85	inet => 'varchar2',
	86	macaddr => 'varchar2',
	87	bit => 'number',
	88	'bit varying' => 'number',
d529894e	89	);
	90
	91	#
	92	# Oracle reserved words from:
	93	# http://technet.oracle.com/docs/products/oracle8i/doc_library/\
	94	# 817_doc/server.817/a85397/ap_keywd.htm
	95	#
96844cae	96	my %ora_reserved = map { $_, 1 } qw(
d529894e	97	ACCESS ADD ALL ALTER AND ANY AS ASC AUDIT
	98	BETWEEN BY
	99	CHAR CHECK CLUSTER COLUMN COMMENT COMPRESS CONNECT CREATE CURRENT
	100	DATE DECIMAL DEFAULT DELETE DESC DISTINCT DROP
	101	ELSE EXCLUSIVE EXISTS
	102	FILE FLOAT FOR FROM
	103	GRANT GROUP
	104	HAVING
	105	IDENTIFIED IMMEDIATE IN INCREMENT INDEX INITIAL INSERT
	106	INTEGER INTERSECT INTO IS
	107	LEVEL LIKE LOCK LONG
	108	MAXEXTENTS MINUS MLSLABEL MODE MODIFY
	109	NOAUDIT NOCOMPRESS NOT NOWAIT NULL NUMBER
	110	OF OFFLINE ON ONLINE OPTION OR ORDER
	111	PCTFREE PRIOR PRIVILEGES PUBLIC
	112	RAW RENAME RESOURCE REVOKE ROW ROWID ROWNUM ROWS
	113	SELECT SESSION SET SHARE SIZE SMALLINT START
	114	SUCCESSFUL SYNONYM SYSDATE
	115	TABLE THEN TO TRIGGER
	116	UID UNION UNIQUE UPDATE USER
	117	VALIDATE VALUES VARCHAR VARCHAR2 VIEW
	118	WHENEVER WHERE WITH
16dc9970	119	);
16dc9970	120
96844cae	121	my $max_id_length = 30;
96844cae	122	my %used_identifiers = ();
d529894e	123	my %global_names;
	124	my %unreserve;
	125	my %truncated;
16dc9970	126
96844cae	127	# -------------------------------------------------------------------
077ebf34	128	sub produce {
a1d94525	129	my $translator = shift;
	130	$DEBUG = $translator->debug;
	131	$WARN = $translator->show_warnings;
	132	my $no_comments = $translator->no_comments;
	133	my $add_drop_table = $translator->add_drop_table;
	134	my $schema = $translator->schema;
d529894e	135	my $output;
44fcd0b5	136
5ee19df8	137	$output .= header_comment unless ($no_comments);
077ebf34	138
d529894e	139	if ( $translator->parser_type =~ /mysql/i ) {
	140	$output .=
	141	"-- We assume that default NLS_DATE_FORMAT has been changed\n".
	142	"-- but we set it here anyway to be self-consistent.\n".
	143	"ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD HH24:MI:SS';\n\n";
	144	}
16dc9970	145
	146	#
	147	# Print create for each table
	148	#
57f77285	149	for my $table ( $schema->get_tables ) {
57f77285	150	my $table_name = $table->name or next;
44fcd0b5	151	$table_name = mk_name( $table_name, '', undef, 1 );
57f77285	152	my $table_name_ur = unreserve($table_name) or next;
16dc9970	153
57f77285	154	my ( @comments, @field_defs, @trigger_defs, @constraint_defs );
16dc9970	155
44fcd0b5	156	push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;
16dc9970	157
f6195129	158	my ( %field_name_scope, @field_comments );
57f77285	159	for my $field ( $table->get_fields ) {
16dc9970	160	#
	161	# Field name
	162	#
44fcd0b5	163	my $field_name = mk_name(
57f77285	164	$field->name, '', \%field_name_scope, 1
44fcd0b5	165	);
44fcd0b5	166	my $field_name_ur = unreserve( $field_name, $table_name );
57f77285	167	my $field_def = $field_name_ur;
16dc9970	168
	169	#
	170	# Datatype
	171	#
44fcd0b5	172	my $check;
57f77285	173	my $data_type = lc $field->data_type;
	174	my @size = $field->size;
	175	my %extra = $field->extra;
	176	my $list = $extra{'list'} \|\| [];
77d74ea6	177	# \todo deal with embedded quotes
e6f063bd	178	my $commalist = join( ', ', map { qq['$_'] } @$list );
44fcd0b5	179
44fcd0b5	180	if ( $data_type eq 'enum' ) {
1f58ba76	181	$check = "CHECK ($field_name_ur IN ($commalist))";
57f77285	182	$data_type = 'varchar2';
44fcd0b5	183	}
	184	elsif ( $data_type eq 'set' ) {
	185	# XXX add a CHECK constraint maybe
	186	# (trickier and slower, than enum :)
57f77285	187	$data_type = 'varchar2';
44fcd0b5	188	}
	189	else {
	190	$data_type = defined $translate{ $data_type } ?
	191	$translate{ $data_type } :
	192	die "Unknown datatype: $data_type\n";
44fcd0b5	193	}
1f58ba76	194
e6f063bd	195	#
	196	# Fixes ORA-02329: column of datatype LOB cannot be
	197	# unique or a primary key
	198	#
1f58ba76	199	if ( $data_type eq 'clob' && $field->is_primary_key ) {
1f58ba76	200	$data_type = 'varchar2';
9fc9bfb1	201	$size[0] = 4000;
e6f063bd	202	warn "CLOB cannot be a primary key, changing to VARCHAR2\n"
e6f063bd	203	if $WARN;
1f58ba76	204	}
1f58ba76	205
9fc9bfb1	206	#
1f58ba76	207	# Fixes ORA-00907: missing right parenthesis
9fc9bfb1	208	#
9fc9bfb1	209	if ( $data_type =~ /(date\|clob)/i ) {
1f58ba76	210	undef @size;
1f58ba76	211	}
16dc9970	212
57f77285	213	$field_def .= " $data_type";
	214	if ( defined $size[0] && $size[0] > 0 ) {
	215	$field_def .= '(' . join( ', ', @size ) . ')';
	216	}
1f58ba76	217
16dc9970	218	#
	219	# Default value
	220	#
57f77285	221	my $default = $field->default_value;
	222	if ( defined $default ) {
	223	$field_def .= sprintf(
16dc9970	224	' DEFAULT %s',
57f77285	225	$default =~ m/null/i ? 'NULL' : "'$default'"
16dc9970	226	);
	227	}
	228
	229	#
	230	# Not null constraint
	231	#
57f77285	232	unless ( $field->is_nullable ) {
44fcd0b5	233	my $constraint_name = mk_name($field_name_ur, 'nn');
57f77285	234	$field_def .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
16dc9970	235	}
16dc9970	236
57f77285	237	$field_def .= " $check" if $check;
44fcd0b5	238
16dc9970	239	#
	240	# Auto_increment
	241	#
57f77285	242	if ( $field->is_auto_increment ) {
44fcd0b5	243	my $base_name = $table_name . "_". $field_name;
	244	my $seq_name = mk_name( $base_name, 'sq' );
	245	my $trigger_name = mk_name( $base_name, 'ai' );
16dc9970	246
57f77285	247	push @trigger_defs,
44fcd0b5	248	"CREATE SEQUENCE $seq_name;\n" .
d529894e	249	"CREATE OR REPLACE TRIGGER $trigger_name\n" .
d529894e	250	"BEFORE INSERT ON $table_name\n" .
44fcd0b5	251	"FOR EACH ROW WHEN (\n" .
	252	" new.$field_name_ur IS NULL".
	253	" OR new.$field_name_ur = 0\n".
	254	")\n".
d529894e	255	"BEGIN\n" .
44fcd0b5	256	" SELECT $seq_name.nextval\n" .
57f77285	257	" INTO :new." . $field->name."\n" .
16dc9970	258	" FROM dual;\n" .
44fcd0b5	259	"END;\n/";
16dc9970	260	;
	261	}
	262
57f77285	263	if ( lc $field->data_type eq 'timestamp' ) {
44fcd0b5	264	my $base_name = $table_name . "_". $field_name_ur;
96844cae	265	my $trig_name = mk_name( $base_name, 'ts' );
57f77285	266	push @trigger_defs,
44fcd0b5	267	"CREATE OR REPLACE TRIGGER $trig_name\n".
44fcd0b5	268	"BEFORE INSERT OR UPDATE ON $table_name_ur\n".
b6ab0fe7	269	"FOR EACH ROW WHEN (new.$field_name_ur IS NULL)\n".
44fcd0b5	270	"BEGIN \n".
b6ab0fe7	271	" SELECT sysdate INTO :new.$field_name_ur FROM dual;\n".
44fcd0b5	272	"END;\n/";
	273	}
	274
57f77285	275	push @field_defs, $field_def;
f6195129	276
	277	if ( my $comment = $field->comments ) {
	278	push @field_comments,
	279	"COMMENT ON COLUMN $table_name.$field_name_ur is\n '".
	280	$comment."';";
	281	}
57f77285	282	}
	283
	284	#
	285	# Table constraints
	286	#
	287	my $constraint_name_default;
	288	for my $c ( $table->get_constraints ) {
	289	my $name = $c->name \|\| '';
	290	my @fields = map { unreserve( $_, $table_name ) } $c->fields;
	291	my @rfields = map { unreserve( $_, $table_name ) }
	292	$c->reference_fields;
	293	next unless @fields;
	294
	295	if ( $c->type eq PRIMARY_KEY ) {
	296	$name \|\|= mk_name( $table_name, 'pk' );
	297	push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ".
	298	'(' . join( ', ', @fields ) . ')';
	299	}
	300	elsif ( $c->type eq UNIQUE ) {
	301	$name \|\|= mk_name( $table_name, ++$constraint_name_default );
	302	push @constraint_defs, "CONSTRAINT $name UNIQUE " .
	303	'(' . join( ', ', @fields ) . ')';
	304	}
	305	elsif ( $c->type eq FOREIGN_KEY ) {
	306	$name \|\|= mk_name( $table_name, ++$constraint_name_default );
cd617ba8	307	my $def = "CONSTRAINT $name FOREIGN KEY ";
	308
	309	if ( @fields ) {
	310	$def .= join( ', ', @fields );
	311	}
	312
	313	$def .= ' REFERENCES ' . $c->reference_table;
57f77285	314
	315	if ( @rfields ) {
	316	$def .= ' (' . join( ', ', @rfields ) . ')';
	317	}
	318
	319	if ( $c->match_type ) {
	320	$def .= ' MATCH ' .
	321	( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
	322	}
	323
	324	if ( $c->on_delete ) {
	325	$def .= ' ON DELETE '.join( ' ', $c->on_delete );
	326	}
	327
	328	if ( $c->on_update ) {
	329	$def .= ' ON UPDATE '.join( ' ', $c->on_update );
	330	}
	331
	332	push @constraint_defs, $def;
	333	}
16dc9970	334	}
	335
	336	#
	337	# Index Declarations
	338	#
57f77285	339	my @index_defs = ();
44fcd0b5	340	my $idx_name_default;
57f77285	341	for my $index ( $table->get_indices ) {
	342	my $index_name = $index->name \|\| '';
	343	my $index_type = $index->type \|\| NORMAL;
44fcd0b5	344	my @fields = map { unreserve( $_, $table_name ) }
57f77285	345	$index->fields;
44fcd0b5	346	next unless @fields;
16dc9970	347
57f77285	348	if ( $index_type eq PRIMARY_KEY ) {
44fcd0b5	349	$index_name = mk_name( $table_name, 'pk' );
57f77285	350	push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
16dc9970	351	'(' . join( ', ', @fields ) . ')';
16dc9970	352	}
57f77285	353	elsif ( $index_type eq UNIQUE ) {
44fcd0b5	354	$index_name = mk_name(
	355	$table_name, $index_name \|\| ++$idx_name_default
	356	);
57f77285	357	push @field_defs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
16dc9970	358	'(' . join( ', ', @fields ) . ')';
	359	}
	360
57f77285	361	elsif ( $index_type eq NORMAL ) {
44fcd0b5	362	$index_name = mk_name(
	363	$table_name, $index_name \|\| ++$idx_name_default
	364	);
57f77285	365	push @index_defs,
da8e499e	366	"CREATE INDEX $index_name on $table_name_ur (".
	367	join( ', ', @fields ).
	368	");";
16dc9970	369	}
16dc9970	370	else {
96844cae	371	warn "Unknown index type ($index_type) on table $table_name.\n"
96844cae	372	if $WARN;
16dc9970	373	}
	374	}
	375
96844cae	376	my $create_statement;
96844cae	377	$create_statement = "DROP TABLE $table_name_ur;\n" if $add_drop_table;
9fc9bfb1	378
	379	if ( my @table_comments = $table->comments ) {
	380	for my $comment ( @table_comments ) {
	381	next unless $comment;
	382	push @field_comments, "COMMENT ON TABLE $table_name is\n '".
	383	$comment."';"
	384	;
	385	}
	386	}
	387
	388	$create_statement .= "CREATE TABLE $table_name_ur (\n" .
57f77285	389	join( ",\n", map { " $_" } @field_defs, @constraint_defs ) .
44fcd0b5	390	"\n);"
16dc9970	391	;
	392
	393	$output .= join( "\n\n",
	394	@comments,
	395	$create_statement,
57f77285	396	@trigger_defs,
57f77285	397	@index_defs,
f6195129	398	@field_comments,
16dc9970	399	''
	400	);
	401	}
	402
96844cae	403	if ( $WARN ) {
	404	if ( %truncated ) {
	405	warn "Truncated " . keys( %truncated ) . " names:\n";
	406	warn "\t" . join( "\n\t", sort keys %truncated ) . "\n";
	407	}
	408
	409	if ( %unreserve ) {
	410	warn "Encounted " . keys( %unreserve ) .
	411	" unsafe names in schema (reserved or invalid):\n";
	412	warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n";
	413	}
	414	}
	415
d529894e	416	return $output;
16dc9970	417	}
16dc9970	418
d529894e	419	# -------------------------------------------------------------------
d529894e	420	sub mk_name {
57f77285	421	my $basename = shift \|\| '';
	422	my $type = shift \|\| '';
	423	my $scope = shift \|\| '';
	424	my $critical = shift \|\| '';
d529894e	425	my $basename_orig = $basename;
f5087552	426	my $max_name = $type
	427	? $max_id_length - (length($type) + 1)
	428	: $max_id_length;
96844cae	429	$basename = substr( $basename, 0, $max_name )
96844cae	430	if length( $basename ) > $max_name;
d529894e	431	my $name = $type ? "${type}_$basename" : $basename;
	432
	433	if ( $basename ne $basename_orig and $critical ) {
	434	my $show_type = $type ? "+'$type'" : "";
	435	warn "Truncating '$basename_orig'$show_type to $max_id_length ",
96844cae	436	"character limit to make '$name'\n" if $WARN;
96844cae	437	$truncated{ $basename_orig } = $name;
d529894e	438	}
	439
	440	$scope \|\|= \%global_names;
96844cae	441	if ( my $prev = $scope->{ $name } ) {
	442	my $name_orig = $name;
	443	$name .= sprintf( "%02d", ++$prev );
	444	substr($name, $max_id_length - 3) = "00"
	445	if length( $name ) > $max_id_length;
	446
	447	warn "The name '$name_orig' has been changed to ",
	448	"'$name' to make it unique.\n" if $WARN;
	449
	450	$scope->{ $name_orig }++;
	451	}
	452
	453	$scope->{ $name }++;
d529894e	454	return $name;
	455	}
	456
	457	# -------------------------------------------------------------------
	458	sub unreserve {
57f77285	459	my $name = shift \|\| '';
	460	my $schema_obj_name = shift \|\| '';
	461
96844cae	462	my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
d529894e	463
d529894e	464	# also trap fields that don't begin with a letter
57f77285	465	return $name if !$ora_reserved{ uc $name } && $name =~ /^[a-z]/i;
d529894e	466
	467	if ( $schema_obj_name ) {
	468	++$unreserve{"$schema_obj_name.$name"};
	469	}
	470	else {
	471	++$unreserve{"$name (table name)"};
	472	}
	473
	474	my $unreserve = sprintf '%s_', $name;
	475	return $unreserve.$suffix;
	476	}
	477
16dc9970	478	1;
16dc9970	479
d529894e	480	# -------------------------------------------------------------------
16dc9970	481	# All bad art is the result of good intentions.
16dc9970	482	# Oscar Wilde
d529894e	483	# -------------------------------------------------------------------
16dc9970	484
	485	=head1 NAME
	486
	487	SQL::Translator::Producer::Oracle - Oracle SQL producer
	488
	489	=head1 SYNOPSIS
	490
077ebf34	491	use SQL::Translator::Parser::MySQL;
16dc9970	492	use SQL::Translator::Producer::Oracle;
16dc9970	493
077ebf34	494	my $original_create = ""; # get this from somewhere...
	495	my $translator = SQL::Translator->new;
	496
	497	$translator->parser("SQL::Translator::Parser::MySQL");
	498	$translator->producer("SQL::Translator::Producer::Oracle");
	499
	500	my $new_create = $translator->translate($original_create);
	501
16dc9970	502	=head1 DESCRIPTION
16dc9970	503
077ebf34	504	SQL::Translator::Producer::Oracle takes a parsed data structure,
	505	created by a SQL::Translator::Parser subclass, and turns it into a
	506	create string suitable for use with an Oracle database.
16dc9970	507
d529894e	508	=head1 CREDITS
	509
	510	A hearty "thank-you" to Tim Bunce for much of the logic stolen from
	511	his "mysql2ora" script.
16dc9970	512
	513	=head1 AUTHOR
	514
d529894e	515	Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
16dc9970	516
	517	=head1 SEE ALSO
	518
	519	perl(1).
	520
	521	=cut