package SQL::Translator::Producer::Oracle;
# -------------------------------------------------------------------
-# $Id: Oracle.pm,v 1.5 2002-11-23 01:26:56 kycl4rk Exp $
+# $Id: Oracle.pm,v 1.19 2003-08-17 07:51:33 rossta 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
# -------------------------------------------------------------------
use strict;
-use vars qw[ $VERSION $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
+use vars qw[ $VERSION $DEBUG $WARN ];
+$VERSION = sprintf "%d.%02d", q$Revision: 1.19 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
-my $max_id_length = 30;
-my %used_identifiers = ();
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Utils qw(header_comment);
my %translate = (
#
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',
+ longtext => 'clob',
+ mediumtext => 'clob',
+ text => 'clob',
+ tinytext => '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',
);
#
# 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;
- my $no_comments = $translator->no_comments;
+ 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 .=
#
# 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;
#
# 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 "', '", @$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'} || [] };
+ }
+
+ # 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;
+ }
+
+ # Fixes ORA-00907: missing right parenthesis
+ if ($data_type eq 'date') {
+ 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(
+ my $default = $field->default_value;
+ if ( defined $default ) {
+ $field_def .= sprintf(
' DEFAULT %s',
- $field->{'default'} =~ m/null/i ? 'NULL' :
- "'".$field->{'default'}."'"
+ $default =~ m/null/i ? 'NULL' : "'$default'"
);
}
#
# Not null constraint
#
- unless ( $field->{'null'} ) {
+ unless ( $field->is_nullable ) {
my $constraint_name = mk_name($field_name_ur, 'nn');
- $field_str .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
+ $field_def .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
}
- $field_str .= " $check" if $check;
+ $field_def .= " $check" if $check;
#
# Auto_increment
#
- if ( $field->{'is_auto_inc'} ) {
+ 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_decs,
+ push @trigger_defs,
"CREATE SEQUENCE $seq_name;\n" .
"CREATE OR REPLACE TRIGGER $trigger_name\n" .
"BEFORE INSERT ON $table_name\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' ) {
+ 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_decs,
+ 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".
+ "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 ) {
+ 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_decs = ();
+ my @index_defs = ();
my $idx_name_default;
- for my $index ( @{ $table->{'indices'} } ) {
- my $index_name = $index->{'name'} || '';
- my $index_type = $index->{'type'} || 'normal';
+ 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' ) {
+ if ( $index_type eq PRIMARY_KEY ) {
$index_name = mk_name( $table_name, 'pk' );
- push @field_decs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
+ push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
'(' . join( ', ', @fields ) . ')';
}
- elsif ( $index_type eq 'unique' ) {
+ elsif ( $index_type eq UNIQUE ) {
$index_name = mk_name(
$table_name, $index_name || ++$idx_name_default
);
- push @field_decs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
+ push @field_defs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
'(' . join( ', ', @fields ) . ')';
}
- elsif ( $index_type eq 'normal' ) {
+ 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 ). ");";
+ 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";
+ warn "Unknown index type ($index_type) on table $table_name.\n"
+ if $WARN;
}
}
- my $create_statement = "CREATE TABLE $table_name_ur (\n".
- join( ",\n", map { " $_" } @field_decs ).
+ my $create_statement;
+ $create_statement = "DROP TABLE $table_name_ur;\n" if $add_drop_table;
+ $create_statement .=
+ join( ",\n", map { "-- $_" } $table->comments ) .
+ "CREATE TABLE $table_name_ur (\n" .
+ join( ",\n", map { " $_" } @field_defs, @constraint_defs ) .
"\n);"
;
$output .= join( "\n\n",
@comments,
$create_statement,
- @trigger_decs,
- @index_decs,
+ @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, $type, $scope, $critical) = @_;
+ my $basename = shift || '';
+ my $type = shift || '';
+ my $scope = shift || '';
+ my $critical = shift || '';
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 = 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"};
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
perl(1).
=cut
-
-__END__
-!!!!!Code Graveyard!!!!!
-#
-# 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 ( $used_identifiers{ $identifier } ) {
- my $index = 1;
- if ( $identifier =~ m/_(\d+)$/ ) {
- $index = $1;
- $identifier = substr(
- $identifier,
- 0,
- length( $identifier ) - ( length( $index ) + 1 )
- );
- }
- $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;
-}
-
projects / dbsrgits/SQL-Translator.git / blobdiff