package SQL::Translator::Producer::Oracle;
-# -------------------------------------------------------------------
-# 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
-# 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
-# -------------------------------------------------------------------
-
=head1 NAME
SQL::Translator::Producer::Oracle - Oracle SQL producer
0.09002 of L<SQL::Translator> when called in array context. In scalar
context the slash will be still there to ensure compatibility with SQLPlus.
-=head2 Quotes
-
-This producer will generate
-DDL with or without quotes if L<quote_table_names> and/or
-L<quote_field_names> are true.
-
-Quotes will be forced and names capitalised if C<quote_table_names==0> and/or C<quote_field_names==0>
-for the following reserved keywords:
-
- 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
-
=cut
use strict;
-use vars qw[ $VERSION $DEBUG $WARN ];
-$VERSION = '1.59';
+use warnings;
+our ( $DEBUG, $WARN );
+our $VERSION = '1.59';
$DEBUG = 0 unless defined $DEBUG;
use SQL::Translator::Schema::Constants;
# MySQL types
#
bigint => 'number',
- double => 'number',
+ double => 'float',
decimal => 'number',
- float => 'number',
+ float => 'float',
int => 'number',
integer => 'number',
mediumint => '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
-);
-
-#
# Oracle 8/9 max size of data types from:
# http://www.ss64.com/orasyntax/datatypes.html
#
my %max_size = (
char => 2000,
+ float => 126,
nchar => 2000,
nvarchar2 => 4000,
number => [ 38, 127 ],
# Quote used to escape table, field, sequence and trigger names
my $quote_char = '"';
-my $name_sep = '.';
-# -------------------------------------------------------------------
sub produce {
my $translator = shift;
$DEBUG = $translator->debug;
my $no_comments = $translator->no_comments;
my $add_drop_table = $translator->add_drop_table;
my $schema = $translator->schema;
- $quote_char = $translator->producer_args->{'quote_char'} ||= '"';
- $name_sep = $translator->producer_args->{'name_sep'} ||= '.';
+ my $oracle_version = $translator->producer_args->{oracle_version} || 0;
my $delay_constraints = $translator->producer_args->{delay_constraints};
my ($output, $create, @table_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs);
$create .= header_comment unless ($no_comments);
- my $qt = $quote_char if $translator->quote_table_names;
- my $qf = $quote_char if $translator->quote_field_names;
+ my $qt = 1 if $translator->quote_table_names;
+ my $qf = 1 if $translator->quote_field_names;
if ( $translator->parser_type =~ /mysql/i ) {
- $create .=
+ $create .=
"-- 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;
- $create .=
+ $create .=
"ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD HH24:MI:SS';\n\n";
}
- for my $table ( $schema->get_tables ) {
+ for my $table ( $schema->get_tables ) {
my ( $table_def, $fk_def, $trigger_def, $index_def, $constraint_def ) = create_table(
$table,
{
show_warnings => $WARN,
no_comments => $no_comments,
delay_constraints => $delay_constraints,
- quote_table_names => $qt,
- quote_field_names => $qf,
+ quote_table_names => $qt,
+ quote_field_names => $qf,
}
);
push @table_defs, @$table_def;
$view,
{
add_drop_view => $add_drop_table,
+ quote_table_names => $qt,
}
);
push @view_defs, @$view_def;
}
else {
$create .= join (";\n\n", @table_defs, @view_defs, @fk_defs, @index_defs, @constraint_defs);
- $create .= ";\n\n";
+ $create .= ";\n\n";
# If wantarray is not set we have to add "/" in this statement
# DBI->do() needs them omitted
- # triggers may NOT end with a semicolon
- $create .= join "/\n\n", @trigger_defs;
- # for last trigger
- $create .= "/\n\n";
+ # triggers may NOT end with a semicolon but a "/" instead
+ $create .= "$_/\n\n"
+ for @trigger_defs;
return $create;
}
}
sub create_table {
my ($table, $options) = @_;
- my $qt = $options->{quote_table_names};
- my $qf = $options->{quote_field_names};
+ my $qt = $options->{quote_table_names};
+ my $qf = $options->{quote_field_names};
my $table_name = $table->name;
- my $table_name_q = quote($table_name,$qt);
+ my $table_name_q = quote($table_name,$qt);
my $item = '';
my $drop;
my ( $key, $value ) = each %$opt;
if ( ref $value eq 'ARRAY' ) {
push @table_options, "$key\n(\n". join ("\n",
- map { " $_->[0]\t$_->[1]" }
+ map { " $_->[0]\t$_->[1]" }
map { [ each %$_ ] }
@$value
)."\n)";
for my $c ( $table->get_constraints ) {
my $name = $c->name || '';
my @fields = map { quote($_,$qf) } $c->fields;
- my @rfields = quote($c->reference_fields,$qf);
+ my @rfields = map { quote($_,$qf) } $c->reference_fields;
+
next if !@fields && $c->type ne CHECK_C;
if ( $c->type eq PRIMARY_KEY ) {
# create a name if delay_constraints
$name ||= mk_name( $table_name, 'pk' )
if $options->{delay_constraints};
+ $name = quote($name,$qf);
push @constraint_defs, ($name ? "CONSTRAINT $name " : '') .
- 'PRIMARY KEY (' . join( ', ', @fields ) . ')';
+ '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;
- }
- if ($name) {
- # Force prepend of table_name as ORACLE doesn't allow duplicate
- # CONSTRAINT names even for different tables (ORA-02264)
- $name = "${table_name}_$name" unless $name =~ /^$table_name/;
- } else {
+ # 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;
+ }
+
+ if ($name) {
+ # Force prepend of table_name as ORACLE doesn't allow duplicate
+ # CONSTRAINT names even for different tables (ORA-02264)
+ $name = mk_name( "${table_name}_$name", 'u' ) unless $name =~ /^$table_name/;
+ }
+ else {
$name = mk_name( $table_name, 'u' );
- }
- $name = quote($name, $qf);
+ }
+
+ $name = quote($name, $qf);
for my $f ( $c->fields ) {
my $field_def = $table->get_field( $f ) or next;
- my $dtype = $translate{ $field_def->data_type } or next;
+ my $dtype = $translate{ ref $field_def->data_type eq "ARRAY" ? $field_def->data_type->[0] : $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 . '.' .
}
elsif ( $c->type eq CHECK_C ) {
$name ||= mk_name( $name || $table_name, 'ck' );
+ $name = quote($name, $qf);
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' );
- $name = quote($name, $qf);
+ $name = quote($name, $qf);
+ my $on_delete = uc ($c->on_delete || '');
+
my $def = "CONSTRAINT $name FOREIGN KEY ";
if ( @fields ) {
}
if ( $c->match_type ) {
- $def .= ' MATCH ' .
+ $def .= ' MATCH ' .
( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
}
- if ( $c->on_delete ) {
- $def .= ' ON DELETE '.join( ' ', $c->on_delete );
+ if ( $on_delete && $on_delete ne "RESTRICT") {
+ $def .= ' ON DELETE '.$c->on_delete;
}
# disabled by plu 2007-12-29 - doesn't exist for oracle
#if ( $c->on_update ) {
- # $def .= ' ON UPDATE '.join( ' ', $c->on_update );
+ # $def .= ' ON UPDATE '. $c->on_update;
#}
push @fk_defs, sprintf("ALTER TABLE %s ADD %s", $table_name_q, $def);
my ( $key, $value ) = each %$opt;
if ( ref $value eq 'ARRAY' ) {
push @table_options, "$key\n(\n". join ("\n",
- map { " $_->[0]\t$_->[1]" }
+ map { " $_->[0]\t$_->[1]" }
map { [ each %$_ ] }
@$value
)."\n)";
? "\n".join("\n", @index_options) : '';
if ( $index_type eq PRIMARY_KEY ) {
- $index_name = $index_name ? mk_name( $index_name )
+ $index_name = $index_name ? mk_name( $index_name )
: mk_name( $table_name, 'pk' );
- $index_name = quote($index_name, $qf);
+ $index_name = quote($index_name, $qf);
push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
'(' . join( ', ', @fields ) . ')';
}
elsif ( $index_type eq NORMAL ) {
- $index_name = $index_name ? mk_name( $index_name )
+ $index_name = $index_name ? mk_name( $index_name )
: mk_name( $table_name, $index_name || 'i' );
- $index_name = quote($index_name, $qf);
- push @index_defs,
- "CREATE INDEX $index_name on ".quote($table_name,$qt)." (".
- join( ', ', @fields ).
+ $index_name = quote($index_name, $qf);
+ push @index_defs,
+ "CREATE INDEX $index_name on $table_name_q (".
+ join( ', ', @fields ).
")$index_options";
}
elsif ( $index_type eq UNIQUE ) {
- $index_name = $index_name ? mk_name( $index_name )
+ $index_name = $index_name ? mk_name( $index_name )
: mk_name( $table_name, $index_name || 'i' );
- $index_name = quote($index_name, $qf);
- push @index_defs,
- "CREATE UNIQUE INDEX $index_name on $table_name (".
- join( ', ', @fields ).
- ")$index_options";
+ $index_name = quote($index_name, $qf);
+ push @index_defs,
+ "CREATE UNIQUE INDEX $index_name on $table_name_q (".
+ join( ', ', @fields ).
+ ")$index_options";
}
else {
warn "Unknown index type ($index_type) on table $table_name.\n"
}
}
- my $table_options = @table_options
+ my $table_options = @table_options
? "\n".join("\n", @table_options) : '';
push @create, "CREATE TABLE $table_name_q (\n" .
join( ",\n", map { " $_" } @field_defs,
sub alter_field {
my ($from_field, $to_field, $options) = @_;
+ my $qt = $options->{quote_table_names};
my ($field_create, $field_defs, $trigger_defs, $field_comments) =
create_field($to_field, $options, {});
@$field_defs = map { s/ NOT NULL//; $_} @$field_defs;
}
- my $table_name = $to_field->table->name;
+ my $table_name = quote($to_field->table->name,$qt);
return 'ALTER TABLE '.$table_name.' MODIFY ( '.join('', @$field_defs).' )';
}
sub add_field {
my ($new_field, $options) = @_;
+ my $qt = $options->{quote_table_names};
my ($field_create, $field_defs, $trigger_defs, $field_comments) =
create_field($new_field, $options, {});
- my $table_name = $new_field->table->name;
+ my $table_name = quote($new_field->table->name,$qt);
my $out = sprintf('ALTER TABLE %s ADD ( %s )',
$table_name,
sub create_field {
my ($field, $options, $field_name_scope) = @_;
- my $qf = $options->{quote_field_names};
- my $qt = $options->{quote_table_names};
+ my $qf = $options->{quote_field_names};
+ my $qt = $options->{quote_table_names};
my (@create, @field_defs, @trigger_defs, @field_comments);
my $field_name = mk_name(
$field->name, '', $field_name_scope, 1
);
- my $field_name_q = quote($field_name, $qf);
+ my $field_name_q = quote($field_name, $qf);
my $field_def = quote($field_name, $qf);
$field->name( $field_name );
$data_type = 'varchar2';
}
elsif ( $data_type eq 'set' ) {
- # XXX add a CHECK constraint maybe
+ # XXX add a CHECK constraint maybe
# (trickier and slower, than enum :)
$data_type = 'varchar2';
}
else {
- $data_type = defined $translate{ $data_type } ?
- $translate{ $data_type } :
- $data_type;
- $data_type ||= 'varchar2';
+ if (defined $translate{ $data_type }) {
+ if (ref $translate{ $data_type } eq "ARRAY") {
+ ($data_type,$size[0]) = @{$translate{ $data_type }};
+ } else {
+ $data_type = $translate{ $data_type };
+ }
+ }
+ $data_type ||= 'varchar2';
}
-
+
# ensure size is not bigger than max size oracle allows for data type
if ( defined $max_size{$data_type} ) {
for ( my $i = 0 ; $i < scalar @size ; $i++ ) {
}
#
- # Fixes ORA-02329: column of datatype LOB cannot be
+ # Fixes ORA-02329: column of datatype LOB cannot be
# unique or a primary key
#
if ( $data_type eq 'clob' && $field->is_primary_key ) {
undef @size;
}
+ #
+ # Fixes ORA-00906: missing right parenthesis
+ # if size is 0 or undefined
+ #
+ for (qw/varchar2/) {
+ if ( $data_type =~ /^($_)$/i ) {
+ $size[0] ||= $max_size{$_};
+ }
+ }
+
$field_def .= " $data_type";
if ( defined $size[0] && $size[0] > 0 ) {
$field_def .= '(' . join( ',', @size ) . ')';
my $default = $field->default_value;
if ( defined $default ) {
#
- # Wherein we try to catch a string being used as
+ # 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?).
$default = $$default;
} elsif (ref $default) {
$default = 'NULL';
- } elsif (
- $data_type =~ /^number$/i &&
+ } elsif (
+ $data_type =~ /^number$/i &&
$default !~ /^-?\d+$/ &&
$default !~ m/null/i
) {
} else {
$default = $default ? "'1'" : "'0'";
}
- } elsif (
+ } elsif (
$data_type =~ /date/ && (
- $default eq 'current_timestamp'
+ $default eq 'current_timestamp'
||
- $default eq 'now()'
+ $default eq 'now()'
)
) {
$default = 'SYSDATE';
} else {
$default = $default =~ m/null/i ? 'NULL' : "'$default'"
- }
+ }
$field_def .= " DEFAULT $default",
}
" INTO :new." . $field_name_q."\n" .
" FROM dual;\n" .
"END;\n";
-
+
push @trigger_defs, $trigger;
}
if ( lc $field->data_type eq 'timestamp' ) {
my $base_name = $table_name . "_". $field_name;
my $trig_name = quote(mk_name( $base_name, 'ts' ), $qt);
- my $trigger =
+ my $trigger =
"CREATE OR REPLACE TRIGGER $trig_name\n".
"BEFORE INSERT OR UPDATE ON $table_name_q\n".
"FOR EACH ROW WHEN (new.$field_name_q IS NULL)\n".
- "BEGIN \n".
+ "BEGIN\n".
" SELECT sysdate INTO :new.$field_name_q FROM dual;\n".
"END;\n";
if ( my $comment = $field->comments ) {
$comment =~ s/'/''/g;
- push @field_comments,
- "COMMENT ON COLUMN $table_name.$field_name is\n '" .
+ push @field_comments,
+ "COMMENT ON COLUMN $table_name_q.$field_name_q is\n '" .
$comment . "';" unless $options->{no_comments};
}
sub create_view {
my ($view, $options) = @_;
- my $qt = $options->{quote_table_names};
- my $qf = $options->{quote_field_names};
+ my $qt = $options->{quote_table_names};
my $view_name = quote($view->name,$qt);
-
+
my @create;
push @create, qq[DROP VIEW $view_name]
if $options->{add_drop_view};
return \@create;
}
-# -------------------------------------------------------------------
sub mk_name {
- my $basename = shift || '';
- my $type = shift || '';
+ my $basename = shift || '';
+ my $type = shift || '';
$type = '' if $type =~ /^\d/;
- my $scope = shift || '';
+ my $scope = shift || '';
my $critical = shift || '';
my $basename_orig = $basename;
- my $max_name = $type
- ? $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 )
+ $basename = substr( $basename, 0, $max_name )
if length( $basename ) > $max_name;
my $name = $type ? "${type}_$basename" : $basename;
1;
-# -------------------------------------------------------------------
sub quote {
my ($name, $q) = @_;
- if ( $q ) {
- "$q$name$q";
- } elsif ($ora_reserved { uc $name }) {
- # convert to upper case to be consistent with oracle
- # when no quotes are being used
- $name = uc $name;
- "$quote_char$name$quote_char";
- } else {
- $name;
- }
+ return $name unless $q && $name;
+ $name =~ s/\Q$quote_char/$quote_char$quote_char/g;
+ return "$quote_char$name$quote_char";
}