1 package SQL::Translator::Producer::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.20 2003-08-18 15:41:53 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7 # darren chamberlain <darren@cpan.org>,
8 # Chris Mungall <cjm@fruitfly.org>
10 # This program is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU General Public License as
12 # published by the Free Software Foundation; version 2.
14 # This program is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program; if not, write to the Free Software
21 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
23 # -------------------------------------------------------------------
26 use vars qw[ $VERSION $DEBUG $WARN ];
27 $VERSION = sprintf "%d.%02d", q$Revision: 1.20 $ =~ /(\d+)\.(\d+)/;
28 $DEBUG = 0 unless defined $DEBUG;
30 use SQL::Translator::Schema::Constants;
31 use SQL::Translator::Utils qw(header_comment);
43 mediumint => 'number',
47 varchar => 'varchar2',
68 'double precision' => 'number',
70 bigserial => 'number',
73 'character varying' => 'varchar2',
86 macaddr => 'varchar2',
88 'bit varying' => 'number',
92 # Oracle reserved words from:
93 # http://technet.oracle.com/docs/products/oracle8i/doc_library/\
94 # 817_doc/server.817/a85397/ap_keywd.htm
96 my %ora_reserved = map { $_, 1 } qw(
97 ACCESS ADD ALL ALTER AND ANY AS ASC AUDIT
99 CHAR CHECK CLUSTER COLUMN COMMENT COMPRESS CONNECT CREATE CURRENT
100 DATE DECIMAL DEFAULT DELETE DESC DISTINCT DROP
101 ELSE EXCLUSIVE EXISTS
105 IDENTIFIED IMMEDIATE IN INCREMENT INDEX INITIAL INSERT
106 INTEGER INTERSECT INTO IS
108 MAXEXTENTS MINUS MLSLABEL MODE MODIFY
109 NOAUDIT NOCOMPRESS NOT NOWAIT NULL NUMBER
110 OF OFFLINE ON ONLINE OPTION OR ORDER
111 PCTFREE PRIOR PRIVILEGES PUBLIC
112 RAW RENAME RESOURCE REVOKE ROW ROWID ROWNUM ROWS
113 SELECT SESSION SET SHARE SIZE SMALLINT START
114 SUCCESSFUL SYNONYM SYSDATE
115 TABLE THEN TO TRIGGER
116 UID UNION UNIQUE UPDATE USER
117 VALIDATE VALUES VARCHAR VARCHAR2 VIEW
121 my $max_id_length = 30;
122 my %used_identifiers = ();
127 # -------------------------------------------------------------------
129 my $translator = shift;
130 $DEBUG = $translator->debug;
131 $WARN = $translator->show_warnings;
132 my $no_comments = $translator->no_comments;
133 my $add_drop_table = $translator->add_drop_table;
134 my $schema = $translator->schema;
137 $output .= header_comment unless ($no_comments);
139 if ( $translator->parser_type =~ /mysql/i ) {
141 "-- We assume that default NLS_DATE_FORMAT has been changed\n".
142 "-- but we set it here anyway to be self-consistent.\n".
143 "ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD HH24:MI:SS';\n\n";
147 # Print create for each table
149 for my $table ( $schema->get_tables ) {
150 my $table_name = $table->name or next;
151 $table_name = mk_name( $table_name, '', undef, 1 );
152 my $table_name_ur = unreserve($table_name) or next;
154 my ( @comments, @field_defs, @trigger_defs, @constraint_defs );
156 push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments;
158 my ( %field_name_scope, @field_comments );
159 for my $field ( $table->get_fields ) {
163 my $field_name = mk_name(
164 $field->name, '', \%field_name_scope, 1
166 my $field_name_ur = unreserve( $field_name, $table_name );
167 my $field_def = $field_name_ur;
173 my $data_type = lc $field->data_type;
174 my @size = $field->size;
175 my %extra = $field->extra;
176 my $list = $extra{'list'} || [];
177 # \todo deal with embedded quotes
178 my $commalist = join( ', ', map { qq['$_'] } @$list );
180 if ( $data_type eq 'enum' ) {
181 $check = "CHECK ($field_name_ur IN ($commalist))";
182 $data_type = 'varchar2';
184 elsif ( $data_type eq 'set' ) {
185 # XXX add a CHECK constraint maybe
186 # (trickier and slower, than enum :)
187 $data_type = 'varchar2';
190 $data_type = defined $translate{ $data_type } ?
191 $translate{ $data_type } :
192 die "Unknown datatype: $data_type\n";
196 # Fixes ORA-02329: column of datatype LOB cannot be
197 # unique or a primary key
199 if ( $data_type eq 'clob' && $field->is_primary_key ) {
200 $data_type = 'varchar2';
202 warn "CLOB cannot be a primary key, changing to VARCHAR2\n"
206 # Fixes ORA-00907: missing right parenthesis
207 if ($data_type eq 'date') {
211 $field_def .= " $data_type";
212 if ( defined $size[0] && $size[0] > 0 ) {
213 $field_def .= '(' . join( ', ', @size ) . ')';
219 my $default = $field->default_value;
220 if ( defined $default ) {
221 $field_def .= sprintf(
223 $default =~ m/null/i ? 'NULL' : "'$default'"
228 # Not null constraint
230 unless ( $field->is_nullable ) {
231 my $constraint_name = mk_name($field_name_ur, 'nn');
232 $field_def .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
235 $field_def .= " $check" if $check;
240 if ( $field->is_auto_increment ) {
241 my $base_name = $table_name . "_". $field_name;
242 my $seq_name = mk_name( $base_name, 'sq' );
243 my $trigger_name = mk_name( $base_name, 'ai' );
246 "CREATE SEQUENCE $seq_name;\n" .
247 "CREATE OR REPLACE TRIGGER $trigger_name\n" .
248 "BEFORE INSERT ON $table_name\n" .
249 "FOR EACH ROW WHEN (\n" .
250 " new.$field_name_ur IS NULL".
251 " OR new.$field_name_ur = 0\n".
254 " SELECT $seq_name.nextval\n" .
255 " INTO :new." . $field->name."\n" .
261 if ( lc $field->data_type eq 'timestamp' ) {
262 my $base_name = $table_name . "_". $field_name_ur;
263 my $trig_name = mk_name( $base_name, 'ts' );
265 "CREATE OR REPLACE TRIGGER $trig_name\n".
266 "BEFORE INSERT OR UPDATE ON $table_name_ur\n".
267 "FOR EACH ROW WHEN (new.$field_name_ur IS NULL)\n".
269 " SELECT sysdate INTO :new.$field_name_ur FROM dual;\n".
273 push @field_defs, $field_def;
275 if ( my $comment = $field->comments ) {
276 push @field_comments,
277 "COMMENT ON COLUMN $table_name.$field_name_ur is\n '".
285 my $constraint_name_default;
286 for my $c ( $table->get_constraints ) {
287 my $name = $c->name || '';
288 my @fields = map { unreserve( $_, $table_name ) } $c->fields;
289 my @rfields = map { unreserve( $_, $table_name ) }
290 $c->reference_fields;
293 if ( $c->type eq PRIMARY_KEY ) {
294 $name ||= mk_name( $table_name, 'pk' );
295 push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ".
296 '(' . join( ', ', @fields ) . ')';
298 elsif ( $c->type eq UNIQUE ) {
299 $name ||= mk_name( $table_name, ++$constraint_name_default );
300 push @constraint_defs, "CONSTRAINT $name UNIQUE " .
301 '(' . join( ', ', @fields ) . ')';
303 elsif ( $c->type eq FOREIGN_KEY ) {
304 $name ||= mk_name( $table_name, ++$constraint_name_default );
305 my $def = "CONSTRAINT $name FOREIGN KEY ";
308 $def .= join( ', ', @fields );
311 $def .= ' REFERENCES ' . $c->reference_table;
314 $def .= ' (' . join( ', ', @rfields ) . ')';
317 if ( $c->match_type ) {
319 ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
322 if ( $c->on_delete ) {
323 $def .= ' ON DELETE '.join( ' ', $c->on_delete );
326 if ( $c->on_update ) {
327 $def .= ' ON UPDATE '.join( ' ', $c->on_update );
330 push @constraint_defs, $def;
338 my $idx_name_default;
339 for my $index ( $table->get_indices ) {
340 my $index_name = $index->name || '';
341 my $index_type = $index->type || NORMAL;
342 my @fields = map { unreserve( $_, $table_name ) }
346 if ( $index_type eq PRIMARY_KEY ) {
347 $index_name = mk_name( $table_name, 'pk' );
348 push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
349 '(' . join( ', ', @fields ) . ')';
351 elsif ( $index_type eq UNIQUE ) {
352 $index_name = mk_name(
353 $table_name, $index_name || ++$idx_name_default
355 push @field_defs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
356 '(' . join( ', ', @fields ) . ')';
359 elsif ( $index_type eq NORMAL ) {
360 $index_name = mk_name(
361 $table_name, $index_name || ++$idx_name_default
364 "CREATE INDEX $index_name on $table_name_ur (".
365 join( ', ', @fields ).
369 warn "Unknown index type ($index_type) on table $table_name.\n"
374 my $create_statement;
375 $create_statement = "DROP TABLE $table_name_ur;\n" if $add_drop_table;
377 join( ",\n", map { "-- $_" } $table->comments ) .
378 "CREATE TABLE $table_name_ur (\n" .
379 join( ",\n", map { " $_" } @field_defs, @constraint_defs ) .
383 $output .= join( "\n\n",
395 warn "Truncated " . keys( %truncated ) . " names:\n";
396 warn "\t" . join( "\n\t", sort keys %truncated ) . "\n";
400 warn "Encounted " . keys( %unreserve ) .
401 " unsafe names in schema (reserved or invalid):\n";
402 warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n";
409 # -------------------------------------------------------------------
411 my $basename = shift || '';
412 my $type = shift || '';
413 my $scope = shift || '';
414 my $critical = shift || '';
415 my $basename_orig = $basename;
417 ? $max_id_length - (length($type) + 1)
419 $basename = substr( $basename, 0, $max_name )
420 if length( $basename ) > $max_name;
421 my $name = $type ? "${type}_$basename" : $basename;
423 if ( $basename ne $basename_orig and $critical ) {
424 my $show_type = $type ? "+'$type'" : "";
425 warn "Truncating '$basename_orig'$show_type to $max_id_length ",
426 "character limit to make '$name'\n" if $WARN;
427 $truncated{ $basename_orig } = $name;
430 $scope ||= \%global_names;
431 if ( my $prev = $scope->{ $name } ) {
432 my $name_orig = $name;
433 $name .= sprintf( "%02d", ++$prev );
434 substr($name, $max_id_length - 3) = "00"
435 if length( $name ) > $max_id_length;
437 warn "The name '$name_orig' has been changed to ",
438 "'$name' to make it unique.\n" if $WARN;
440 $scope->{ $name_orig }++;
447 # -------------------------------------------------------------------
449 my $name = shift || '';
450 my $schema_obj_name = shift || '';
452 my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
454 # also trap fields that don't begin with a letter
455 return $name if !$ora_reserved{ uc $name } && $name =~ /^[a-z]/i;
457 if ( $schema_obj_name ) {
458 ++$unreserve{"$schema_obj_name.$name"};
461 ++$unreserve{"$name (table name)"};
464 my $unreserve = sprintf '%s_', $name;
465 return $unreserve.$suffix;
470 # -------------------------------------------------------------------
471 # All bad art is the result of good intentions.
473 # -------------------------------------------------------------------
477 SQL::Translator::Producer::Oracle - Oracle SQL producer
481 use SQL::Translator::Parser::MySQL;
482 use SQL::Translator::Producer::Oracle;
484 my $original_create = ""; # get this from somewhere...
485 my $translator = SQL::Translator->new;
487 $translator->parser("SQL::Translator::Parser::MySQL");
488 $translator->producer("SQL::Translator::Producer::Oracle");
490 my $new_create = $translator->translate($original_create);
494 SQL::Translator::Producer::Oracle takes a parsed data structure,
495 created by a SQL::Translator::Parser subclass, and turns it into a
496 create string suitable for use with an Oracle database.
500 A hearty "thank-you" to Tim Bunce for much of the logic stolen from
501 his "mysql2ora" script.
505 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>