1 package SQL::Translator::Producer::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.19 2003-08-17 07:51:33 rossta 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.19 $ =~ /(\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 "', '", @$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";
195 # Fixes ORA-02329: column of datatype LOB cannot be unique or a primary key
196 if ( $data_type eq 'clob' && $field->is_primary_key ) {
197 $data_type = 'varchar2';
201 # Fixes ORA-00907: missing right parenthesis
202 if ($data_type eq 'date') {
206 $field_def .= " $data_type";
207 if ( defined $size[0] && $size[0] > 0 ) {
208 $field_def .= '(' . join( ', ', @size ) . ')';
214 my $default = $field->default_value;
215 if ( defined $default ) {
216 $field_def .= sprintf(
218 $default =~ m/null/i ? 'NULL' : "'$default'"
223 # Not null constraint
225 unless ( $field->is_nullable ) {
226 my $constraint_name = mk_name($field_name_ur, 'nn');
227 $field_def .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
230 $field_def .= " $check" if $check;
235 if ( $field->is_auto_increment ) {
236 my $base_name = $table_name . "_". $field_name;
237 my $seq_name = mk_name( $base_name, 'sq' );
238 my $trigger_name = mk_name( $base_name, 'ai' );
241 "CREATE SEQUENCE $seq_name;\n" .
242 "CREATE OR REPLACE TRIGGER $trigger_name\n" .
243 "BEFORE INSERT ON $table_name\n" .
244 "FOR EACH ROW WHEN (\n" .
245 " new.$field_name_ur IS NULL".
246 " OR new.$field_name_ur = 0\n".
249 " SELECT $seq_name.nextval\n" .
250 " INTO :new." . $field->name."\n" .
256 if ( lc $field->data_type eq 'timestamp' ) {
257 my $base_name = $table_name . "_". $field_name_ur;
258 my $trig_name = mk_name( $base_name, 'ts' );
260 "CREATE OR REPLACE TRIGGER $trig_name\n".
261 "BEFORE INSERT OR UPDATE ON $table_name_ur\n".
262 "FOR EACH ROW WHEN (new.$field_name_ur IS NULL)\n".
264 " SELECT sysdate INTO :new.$field_name_ur FROM dual;\n".
268 push @field_defs, $field_def;
270 if ( my $comment = $field->comments ) {
271 push @field_comments,
272 "COMMENT ON COLUMN $table_name.$field_name_ur is\n '".
280 my $constraint_name_default;
281 for my $c ( $table->get_constraints ) {
282 my $name = $c->name || '';
283 my @fields = map { unreserve( $_, $table_name ) } $c->fields;
284 my @rfields = map { unreserve( $_, $table_name ) }
285 $c->reference_fields;
288 if ( $c->type eq PRIMARY_KEY ) {
289 $name ||= mk_name( $table_name, 'pk' );
290 push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ".
291 '(' . join( ', ', @fields ) . ')';
293 elsif ( $c->type eq UNIQUE ) {
294 $name ||= mk_name( $table_name, ++$constraint_name_default );
295 push @constraint_defs, "CONSTRAINT $name UNIQUE " .
296 '(' . join( ', ', @fields ) . ')';
298 elsif ( $c->type eq FOREIGN_KEY ) {
299 $name ||= mk_name( $table_name, ++$constraint_name_default );
300 my $def = "CONSTRAINT $name FOREIGN KEY ";
303 $def .= join( ', ', @fields );
306 $def .= ' REFERENCES ' . $c->reference_table;
309 $def .= ' (' . join( ', ', @rfields ) . ')';
312 if ( $c->match_type ) {
314 ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
317 if ( $c->on_delete ) {
318 $def .= ' ON DELETE '.join( ' ', $c->on_delete );
321 if ( $c->on_update ) {
322 $def .= ' ON UPDATE '.join( ' ', $c->on_update );
325 push @constraint_defs, $def;
333 my $idx_name_default;
334 for my $index ( $table->get_indices ) {
335 my $index_name = $index->name || '';
336 my $index_type = $index->type || NORMAL;
337 my @fields = map { unreserve( $_, $table_name ) }
341 if ( $index_type eq PRIMARY_KEY ) {
342 $index_name = mk_name( $table_name, 'pk' );
343 push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
344 '(' . join( ', ', @fields ) . ')';
346 elsif ( $index_type eq UNIQUE ) {
347 $index_name = mk_name(
348 $table_name, $index_name || ++$idx_name_default
350 push @field_defs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
351 '(' . join( ', ', @fields ) . ')';
354 elsif ( $index_type eq NORMAL ) {
355 $index_name = mk_name(
356 $table_name, $index_name || ++$idx_name_default
359 "CREATE INDEX $index_name on $table_name_ur (".
360 join( ', ', @fields ).
364 warn "Unknown index type ($index_type) on table $table_name.\n"
369 my $create_statement;
370 $create_statement = "DROP TABLE $table_name_ur;\n" if $add_drop_table;
372 join( ",\n", map { "-- $_" } $table->comments ) .
373 "CREATE TABLE $table_name_ur (\n" .
374 join( ",\n", map { " $_" } @field_defs, @constraint_defs ) .
378 $output .= join( "\n\n",
390 warn "Truncated " . keys( %truncated ) . " names:\n";
391 warn "\t" . join( "\n\t", sort keys %truncated ) . "\n";
395 warn "Encounted " . keys( %unreserve ) .
396 " unsafe names in schema (reserved or invalid):\n";
397 warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n";
404 # -------------------------------------------------------------------
406 my $basename = shift || '';
407 my $type = shift || '';
408 my $scope = shift || '';
409 my $critical = shift || '';
410 my $basename_orig = $basename;
412 ? $max_id_length - (length($type) + 1)
414 $basename = substr( $basename, 0, $max_name )
415 if length( $basename ) > $max_name;
416 my $name = $type ? "${type}_$basename" : $basename;
418 if ( $basename ne $basename_orig and $critical ) {
419 my $show_type = $type ? "+'$type'" : "";
420 warn "Truncating '$basename_orig'$show_type to $max_id_length ",
421 "character limit to make '$name'\n" if $WARN;
422 $truncated{ $basename_orig } = $name;
425 $scope ||= \%global_names;
426 if ( my $prev = $scope->{ $name } ) {
427 my $name_orig = $name;
428 $name .= sprintf( "%02d", ++$prev );
429 substr($name, $max_id_length - 3) = "00"
430 if length( $name ) > $max_id_length;
432 warn "The name '$name_orig' has been changed to ",
433 "'$name' to make it unique.\n" if $WARN;
435 $scope->{ $name_orig }++;
442 # -------------------------------------------------------------------
444 my $name = shift || '';
445 my $schema_obj_name = shift || '';
447 my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
449 # also trap fields that don't begin with a letter
450 return $name if !$ora_reserved{ uc $name } && $name =~ /^[a-z]/i;
452 if ( $schema_obj_name ) {
453 ++$unreserve{"$schema_obj_name.$name"};
456 ++$unreserve{"$name (table name)"};
459 my $unreserve = sprintf '%s_', $name;
460 return $unreserve.$suffix;
465 # -------------------------------------------------------------------
466 # All bad art is the result of good intentions.
468 # -------------------------------------------------------------------
472 SQL::Translator::Producer::Oracle - Oracle SQL producer
476 use SQL::Translator::Parser::MySQL;
477 use SQL::Translator::Producer::Oracle;
479 my $original_create = ""; # get this from somewhere...
480 my $translator = SQL::Translator->new;
482 $translator->parser("SQL::Translator::Parser::MySQL");
483 $translator->producer("SQL::Translator::Producer::Oracle");
485 my $new_create = $translator->translate($original_create);
489 SQL::Translator::Producer::Oracle takes a parsed data structure,
490 created by a SQL::Translator::Parser subclass, and turns it into a
491 create string suitable for use with an Oracle database.
495 A hearty "thank-you" to Tim Bunce for much of the logic stolen from
496 his "mysql2ora" script.
500 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>