package SQL::Translator::Producer::Oracle;
# -------------------------------------------------------------------
-# $Id: Oracle.pm,v 1.33 2005-05-25 15:17:49 mwz444 Exp $
+# $Id: Oracle.pm,v 1.34 2005-08-10 16:33:39 duality72 Exp $
# -------------------------------------------------------------------
# Copyright (C) 2002-4 SQLFairy Authors
#
Creates an SQL DDL suitable for Oracle.
+=head1 producer_args
+
+=over
+
+=item delay_constraints
+
+This option remove the primary key and other key constraints from the
+CREATE TABLE statement and adds ALTER TABLEs at the end with it.
+
+=back
+
=cut
use strict;
use vars qw[ $VERSION $DEBUG $WARN ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.33 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.34 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
use SQL::Translator::Schema::Constants;
WHENEVER WHERE WITH
);
+#
+# Oracle 8/9 max size of data types from:
+# http://www.ss64.com/orasyntax/datatypes.html
+#
+my %max_size = (
+ char => 2000,
+ nchar => 2000,
+ nvarchar2 => 4000,
+ number => [ 38, 127 ],
+ raw => 2000,
+ varchar => 4000, # only synonym for varchar2
+ varchar2 => 4000,
+);
+
my $max_id_length = 30;
my %used_identifiers = ();
my %global_names;
sub produce {
my $translator = shift;
$DEBUG = $translator->debug;
- $WARN = $translator->show_warnings;
+ $WARN = $translator->show_warnings || 0;
my $no_comments = $translator->no_comments;
my $add_drop_table = $translator->add_drop_table;
my $schema = $translator->schema;
- my $output;
+ my $delay_constraints = $translator->producer_args->{delay_constraints};
+ my ($output, $create, @table_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs);
- $output .= header_comment unless ($no_comments);
+ $create .= header_comment unless ($no_comments);
if ( $translator->parser_type =~ /mysql/i ) {
- $output .=
+ $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;
- $output .=
+ $create .=
"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;
- $field->name( $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 } :
- $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 ) . ')';
+ my ( $table_def, $fk_def, $trigger_def, $index_def, $constraint_def) = create_table(
+ $table,
+ {
+ add_drop_table => $add_drop_table,
+ show_warnings => $WARN,
+ no_comments => $no_comments,
+ delay_constraints => $delay_constraints
}
+ );
+ push @table_defs, @$table_def;
+ push @fk_defs, @$fk_def;
+ push @trigger_defs, @$trigger_def;
+ push @index_defs, @$index_def;
+ push @constraint_defs, @$constraint_def;
+ }
- #
- # Default value
- #
- 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",
- }
+ my (@view_defs);
+ foreach my $view ( $schema->get_views ) {
+ push @view_defs, create_view($view);
+ }
- #
- # Not null constraint
- #
- unless ( $field->is_nullable ) {
- $field_def .= ' NOT NULL';
- }
+ return wantarray ? (defined $create ? $create : (), @table_defs, @view_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs) : $create . join ('', map { $_ ? "$_;\n\n" : () } @table_defs, @view_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs);
+}
- $field_def .= " $check" if $check;
-
- #
- # Auto_increment
- #
- 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_defs,
- "CREATE SEQUENCE $seq_name;\n" .
- "CREATE OR REPLACE TRIGGER $trigger_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" .
- " FROM dual;\n" .
- "END;\n/";
- ;
- }
+sub create_table {
+ my ($table, $options) = @_;
+ my $table_name = $table->name;
+
+ my $item = '';
+ my $drop;
+ my (@create, @field_defs, @constraint_defs, @fk_defs, @trigger_defs);
- 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_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/";
- }
+ my $table_name_ur = unreserve($table_name) or next;
- push @field_defs, $field_def;
+ push @create, "--\n-- Table: $table_name_ur\n--" unless $options->{no_comments};
+ push @create, qq[DROP TABLE $table_name_ur CASCADE CONSTRAINTS] if $options->{add_drop_table};
- 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;
- }
+ my ( %field_name_scope, @field_comments );
+ for my $field ( $table->get_fields ) {
+ my ($field_create, $field_defs, $trigger_defs, $field_comments) =
+ create_field($field, $options, \%field_name_scope);
+ push @create, @$field_create if ref $field_create;
+ push @field_defs, @$field_defs if ref $field_defs;
+ push @trigger_defs, @$trigger_defs if ref $trigger_defs;
+ push @field_comments, @$field_comments if ref $field_comments;
}
#
next if !@fields && $c->type ne CHECK_C;
if ( $c->type eq PRIMARY_KEY ) {
- $name ||= mk_name( $table_name, 'pk' );
- push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ".
- '(' . join( ', ', @fields ) . ')';
+ # create a name if delay_constraints
+ $name ||= mk_name( $table_name, 'pk' )
+ if $options->{delay_constraints};
+ push @constraint_defs, ($name ? "CONSTRAINT $name " : '') .
+ 'PRIMARY KEY (' . join( ', ', @fields ) . ')';
}
elsif ( $c->type eq UNIQUE ) {
- $name = mk_name( $name || $table_name, 'u' );
+ # 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;
'(' . join( ', ', @fields ) . ')';
}
elsif ( $c->type eq CHECK_C ) {
- $name = mk_name( $name || $table_name, 'ck' );
+ $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' );
+ $name = mk_name( join('_', $table_name, $c->fields). '_fk' );
my $def = "CONSTRAINT $name FOREIGN KEY ";
if ( @fields ) {
$def .= ' ON DELETE '.join( ' ', $c->on_delete );
}
- if ( $c->on_update ) {
- $def .= ' ON UPDATE '.join( ' ', $c->on_update );
- }
+ # disabled by plu 2007-12-29 - doesn't exist for oracle
+ #if ( $c->on_update ) {
+ # $def .= ' ON UPDATE '.join( ' ', $c->on_update );
+ #}
- push @constraint_defs, $def;
+ push @fk_defs, sprintf("ALTER TABLE %s ADD %s", $table_name_ur, $def);
}
}
$index->fields;
next unless @fields;
+ my @index_options;
+ for my $opt ( $index->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 @index_options, $key;
+ }
+ else {
+ push @index_options, "$key $value";
+ }
+ }
+ }
+ my $index_options = @index_options
+ ? "\n".join("\n", @index_options) : '';
+
if ( $index_type eq PRIMARY_KEY ) {
$index_name = $index_name ? mk_name( $index_name )
: mk_name( $table_name, 'pk' );
push @index_defs,
"CREATE INDEX $index_name on $table_name_ur (".
join( ', ', @fields ).
- ");";
+ ")$index_options";
+ }
+ elsif ( $index_type eq UNIQUE ) {
+ $index_name = $index_name ? mk_name( $index_name )
+ : mk_name( $table_name, $index_name || 'i' );
+ push @index_defs,
+ "CREATE UNIQUE INDEX $index_name on $table_name_ur (".
+ join( ', ', @fields ).
+ ")$index_options";
}
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;
-
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
+ $comment . "'" unless $options->{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;"
- ;
+ push @create, "CREATE TABLE $table_name_ur (\n" .
+ join( ",\n", map { " $_" } @field_defs,
+ ($options->{delay_constraints} ? () : @constraint_defs) ) .
+ "\n)$table_options";
- $output .= join( "\n\n",
- @comments,
- $create_statement,
- @trigger_defs,
- @index_defs,
- @field_comments,
- ''
- );
- }
+ @constraint_defs = map { 'ALTER TABLE '.$table_name_ur.' ADD '.$_ }
+ @constraint_defs;
if ( $WARN ) {
if ( %truncated ) {
}
}
- return $output;
+ return \@create, \@fk_defs, \@trigger_defs, \@index_defs, ($options->{delay_constraints} ? \@constraint_defs : []);
+}
+
+sub alter_field {
+ my ($from_field, $to_field, $options) = @_;
+
+ my ($field_create, $field_defs, $trigger_defs, $field_comments) =
+ create_field($to_field, $options, {});
+
+ # Fix ORA-01442
+ if ($to_field->is_nullable && !$from_field->is_nullable) {
+ die 'Cannot remove NOT NULL from table field';
+ } elsif (!$from_field->is_nullable && !$to_field->is_nullable) {
+ @$field_defs = map { s/ NOT NULL//; $_} @$field_defs;
+ }
+
+ my $table_name = $to_field->table->name;
+ my $table_name_ur = unreserve( $table_name );
+
+ return 'ALTER TABLE '.$table_name_ur.' MODIFY ( '.join('', @$field_defs).' )';
+}
+
+sub add_field {
+ my ($new_field, $options) = @_;
+
+ my ($field_create, $field_defs, $trigger_defs, $field_comments) =
+ create_field($new_field, $options, {});
+
+ my $table_name = $new_field->table->name;
+ my $table_name_ur = unreserve( $table_name );
+
+ my $out = sprintf('ALTER TABLE %s ADD ( %s )',
+ $table_name_ur,
+ join('', @$field_defs));
+ return $out;
+}
+
+sub create_field {
+ my ($field, $options, $field_name_scope) = @_;
+
+ my (@create, @field_defs, @trigger_defs, @field_comments);
+
+ my $table_name = $field->table->name;
+ my $table_name_ur = unreserve( $table_name );
+
+ #
+ # 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;
+ $field->name( $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 } :
+ $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++ ) {
+ my $max =
+ ref( $max_size{$data_type} ) eq 'ARRAY'
+ ? $max_size{$data_type}->[$i]
+ : $max_size{$data_type};
+ $size[$i] = $max if $size[$i] > $max;
+ }
+ }
+
+ #
+ # 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
+ #
+ 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 (ref $default and defined $$default) {
+ $default = $$default;
+ } elsif (ref $default) {
+ $default = 'NULL';
+ } elsif (
+ $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->is_nullable ) {
+ $field_def .= ' NOT NULL';
+ }
+
+ $field_def .= " $check" if $check;
+
+ #
+ # Auto_increment
+ #
+ 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 @create, qq[DROP SEQUENCE $seq_name] if $options->{add_drop_table};
+ push @create, "CREATE SEQUENCE $seq_name";
+ push @trigger_defs,
+ "CREATE OR REPLACE TRIGGER $trigger_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" .
+ " FROM dual;\n" .
+ "END;\n/";
+ ;
+ }
+
+ 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_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 ) {
+ $comment =~ s/'/''/g;
+ push @field_comments,
+ "COMMENT ON COLUMN $table_name_ur.$field_name_ur is\n '" .
+ $comment . "';" unless $options->{no_comments};
+ }
+
+ return \@create, \@field_defs, \@trigger_defs, \@field_comments;
+
+}
+
+
+sub create_view {
+ my ($view) = @_;
+
+ my $out = sprintf("CREATE VIEW %s AS\n%s;",
+ $view->name,
+ $view->sql);
+
+ return $out;
}
# -------------------------------------------------------------------