package SQL::Translator::Producer::Oracle;
# -------------------------------------------------------------------
-# $Id: Oracle.pm,v 1.6 2002-11-26 03:59:58 kycl4rk Exp $
+# $Id: Oracle.pm,v 1.34 2005-08-10 16:33:39 duality72 Exp $
# -------------------------------------------------------------------
-# Copyright (C) 2002 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>
+# 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
# 02111-1307 USA
# -------------------------------------------------------------------
+=head1 NAME
+
+SQL::Translator::Producer::Oracle - Oracle SQL producer
+
+=head1 SYNOPSIS
+
+ use SQL::Translator;
+
+ my $t = SQL::Translator->new( parser => '...', producer => 'Oracle' );
+ print $translator->translate( $file );
+
+=head1 DESCRIPTION
+
+Creates an SQL DDL suitable for Oracle.
+
+=cut
+
use strict;
use vars qw[ $VERSION $DEBUG $WARN ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.34 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Utils qw(header_comment);
+
my %translate = (
#
# MySQL types
decimal => 'number',
float => 'number',
int => 'number',
+ integer => 'number',
mediumint => 'number',
smallint => 'number',
tinyint => 'number',
char => 'char',
varchar => 'varchar2',
- tinyblob => 'CLOB',
- blob => 'CLOB',
- mediumblob => 'CLOB',
- longblob => 'CLOB',
- longtext => 'long',
- mediumtext => 'long',
- text => 'long',
- tinytext => 'long',
+ tinyblob => 'blob',
+ blob => 'blob',
+ mediumblob => 'blob',
+ longblob => 'blob',
+ tinytext => 'varchar2',
+ text => 'clob',
+ longtext => 'clob',
+ mediumtext => 'clob',
enum => 'varchar2',
set => 'varchar2',
date => 'date',
#
# PostgreSQL types
#
- smallint => '',
- integer => '',
- bigint => '',
- decimal => '',
- numeric => '',
- real => '',
- 'double precision' => '',
- serial => '',
- bigserial => '',
- money => '',
- character => '',
- 'character varying' => '',
- bytea => '',
- interval => '',
- boolean => '',
- point => '',
- line => '',
- lseg => '',
- box => '',
- path => '',
- polygon => '',
- circle => '',
- cidr => '',
- inet => '',
- macaddr => '',
- bit => '',
- 'bit varying' => '',
+ 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 types
+ #
+ number => 'number',
+ varchar2 => 'varchar2',
+ long => 'clob',
);
#
# -------------------------------------------------------------------
sub produce {
- my ( $translator, $data ) = @_;
- $DEBUG = $translator->debug;
- $WARN = $translator->show_warnings;
- my $no_comments = $translator->no_comments;
- my $add_drop_table = $translator->add_drop_table;
+ 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;
- unless ( $no_comments ) {
- $output .= sprintf
- "--\n-- Created by %s\n-- Created on %s\n--\n\n",
- __PACKAGE__, scalar localtime;
- }
+ $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".
+ "-- We assume that default NLS_DATE_FORMAT has been changed\n".
+ "-- but we set it here anyway to be self-consistent.\n"
+ unless $no_comments;
+
+ $output .=
"ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD HH24:MI:SS';\n\n";
}
#
# Print create for each table
#
- for my $table (
- map { $_->[1] }
- sort { $a->[0] <=> $b->[0] }
- map { [ $_->{'order'}, $_ ] }
- values %{ $data }
- ) {
- my $table_name = $table->{'table_name'};
+ 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);
+ my $table_name_ur = unreserve($table_name) or next;
- my ( @comments, @field_decs, @trigger_decs );
+ my ( @comments, @field_defs, @trigger_defs, @constraint_defs );
push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;
- my %field_name_scope;
- for my $field (
- map { $_->[1] }
- sort { $a->[0] <=> $b->[0] }
- map { [ $_->{'order'}, $_ ] }
- values %{ $table->{'fields'} }
- ) {
+ 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
+ $field->name, '', \%field_name_scope, 1
);
my $field_name_ur = unreserve( $field_name, $table_name );
- my $field_str = $field_name_ur;
+ my $field_def = $field_name_ur;
+ $field->name( $field_name_ur );
#
# Datatype
#
my $check;
- my $data_type = lc $field->{'data_type'};
- my $list = $field->{'list'} || [];
- my $commalist = join ",", @$list;
+ 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' ) {
- my $len = 0;
- $len = ($len < length($_)) ? length($_) : $len for (@$list);
- $check = "CHECK ($field_name IN ($commalist))";
- $field_str .= " varchar2($len)";
+ $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 :)
- my $len = length $commalist;
- $field_str .= " varchar2($len) /* set $commalist */ ";
+ $data_type = 'varchar2';
}
else {
$data_type = defined $translate{ $data_type } ?
$translate{ $data_type } :
- die "Unknown datatype: $data_type\n";
- $field_str .= ' '.$data_type;
- $field_str .= '('.join(',', @{ $field->{'size'} }).')'
- if @{ $field->{'size'} || [] };
+ $data_type;
+ $data_type ||= 'varchar2';
+ }
+
+ #
+ # 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;
+ }
+
+ if ( $data_type eq 'clob' && $field->is_unique ) {
+ $data_type = 'varchar2';
+ $size[0] = 4000;
+ warn "CLOB cannot be a unique 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
#
- if ( $field->{'default'} ) {
- $field_str .= sprintf(
- ' DEFAULT %s',
- $field->{'default'} =~ m/null/i ? 'NULL' :
- "'".$field->{'default'}."'"
- );
+ my $default = $field->default_value;
+ if ( defined $default ) {
+ #
+ # Wherein we try to catch a string being used as
+ # a default value for a numerical field. If "true/false,"
+ # then sub "1/0," otherwise just test the truthity of the
+ # argument and use that (naive?).
+ #
+ if (
+ $data_type =~ /^number$/i &&
+ $default !~ /^-?\d+$/ &&
+ $default !~ m/null/i
+ ) {
+ if ( $default =~ /^true$/i ) {
+ $default = "'1'";
+ }
+ elsif ( $default =~ /^false$/i ) {
+ $default = "'0'";
+ }
+ else {
+ $default = $default ? "'1'" : "'0'";
+ }
+ }
+ elsif (
+ $data_type =~ /date/ && (
+ $default eq 'current_timestamp'
+ ||
+ $default eq 'now()'
+ )
+ ) {
+ $default = 'SYSDATE';
+ }
+ else {
+ $default = $default =~ m/null/i ? 'NULL' : "'$default'"
+ }
+
+ $field_def .= " DEFAULT $default",
}
#
# Not null constraint
#
- unless ( $field->{'null'} ) {
- my $constraint_name = mk_name($field_name_ur, 'nn');
- $field_str .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
+ unless ( $field->is_nullable ) {
+ $field_def .= ' NOT NULL';
}
- $field_str .= " $check" if $check;
+ $field_def .= " $check" if $check;
#
# Auto_increment
#
- if ( $field->{'is_auto_inc'} ) {
- my $base_name = $table_name . "_". $field_name;
+ if ( $field->is_auto_increment ) {
+ my $base_name = $table_name_ur . "_". $field_name;
my $seq_name = mk_name( $base_name, 'sq' );
my $trigger_name = mk_name( $base_name, 'ai' );
- push @trigger_decs,
+ push @trigger_defs,
"CREATE SEQUENCE $seq_name;\n" .
"CREATE OR REPLACE TRIGGER $trigger_name\n" .
- "BEFORE INSERT ON $table_name\n" .
+ "BEFORE INSERT ON $table_name_ur\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" .
+ " INTO :new." . $field->name."\n" .
" FROM dual;\n" .
"END;\n/";
;
}
- if ( uc $field->{'data_type'} eq 'TIMESTAMP' ) {
- my $base_name = $table_name . "_". $field_name_ur;
+ if ( lc $field->data_type eq 'timestamp' ) {
+ my $base_name = $table_name_ur . "_". $field_name_ur;
my $trig_name = mk_name( $base_name, 'ts' );
- push @trigger_decs,
+ 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".
+ "FOR EACH ROW WHEN (new.$field_name_ur IS NULL)\n".
"BEGIN \n".
- " SELECT sysdate INTO :new.$field_name_ur} FROM dual;\n".
+ " SELECT sysdate INTO :new.$field_name_ur FROM dual;\n".
"END;\n/";
}
- push @field_decs, $field_str;
+ push @field_defs, $field_def;
+
+ if ( my $comment = $field->comments ) {
+ $comment =~ s/'/''/g;
+ push @field_comments,
+ "COMMENT ON COLUMN $table_name_ur.$field_name_ur is\n '" .
+ $comment . "';" unless $no_comments;
+ }
+ }
+
+ #
+ # Table options
+ #
+ my @table_options;
+ for my $opt ( $table->options ) {
+ if ( ref $opt eq 'HASH' ) {
+ my ( $key, $value ) = each %$opt;
+ if ( ref $value eq 'ARRAY' ) {
+ push @table_options, "$key\n(\n". join ("\n",
+ map { " $_->[0]\t$_->[1]" }
+ map { [ each %$_ ] }
+ @$value
+ )."\n)";
+ }
+ elsif ( !defined $value ) {
+ push @table_options, $key;
+ }
+ else {
+ push @table_options, "$key $value";
+ }
+ }
+ }
+
+ #
+ # Table constraints
+ #
+ 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 if !@fields && $c->type ne CHECK_C;
+
+ if ( $c->type eq PRIMARY_KEY ) {
+ #$name ||= mk_name( $table_name, 'pk' );
+ push @constraint_defs, ($name ? "CONSTRAINT $name " : '') .
+ 'PRIMARY KEY (' . join( ', ', @fields ) . ')';
+ }
+ elsif ( $c->type eq UNIQUE ) {
+ # Don't create UNIQUE constraints identical to the primary key
+ if ( my $pk = $table->primary_key ) {
+ my $u_fields = join(":", @fields);
+ my $pk_fields = join(":", $pk->fields);
+ next if $u_fields eq $pk_fields;
+ }
+
+ $name ||= mk_name( $name || $table_name, 'u' );
+
+ for my $f ( $c->fields ) {
+ my $field_def = $table->get_field( $f ) or next;
+ my $dtype = $translate{ $field_def->data_type } or next;
+ if ( $WARN && $dtype =~ /clob/i ) {
+ warn "Oracle will not allow UNIQUE constraints on " .
+ "CLOB field '" . $field_def->table->name . '.' .
+ $field_def->name . ".'\n"
+ }
+ }
+
+ push @constraint_defs, "CONSTRAINT $name UNIQUE " .
+ '(' . join( ', ', @fields ) . ')';
+ }
+ elsif ( $c->type eq CHECK_C ) {
+ $name ||= mk_name( $name || $table_name, 'ck' );
+ my $expression = $c->expression || '';
+ push @constraint_defs, "CONSTRAINT $name CHECK ($expression)";
+ }
+ elsif ( $c->type eq FOREIGN_KEY ) {
+ $name ||= mk_name( join('_', $table_name, $c->fields), 'fk' );
+ my $def = "CONSTRAINT $name FOREIGN KEY ";
+
+ if ( @fields ) {
+ $def .= '(' . join( ', ', @fields ) . ')';
+ }
+
+ my $ref_table = unreserve($c->reference_table);
+
+ $def .= " REFERENCES $ref_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_decs = ();
- my $idx_name_default;
- for my $index ( @{ $table->{'indices'} } ) {
- my $index_name = $index->{'name'} || '';
- my $index_type = $index->{'type'} || 'normal';
+ my @index_defs = ();
+ 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'} };
+ $index->fields;
next unless @fields;
- if ( $index_type eq 'primary_key' ) {
- $index_name = mk_name( $table_name, 'pk' );
- push @field_decs, '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_decs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
+ if ( $index_type eq PRIMARY_KEY ) {
+ $index_name = $index_name ? mk_name( $index_name )
+ : mk_name( $table_name, 'pk' );
+ push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
'(' . join( ', ', @fields ) . ')';
}
-
- elsif ( $index_type eq 'normal' ) {
- $index_name = mk_name(
- $table_name, $index_name || ++$idx_name_default
- );
- push @index_decs, "CREATE INDEX $index_name on $table_name (".
- join( ', ', @fields ). ");";
+ elsif ( $index_type eq NORMAL ) {
+ $index_name = $index_name ? mk_name( $index_name )
+ : mk_name( $table_name, $index_name || 'i' );
+ 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"
my $create_statement;
$create_statement = "DROP TABLE $table_name_ur;\n" if $add_drop_table;
- $create_statement .= "CREATE TABLE $table_name_ur (\n".
- join( ",\n", map { " $_" } @field_decs ).
- "\n);"
+
+ if ( my @table_comments = $table->comments ) {
+ for my $comment ( @table_comments ) {
+ next unless $comment;
+ $comment =~ s/'/''/g;
+ push @field_comments, "COMMENT ON TABLE $table_name_ur is\n '".
+ $comment . "';" unless $no_comments
+ ;
+ }
+ }
+
+ my $table_options = @table_options
+ ? "\n".join("\n", @table_options) : '';
+ $create_statement .= "CREATE TABLE $table_name_ur (\n" .
+ join( ",\n", map { " $_" } @field_defs, @constraint_defs ) .
+ "\n)$table_options;"
;
$output .= join( "\n\n",
@comments,
$create_statement,
- @trigger_decs,
- @index_decs,
+ @trigger_defs,
+ @index_defs,
+ @field_comments,
''
);
}
# -------------------------------------------------------------------
sub mk_name {
- my ($basename, $type, $scope, $critical) = @_;
+ my $basename = shift || '';
+ my $type = shift || '';
+ $type = '' if $type =~ /^\d/;
+ my $scope = shift || '';
+ my $critical = shift || '';
my $basename_orig = $basename;
- my $max_name = $max_id_length - (length($type) + 1);
+ 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;
$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;
+ substr($name, $max_id_length - 2) = ""
+ if length( $name ) >= $max_id_length - 1;
+ $name .= sprintf( "%02d", $prev++ );
warn "The name '$name_orig' has been changed to ",
"'$name' to make it unique.\n" if $WARN;
# -------------------------------------------------------------------
sub unreserve {
- my ( $name, $schema_obj_name ) = @_;
+ 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 $_[0] if !$ora_reserved{ uc $name } && $name =~ /^[a-z]/i;
+ return $name if !$ora_reserved{ uc $name } && $name =~ /^[a-z]/i;
if ( $schema_obj_name ) {
++$unreserve{"$schema_obj_name.$name"};
# 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.
+=pod
=head1 CREDITS
-A hearty "thank-you" to Tim Bunce for much of the logic stolen from
-his "mysql2ora" script.
+Mad props to Tim Bunce for much of the logic stolen from his "mysql2ora"
+script.
=head1 AUTHOR
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
=head1 SEE ALSO
-perl(1).
+SQL::Translator, DDL::Oracle, mysql2ora.
=cut
projects / dbsrgits/SQL-Translator.git / blobdiff