package SQL::Translator::Producer::Oracle;
# -------------------------------------------------------------------
-# $Id: Oracle.pm,v 1.4 2002-11-22 03:03:40 kycl4rk Exp $
+# $Id: Oracle.pm,v 1.10 2003-04-25 11:47:25 dlc Exp $
# -------------------------------------------------------------------
-# Copyright (C) 2002 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>
+# 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
# 02111-1307 USA
# -------------------------------------------------------------------
-
use strict;
-use vars qw[ $VERSION $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.4 $ =~ /(\d+)\.(\d+)/;
+use vars qw[ $VERSION $DEBUG $WARN ];
+$VERSION = sprintf "%d.%02d", q$Revision: 1.10 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
-my $max_id_length = 30;
-my %used_identifiers = ();
+use SQL::Translator::Utils qw(header_comment);
my %translate = (
#
# http://technet.oracle.com/docs/products/oracle8i/doc_library/\
# 817_doc/server.817/a85397/ap_keywd.htm
#
-my @ora_reserved = qw(
+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
WHENEVER WHERE WITH
);
-my %ora_reserved = map { $_ => 1 } @ora_reserved;
+my $max_id_length = 30;
+my %used_identifiers = ();
my %global_names;
my %unreserve;
my %truncated;
+# -------------------------------------------------------------------
sub produce {
my ( $translator, $data ) = @_;
$DEBUG = $translator->debug;
+ $WARN = $translator->show_warnings;
my $no_comments = $translator->no_comments;
-
- #print "got ", scalar keys %$data, " tables:\n";
- #print join(', ', keys %$data), "\n";
- #print Dumper( $data );
-
+ my $add_drop_table = $translator->add_drop_table;
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 .=
#
# Print create for each table
#
- my ( $index_i, $trigger_i ) = ( 1, 1 );
for my $table (
- # sort keys %$data
map { $_->[1] }
sort { $a->[0] <=> $b->[0] }
map { [ $_->{'order'}, $_ ] }
values %{ $data }
) {
- my $table_name = $table->{'table_name'};
-# check_identifier( $table_name );
- $table_name = mk_name( $table_name, '', undef, 1 );
-# my $tablename_ur = unreserve($table_name);
+ my $table_name = $table->{'table_name'};
+ $table_name = mk_name( $table_name, '', undef, 1 );
+ my $table_name_ur = unreserve($table_name);
my ( @comments, @field_decs, @trigger_decs );
- push @comments, "--\n-- Table: $table_name\n--" unless $no_comments;
+ 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] }
#
# Field name
#
- my $field_str = check_identifier( $field->{'name'} );
+ 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;
#
# Datatype
#
- my $data_type = $field->{'data_type'};
- $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'} || [] };
+ my $check;
+ my $data_type = lc $field->{'data_type'};
+ my $list = $field->{'list'} || [];
+ my $commalist = join ",", @$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)";
+ }
+ 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 */ ";
+ }
+ 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'} || [] };
+ }
#
# Default value
#
- if ( $field->{'default'} ) {
- # next if $field->{'default'} eq 'NULL';
+ if ( defined $field->{'default'} ) {
$field_str .= sprintf(
' DEFAULT %s',
$field->{'default'} =~ m/null/i ? 'NULL' :
# Not null constraint
#
unless ( $field->{'null'} ) {
- my $constraint_name = make_identifier($field->{'name'}, '_nn');
+ my $constraint_name = mk_name($field_name_ur, 'nn');
$field_str .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
}
+ $field_str .= " $check" if $check;
+
#
# Auto_increment
#
if ( $field->{'is_auto_inc'} ) {
- my $trigger_no = $trigger_i++;
- my $trigger_sequence =
- join( '_', 'seq' , $field->{'name'}, $trigger_no );
- my $trigger_name =
- join( '_', 'autoinc', $field->{'name'}, $trigger_no );
+ 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_decs,
- "CREATE SEQUENCE $trigger_sequence;\n" .
+ "CREATE SEQUENCE $seq_name;\n" .
"CREATE OR REPLACE TRIGGER $trigger_name\n" .
"BEFORE INSERT ON $table_name\n" .
- "FOR EACH ROW WHEN (new.".$field->{'name'}." is null)\n".
+ "FOR EACH ROW WHEN (\n" .
+ " new.$field_name_ur IS NULL".
+ " OR new.$field_name_ur = 0\n".
+ ")\n".
"BEGIN\n" .
- " SELECT $trigger_sequence.nextval\n" .
+ " SELECT $seq_name.nextval\n" .
" INTO :new." . $field->{'name'}."\n" .
" FROM dual;\n" .
- " END $trigger_name;/"
+ "END;\n/";
;
}
+ if ( uc $field->{'data_type'} eq 'TIMESTAMP' ) {
+ my $base_name = $table_name . "_". $field_name_ur;
+ my $trig_name = mk_name( $base_name, 'ts' );
+ push @trigger_decs,
+ "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_decs, $field_str;
}
# 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 @fields = @{ $index->{'fields'} } or next;
+ my @fields = map { unreserve( $_, $table_name ) }
+ @{ $index->{'fields'} };
+ next unless @fields;
if ( $index_type eq 'primary_key' ) {
- if ( !$index_name ) {
- $index_name = make_identifier( $table_name, 'i_', '_pk' );
- }
- elsif ( $index_name !~ m/^i_/ ) {
- $index_name = make_identifier( $table_name, 'i_' );
- }
- elsif ( $index_name !~ m/_pk$/ ) {
- $index_name = make_identifier( $table_name, '_pk' );
- }
- else {
- $index_name = make_identifier( $index_name );
- }
-
- push @field_decs, 'CONSTRAINT ' . $index_name . ' PRIMARY KEY ' .
+ $index_name = mk_name( $table_name, 'pk' );
+ push @field_decs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
'(' . join( ', ', @fields ) . ')';
}
-
elsif ( $index_type eq 'unique' ) {
- if ( !$index_name ) {
- $index_name = make_identifier( join( '_', @fields ), 'u_' );
- }
- elsif ( $index_name !~ m/^u_/ ) {
- $index_name = make_identifier( $index_name, 'u_' );
- }
- else {
- $index_name = make_identifier( $index_name );
- }
-
+ $index_name = mk_name(
+ $table_name, $index_name || ++$idx_name_default
+ );
push @field_decs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
'(' . join( ', ', @fields ) . ')';
}
elsif ( $index_type eq 'normal' ) {
- if ( !$index_name ) {
- $index_name =
- make_identifier($table_name, 'i_', '_'.$index_i++ );
- }
- elsif ( $index_name !~ m/^i_/ ) {
- $index_name = make_identifier( $index_name, 'i_' );
- }
- else {
- $index_name = make_identifier( $index_name );
- }
-
- push @index_decs, "CREATE INDEX $index_name on $table_name (".
- join( ', ', @{ $index->{'fields'} } ).
- ");"
- ;
+ $index_name = mk_name(
+ $table_name, $index_name || ++$idx_name_default
+ );
+ push @index_decs,
+ "CREATE INDEX $index_name on $table_name_ur (".
+ join( ', ', @fields ).
+ ");";
}
-
else {
- warn "On table $table_name, unknown index type: $index_type\n";
+ warn "Unknown index type ($index_type) on table $table_name.\n"
+ if $WARN;
}
}
- my $create_statement = "CREATE 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);"
+ "\n);"
;
$output .= join( "\n\n",
);
}
- return $output;
-}
-
-#
-# Used to make index names
-#
-sub make_identifier {
- my ( $identifier, @mutations ) = @_;
- my $length_of_mutations;
- for my $mutation ( @mutations ) {
- $length_of_mutations += length( $mutation );
- }
-
- if (
- length( $identifier ) + $length_of_mutations >
- $max_id_length
- ) {
- $identifier = substr(
- $identifier,
- 0,
- $max_id_length - $length_of_mutations
- );
- }
-
- for my $mutation ( @mutations ) {
- if ( $mutation =~ m/.+_$/ ) {
- $identifier = $mutation.$identifier;
- }
- elsif ( $mutation =~ m/^_.+/ ) {
- $identifier = $identifier.$mutation;
+ if ( $WARN ) {
+ if ( %truncated ) {
+ warn "Truncated " . keys( %truncated ) . " names:\n";
+ warn "\t" . join( "\n\t", sort keys %truncated ) . "\n";
}
- }
- if ( $used_identifiers{ $identifier } ) {
- my $index = 1;
- if ( $identifier =~ m/_(\d+)$/ ) {
- $index = $1;
- $identifier = substr(
- $identifier,
- 0,
- length( $identifier ) - ( length( $index ) + 1 )
- );
+ if ( %unreserve ) {
+ warn "Encounted " . keys( %unreserve ) .
+ " unsafe names in schema (reserved or invalid):\n";
+ warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n";
}
- $index++;
- return make_identifier( $identifier, '_'.$index );
}
- $used_identifiers{ $identifier } = 1;
-
- return $identifier;
-}
-
-#
-# Checks to see if an identifier is not too long
-#
-sub check_identifier {
- my $identifier = shift;
- die "Identifier '$identifier' is too long, unrecoverable error.\n"
- if length( $identifier ) > $max_id_length;
- return $identifier;
+ return $output;
}
# -------------------------------------------------------------------
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 $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 $DEBUG;
- $truncated{$basename_orig} = $name;
+ "character limit to make '$name'\n" if $WARN;
+ $truncated{ $basename_orig } = $name;
}
$scope ||= \%global_names;
- return $name unless $scope->{$name}++;
- my $name_orig = $name;
- $name .= "02";
- substr($name, $max_id_length - 3) = "00" if length($name) > $max_id_length;
- ++$name while $scope->{$name};
- warn "The name '$name_orig' has been changed to ",
- "'$name' to make it unique\n" if $DEBUG;
+ 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 : '';
+ my ( $name, $schema_obj_name ) = @_;
+ 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 $_[0] if !$ora_reserved{ uc $name } && $name =~ /^[a-z]/i;
if ( $schema_obj_name ) {
++$unreserve{"$schema_obj_name.$name"};
created by a SQL::Translator::Parser subclass, and turns it into a
create string suitable for use with an Oracle database.
-=head1 BUGS
-
-Problem with SQL::Translator::Producer::Oracle: it is keeping track
-of the last sequence number used, so as not to duplicate them, which
-is reasonable. However on runs past the first, it seems to be
-creating multiple constraint lines, that look like:
-
- CONSTRAINT i_sessions_pk_2 PRIMARY KEY (id),
- CONSTRAINT i_sessions_pk_3 PRIMARY KEY (id)
-
-This is a very preliminary finding, and needs to be investigated more
-thoroughly, of course.
-
=head1 CREDITS
A hearty "thank-you" to Tim Bunce for much of the logic stolen from
projects / dbsrgits/SQL-Translator.git / blobdiff