X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FProducer%2FOracle.pm;h=d3f7a12856e1c738ed35b0d6cc268b3a8a60beea;hb=c0ec0e22d3f0e3852c00daac5ef5763010b410c3;hp=f3664f9a3c7f17b088bb5f14ca6d385a975e1ddc;hpb=abfa405acf15e963e5b5760fa74464d91ca25f7e;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Producer/Oracle.pm b/lib/SQL/Translator/Producer/Oracle.pm index f3664f9..d3f7a12 100644 --- a/lib/SQL/Translator/Producer/Oracle.pm +++ b/lib/SQL/Translator/Producer/Oracle.pm @@ -1,54 +1,125 @@ package SQL::Translator::Producer::Oracle; -# ------------------------------------------------------------------- -# $Id: Oracle.pm,v 1.9 2003-01-27 17:04:46 dlc Exp $ -# ------------------------------------------------------------------- -# Copyright (C) 2003 Ken Y. Clark , -# darren chamberlain , -# Chris Mungall -# -# 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 + +=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. + +=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. + +=item quote_field_names + +Controls whether quotes are being used around column names in generated DDL. + +=item quote_table_names + +Controls whether quotes are being used around table, sequence and trigger names in +generated DDL. + +=back + +=head1 NOTES + +=head2 Autoincremental primary keys + +This producer uses sequences and triggers to autoincrement primary key +columns, if necessary. SQLPlus and DBI expect a slightly different syntax +of CREATE TRIGGER statement. You might have noticed that this +producer returns a scalar containing all statements concatenated by +newlines or an array of single statements depending on the context +(scalar, array) it has been called in. + +SQLPlus expects following trigger syntax: + + CREATE OR REPLACE TRIGGER ai_person_id + BEFORE INSERT ON person + FOR EACH ROW WHEN ( + new.id IS NULL OR new.id = 0 + ) + BEGIN + SELECT sq_person_id.nextval + INTO :new.id + FROM dual; + END; + / + +Whereas if you want to create the same trigger using L, you need +to omit the last slash: + + my $dbh = DBI->connect('dbi:Oracle:mysid', 'scott', 'tiger'); + $dbh->do(" + CREATE OR REPLACE TRIGGER ai_person_id + BEFORE INSERT ON person + FOR EACH ROW WHEN ( + new.id IS NULL OR new.id = 0 + ) + BEGIN + SELECT sq_person_id.nextval + INTO :new.id + FROM dual; + END; + "); + +If you call this producer in array context, we expect you want to process +the returned array of statements using L like +L does. + +To get this working we removed the slash in those statements in version +0.09002 of L when called in array context. In scalar +context the slash will be still there to ensure compatibility with SQLPlus. + +=cut use strict; -use vars qw[ $VERSION $DEBUG $WARN ]; -$VERSION = sprintf "%d.%02d", q$Revision: 1.9 $ =~ /(\d+)\.(\d+)/; +use warnings; +our ( $DEBUG, $WARN ); +our $VERSION = '1.59'; $DEBUG = 0 unless defined $DEBUG; +use base 'SQL::Translator::Producer'; +use SQL::Translator::Schema::Constants; +use SQL::Translator::Utils qw(header_comment); + my %translate = ( # # MySQL types # bigint => 'number', - double => 'number', + double => 'float', decimal => 'number', - float => 'number', + float => 'float', 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', @@ -60,248 +131,327 @@ my %translate = ( # # 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', ); # -# Oracle reserved words from: -# http://technet.oracle.com/docs/products/oracle8i/doc_library/\ -# 817_doc/server.817/a85397/ap_keywd.htm +# Oracle 8/9 max size of data types from: +# http://www.ss64.com/orasyntax/datatypes.html # -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 +my %max_size = ( + char => 2000, + float => 126, + 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; -my %unreserve; my %truncated; -# ------------------------------------------------------------------- +# Quote used to escape table, field, sequence and trigger names +my $quote_char = '"'; + 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 $output; - - unless ( $no_comments ) { - $output .= sprintf - "--\n-- Created by %s\n-- Created on %s\n--\n\n", - __PACKAGE__, scalar localtime; - } + my $translator = shift; + $DEBUG = $translator->debug; + $WARN = $translator->show_warnings || 0; + my $no_comments = $translator->no_comments; + my $add_drop_table = $translator->add_drop_table; + my $schema = $translator->schema; + 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 = 1 if $translator->quote_table_names; + my $qf = 1 if $translator->quote_field_names; 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". + $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 .= "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'}; - $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_ur\n--" unless $no_comments; - - my %field_name_scope; - for my $field ( - map { $_->[1] } - sort { $a->[0] <=> $b->[0] } - map { [ $_->{'order'}, $_ ] } - values %{ $table->{'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_str = $field_name_ur; - - # - # Datatype - # - 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'} || [] }; + for my $table ( $schema->get_tables ) { + 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, + quote_table_names => $qt, + quote_field_names => $qf, } + ); + 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 - # - if ( defined $field->{'default'} ) { - $field_str .= sprintf( - ' DEFAULT %s', - $field->{'default'} =~ m/null/i ? 'NULL' : - "'".$field->{'default'}."'" - ); + my (@view_defs); + foreach my $view ( $schema->get_views ) { + my ( $view_def ) = create_view( + $view, + { + add_drop_view => $add_drop_table, + quote_table_names => $qt, } + ); + push @view_defs, @$view_def; + } - # - # Not null constraint - # - unless ( $field->{'null'} ) { - my $constraint_name = mk_name($field_name_ur, 'nn'); - $field_str .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL'; - } + if (wantarray) { + return defined $create ? $create : (), @table_defs, @view_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs; + } + else { + $create .= join (";\n\n", @table_defs, @view_defs, @fk_defs, @index_defs, @constraint_defs); + $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 but a "/" instead + $create .= "$_/\n\n" + for @trigger_defs; + return $create; + } +} - $field_str .= " $check" if $check; - - # - # Auto_increment - # - if ( $field->{'is_auto_inc'} ) { - 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 $seq_name;\n" . - "CREATE OR REPLACE TRIGGER $trigger_name\n" . - "BEFORE INSERT ON $table_name\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 $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 $item = ''; + my $drop; + my (@create, @field_defs, @constraint_defs, @fk_defs, @trigger_defs); + + push @create, "--\n-- Table: $table_name\n--" unless $options->{no_comments}; + push @create, qq[DROP TABLE $table_name_q CASCADE CONSTRAINTS] if $options->{add_drop_table}; + + 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; + } + + # + # 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"; + } } + } - 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/"; + # + # Table constraints + # + for my $c ( $table->get_constraints ) { + my $name = $c->name || ''; + my @fields = map { quote($_,$qf) } $c->fields; + 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 ) . ')'; + } + 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 = mk_name( "${table_name}_$name", 'u' ) unless $name =~ /^$table_name/; + } + else { + $name = mk_name( $table_name, 'u' ); + } + + $name = quote($name, $qf); + + for my $f ( $c->fields ) { + my $field_def = $table->get_field( $f ) 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 . '.' . + $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' ); + $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); + my $on_delete = uc ($c->on_delete || ''); + + my $def = "CONSTRAINT $name FOREIGN KEY "; - push @field_decs, $field_str; + if ( @fields ) { + $def .= '(' . join( ', ', @fields ) . ')'; + } + + my $ref_table = quote($c->reference_table,$qt); + + $def .= " REFERENCES $ref_table"; + + if ( @rfields ) { + $def .= ' (' . join( ', ', @rfields ) . ')'; + } + + if ( $c->match_type ) { + $def .= ' MATCH ' . + ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL'; + } + + 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 '. $c->on_update; + #} + + push @fk_defs, sprintf("ALTER TABLE %s ADD %s", $table_name_q, $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 @fields = map { unreserve( $_, $table_name ) } - @{ $index->{'fields'} }; + my @index_defs = (); + for my $index ( $table->get_indices ) { + my $index_name = $index->name || ''; + my $index_type = $index->type || NORMAL; + my @fields = map { quote($_, $qf) } $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 ) . ')'; + 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"; + } + } } - elsif ( $index_type eq 'unique' ) { - $index_name = mk_name( - $table_name, $index_name || ++$idx_name_default - ); - push @field_decs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' . + 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' ); + $index_name = quote($index_name, $qf); + 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_ur (". - join( ', ', @fields ). - ");"; + elsif ( $index_type eq NORMAL ) { + $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 $table_name_q (". + join( ', ', @fields ). + ")$index_options"; + } + elsif ( $index_type eq UNIQUE ) { + $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_q (". + join( ', ', @fields ). + ")$index_options"; } else { warn "Unknown index type ($index_type) on table $table_name.\n" @@ -309,46 +459,302 @@ sub produce { } } - 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);" - ; - - $output .= join( "\n\n", - @comments, - $create_statement, - @trigger_decs, - @index_decs, - '' - ); - } + if ( my @table_comments = $table->comments ) { + for my $comment ( @table_comments ) { + next unless $comment; + $comment = __PACKAGE__->_quote_string($comment); + push @field_comments, "COMMENT ON TABLE $table_name_q is\n $comment" + unless $options->{no_comments}; + } + } + + my $table_options = @table_options + ? "\n".join("\n", @table_options) : ''; + push @create, "CREATE TABLE $table_name_q (\n" . + join( ",\n", map { " $_" } @field_defs, + ($options->{delay_constraints} ? () : @constraint_defs) ) . + "\n)$table_options"; + + @constraint_defs = map { "ALTER TABLE $table_name_q ADD $_" } + @constraint_defs; 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 \@create, \@fk_defs, \@trigger_defs, \@index_defs, ($options->{delay_constraints} ? \@constraint_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, {}); + + # 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 = 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 = quote($new_field->table->name,$qt); + + my $out = sprintf('ALTER TABLE %s ADD ( %s )', + $table_name, + join('', @$field_defs)); + return $out; +} + +sub create_field { + my ($field, $options, $field_name_scope) = @_; + my $qf = $options->{quote_field_names}; + my $qt = $options->{quote_table_names}; + + my (@create, @field_defs, @trigger_defs, @field_comments); + + my $table_name = $field->table->name; + my $table_name_q = quote($table_name, $qt); + + # + # Field name + # + my $field_name = mk_name( + $field->name, '', $field_name_scope, 1 + ); + my $field_name_q = quote($field_name, $qf); + my $field_def = quote($field_name, $qf); + $field->name( $field_name ); + + # + # Datatype + # + my $check; + my $data_type = lc $field->data_type; + my @size = $field->size; + my %extra = $field->extra; + my $list = $extra{'list'} || []; + my $commalist = join( ', ', map { __PACKAGE__->_quote_string($_) } @$list ); + + if ( $data_type eq 'enum' ) { + $check = "CHECK ($field_name_q 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 { + 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++ ) { + 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; } } - return $output; + # + # 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; + } + + # + # 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 ) . ')'; + } + + # + # 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' : __PACKAGE__->_quote_string($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 . "_". $field_name; + my $seq_name = quote(mk_name( $base_name, 'sq' ),$qt); + my $trigger_name = quote(mk_name( $base_name, 'ai' ),$qt); + + push @create, qq[DROP SEQUENCE $seq_name] if $options->{add_drop_table}; + push @create, "CREATE SEQUENCE $seq_name"; + my $trigger = + "CREATE OR REPLACE TRIGGER $trigger_name\n" . + "BEFORE INSERT ON $table_name_q\n" . + "FOR EACH ROW WHEN (\n" . + " new.$field_name_q IS NULL". + " OR new.$field_name_q = 0\n". + ")\n". + "BEGIN\n" . + " SELECT $seq_name.nextval\n" . + " 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 = + "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". + " SELECT sysdate INTO :new.$field_name_q FROM dual;\n". + "END;\n"; + + push @trigger_defs, $trigger; + } + + push @field_defs, $field_def; + + if ( my $comment = $field->comments ) { + $comment =~ __PACKAGE__->_quote_string($comment); + push @field_comments, + "COMMENT ON COLUMN $table_name_q.$field_name_q is\n $comment;" + unless $options->{no_comments}; + } + + return \@create, \@field_defs, \@trigger_defs, \@field_comments; + +} + + +sub create_view { + my ($view, $options) = @_; + 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}; + + push @create, sprintf("CREATE VIEW %s AS\n%s", + $view_name, + $view->sql); + + return \@create; } -# ------------------------------------------------------------------- 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 = $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; @@ -362,9 +768,9 @@ sub mk_name { $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; @@ -376,66 +782,36 @@ sub mk_name { return $name; } -# ------------------------------------------------------------------- -sub unreserve { - 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; - - if ( $schema_obj_name ) { - ++$unreserve{"$schema_obj_name.$name"}; - } - else { - ++$unreserve{"$name (table name)"}; - } +1; - my $unreserve = sprintf '%s_', $name; - return $unreserve.$suffix; +sub quote { + my ($name, $q) = @_; + return $name unless $q && $name; + $name =~ s/\Q$quote_char/$quote_char$quote_char/g; + return "$quote_char$name$quote_char"; } -1; # ------------------------------------------------------------------- # All bad art is the result of good intentions. # 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 +=head1 AUTHORS -Ken Y. Clark Ekclark@cpan.orgE +Ken Youens-Clark Ekclark@cpan.orgE, +Alexander Hartmaier Eabraxxa@cpan.orgE, +Fabien Wernli Efaxmodem@cpan.orgE. =head1 SEE ALSO -perl(1). +SQL::Translator, DDL::Oracle, mysql2ora. =cut