1 package SQL::Translator::Producer::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.21 2003-08-19 14:44:00 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.21 $ =~ /(\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',
52 tinytext => '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"
207 # Fixes ORA-00907: missing right parenthesis
209 if ( $data_type =~ /(date|clob)/i ) {
213 $field_def .= " $data_type";
214 if ( defined $size[0] && $size[0] > 0 ) {
215 $field_def .= '(' . join( ', ', @size ) . ')';
221 my $default = $field->default_value;
222 if ( defined $default ) {
223 $field_def .= sprintf(
225 $default =~ m/null/i ? 'NULL' : "'$default'"
230 # Not null constraint
232 unless ( $field->is_nullable ) {
233 my $constraint_name = mk_name($field_name_ur, 'nn');
234 $field_def .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL';
237 $field_def .= " $check" if $check;
242 if ( $field->is_auto_increment ) {
243 my $base_name = $table_name . "_". $field_name;
244 my $seq_name = mk_name( $base_name, 'sq' );
245 my $trigger_name = mk_name( $base_name, 'ai' );
248 "CREATE SEQUENCE $seq_name;\n" .
249 "CREATE OR REPLACE TRIGGER $trigger_name\n" .
250 "BEFORE INSERT ON $table_name\n" .
251 "FOR EACH ROW WHEN (\n" .
252 " new.$field_name_ur IS NULL".
253 " OR new.$field_name_ur = 0\n".
256 " SELECT $seq_name.nextval\n" .
257 " INTO :new." . $field->name."\n" .
263 if ( lc $field->data_type eq 'timestamp' ) {
264 my $base_name = $table_name . "_". $field_name_ur;
265 my $trig_name = mk_name( $base_name, 'ts' );
267 "CREATE OR REPLACE TRIGGER $trig_name\n".
268 "BEFORE INSERT OR UPDATE ON $table_name_ur\n".
269 "FOR EACH ROW WHEN (new.$field_name_ur IS NULL)\n".
271 " SELECT sysdate INTO :new.$field_name_ur FROM dual;\n".
275 push @field_defs, $field_def;
277 if ( my $comment = $field->comments ) {
278 push @field_comments,
279 "COMMENT ON COLUMN $table_name.$field_name_ur is\n '".
287 my $constraint_name_default;
288 for my $c ( $table->get_constraints ) {
289 my $name = $c->name || '';
290 my @fields = map { unreserve( $_, $table_name ) } $c->fields;
291 my @rfields = map { unreserve( $_, $table_name ) }
292 $c->reference_fields;
295 if ( $c->type eq PRIMARY_KEY ) {
296 $name ||= mk_name( $table_name, 'pk' );
297 push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ".
298 '(' . join( ', ', @fields ) . ')';
300 elsif ( $c->type eq UNIQUE ) {
301 $name ||= mk_name( $table_name, ++$constraint_name_default );
302 push @constraint_defs, "CONSTRAINT $name UNIQUE " .
303 '(' . join( ', ', @fields ) . ')';
305 elsif ( $c->type eq FOREIGN_KEY ) {
306 $name ||= mk_name( $table_name, ++$constraint_name_default );
307 my $def = "CONSTRAINT $name FOREIGN KEY ";
310 $def .= join( ', ', @fields );
313 $def .= ' REFERENCES ' . $c->reference_table;
316 $def .= ' (' . join( ', ', @rfields ) . ')';
319 if ( $c->match_type ) {
321 ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
324 if ( $c->on_delete ) {
325 $def .= ' ON DELETE '.join( ' ', $c->on_delete );
328 if ( $c->on_update ) {
329 $def .= ' ON UPDATE '.join( ' ', $c->on_update );
332 push @constraint_defs, $def;
340 my $idx_name_default;
341 for my $index ( $table->get_indices ) {
342 my $index_name = $index->name || '';
343 my $index_type = $index->type || NORMAL;
344 my @fields = map { unreserve( $_, $table_name ) }
348 if ( $index_type eq PRIMARY_KEY ) {
349 $index_name = mk_name( $table_name, 'pk' );
350 push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '.
351 '(' . join( ', ', @fields ) . ')';
353 elsif ( $index_type eq UNIQUE ) {
354 $index_name = mk_name(
355 $table_name, $index_name || ++$idx_name_default
357 push @field_defs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' .
358 '(' . join( ', ', @fields ) . ')';
361 elsif ( $index_type eq NORMAL ) {
362 $index_name = mk_name(
363 $table_name, $index_name || ++$idx_name_default
366 "CREATE INDEX $index_name on $table_name_ur (".
367 join( ', ', @fields ).
371 warn "Unknown index type ($index_type) on table $table_name.\n"
376 my $create_statement;
377 $create_statement = "DROP TABLE $table_name_ur;\n" if $add_drop_table;
379 if ( my @table_comments = $table->comments ) {
380 for my $comment ( @table_comments ) {
381 next unless $comment;
382 push @field_comments, "COMMENT ON TABLE $table_name is\n '".
388 $create_statement .= "CREATE TABLE $table_name_ur (\n" .
389 join( ",\n", map { " $_" } @field_defs, @constraint_defs ) .
393 $output .= join( "\n\n",
405 warn "Truncated " . keys( %truncated ) . " names:\n";
406 warn "\t" . join( "\n\t", sort keys %truncated ) . "\n";
410 warn "Encounted " . keys( %unreserve ) .
411 " unsafe names in schema (reserved or invalid):\n";
412 warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n";
419 # -------------------------------------------------------------------
421 my $basename = shift || '';
422 my $type = shift || '';
423 my $scope = shift || '';
424 my $critical = shift || '';
425 my $basename_orig = $basename;
427 ? $max_id_length - (length($type) + 1)
429 $basename = substr( $basename, 0, $max_name )
430 if length( $basename ) > $max_name;
431 my $name = $type ? "${type}_$basename" : $basename;
433 if ( $basename ne $basename_orig and $critical ) {
434 my $show_type = $type ? "+'$type'" : "";
435 warn "Truncating '$basename_orig'$show_type to $max_id_length ",
436 "character limit to make '$name'\n" if $WARN;
437 $truncated{ $basename_orig } = $name;
440 $scope ||= \%global_names;
441 if ( my $prev = $scope->{ $name } ) {
442 my $name_orig = $name;
443 $name .= sprintf( "%02d", ++$prev );
444 substr($name, $max_id_length - 3) = "00"
445 if length( $name ) > $max_id_length;
447 warn "The name '$name_orig' has been changed to ",
448 "'$name' to make it unique.\n" if $WARN;
450 $scope->{ $name_orig }++;
457 # -------------------------------------------------------------------
459 my $name = shift || '';
460 my $schema_obj_name = shift || '';
462 my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : '';
464 # also trap fields that don't begin with a letter
465 return $name if !$ora_reserved{ uc $name } && $name =~ /^[a-z]/i;
467 if ( $schema_obj_name ) {
468 ++$unreserve{"$schema_obj_name.$name"};
471 ++$unreserve{"$name (table name)"};
474 my $unreserve = sprintf '%s_', $name;
475 return $unreserve.$suffix;
480 # -------------------------------------------------------------------
481 # All bad art is the result of good intentions.
483 # -------------------------------------------------------------------
487 SQL::Translator::Producer::Oracle - Oracle SQL producer
491 use SQL::Translator::Parser::MySQL;
492 use SQL::Translator::Producer::Oracle;
494 my $original_create = ""; # get this from somewhere...
495 my $translator = SQL::Translator->new;
497 $translator->parser("SQL::Translator::Parser::MySQL");
498 $translator->producer("SQL::Translator::Producer::Oracle");
500 my $new_create = $translator->translate($original_create);
504 SQL::Translator::Producer::Oracle takes a parsed data structure,
505 created by a SQL::Translator::Parser subclass, and turns it into a
506 create string suitable for use with an Oracle database.
510 A hearty "thank-you" to Tim Bunce for much of the logic stolen from
511 his "mysql2ora" script.
515 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>