X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FProducer%2FOracle.pm;h=87595bc25ddec7b00743b58a6f5bff7f9aa659f2;hb=d6d2873a78cf19f60f3cd7b5c5eb964b9104ec84;hp=84dfc3199e33f4ab2ffe9e71f81a1f12b1f67b8d;hpb=f50875529306043d074770cf077ff964abc2a56b;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Producer/Oracle.pm b/lib/SQL/Translator/Producer/Oracle.pm index 84dfc31..87595bc 100644 --- a/lib/SQL/Translator/Producer/Oracle.pm +++ b/lib/SQL/Translator/Producer/Oracle.pm @@ -1,10 +1,11 @@ package SQL::Translator::Producer::Oracle; # ------------------------------------------------------------------- -# $Id: Oracle.pm,v 1.8 2002-12-11 01:44:54 kycl4rk Exp $ +# $Id: Oracle.pm,v 1.26 2003-10-15 19:00:35 kycl4rk Exp $ # ------------------------------------------------------------------- -# Copyright (C) 2002 Ken Y. Clark , -# darren chamberlain +# 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 @@ -21,11 +22,31 @@ package SQL::Translator::Producer::Oracle; # 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. + +=cut + use strict; use vars qw[ $VERSION $DEBUG $WARN ]; -$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/; +$VERSION = sprintf "%d.%02d", q$Revision: 1.26 $ =~ /(\d+)\.(\d+)/; $DEBUG = 0 unless defined $DEBUG; +use SQL::Translator::Schema::Constants; +use SQL::Translator::Utils qw(header_comment); + my %translate = ( # # MySQL types @@ -35,19 +56,20 @@ 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', + tinytext => 'varchar2', + text => 'clob', + longtext => 'clob', + mediumtext => 'clob', enum => 'varchar2', set => 'varchar2', date => 'date', @@ -59,33 +81,35 @@ 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', ); # @@ -126,18 +150,15 @@ my %truncated; # ------------------------------------------------------------------- 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 $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 .= @@ -149,95 +170,135 @@ sub produce { # # 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( ', ', map { qq['$_'] } @$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; + warn "CLOB cannot be a primary key, changing to VARCHAR2\n" + if $WARN; + } + + # + # Fixes ORA-00907: missing right parenthesis + # + if ( $data_type =~ /(date|clob)/i ) { + undef @size; + } + + $field_def .= " $data_type"; + if ( defined $size[0] && $size[0] > 0 ) { + $field_def .= '(' . join( ', ', @size ) . ')'; } # # Default value # - if ( defined $field->{'default'} ) { - $field_str .= sprintf( - ' DEFAULT %s', - $field->{'default'} =~ m/null/i ? 'NULL' : - "'".$field->{'default'}."'" - ); + 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 ( + $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 = 'SYSDATE'; + } + else { + $default = $default =~ m/null/i ? 'NULL' : "'$default'" + } + + $field_def .= " DEFAULT $default", } # # Not null constraint # - unless ( $field->{'null'} ) { - my $constraint_name = mk_name($field_name_ur, 'nn'); - $field_str .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL'; + unless ( $field->is_nullable ) { +# my $constraint_name = mk_name( +# join('_', $table_name_ur, $field_name_ur ), 'nn' +# ); +# $field_def .= ' CONSTRAINT ' . $constraint_name . ' NOT NULL'; + $field_def .= ' 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" . @@ -247,57 +308,133 @@ sub produce { ")\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, + 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."';"; + } } # - # Index Declarations + # Table options # - 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'} }; - next unless @fields; + 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 ( $index_type eq 'primary_key' ) { - $index_name = mk_name( $table_name, 'pk' ); - push @field_decs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '. + # + # Table constraints + # + 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 if !@fields && $c->type ne CHECK_C; + + if ( $c->type eq PRIMARY_KEY ) { + $name ||= mk_name( $table_name, 'pk' ); + push @constraint_defs, "CONSTRAINT $name PRIMARY KEY ". '(' . join( ', ', @fields ) . ')'; } - elsif ( $index_type eq 'unique' ) { - $index_name = mk_name( - $table_name, $index_name || ++$idx_name_default - ); - push @field_decs, 'CONSTRAINT ' . $index_name . ' UNIQUE ' . + elsif ( $c->type eq UNIQUE ) { + $name ||= mk_name( $table_name, 'u' ); + push @constraint_defs, "CONSTRAINT $name UNIQUE " . '(' . join( ', ', @fields ) . ')'; } + elsif ( $c->type eq CHECK_C ) { + $name ||= mk_name( $table_name, 'ck' ); + 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' ); + my $def = "CONSTRAINT $name FOREIGN KEY "; + + if ( @fields ) { + $def .= '(' . join( ', ', @fields ) . ')'; + } + + my $ref_table = unreserve($c->reference_table); + + $def .= " REFERENCES $ref_table"; + + if ( @rfields ) { + $def .= ' (' . join( ', ', @rfields ) . ')'; + } - elsif ( $index_type eq 'normal' ) { - $index_name = mk_name( - $table_name, $index_name || ++$idx_name_default - ); - push @index_decs, + 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_defs = (); + 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; + next unless @fields; + + if ( $index_type eq PRIMARY_KEY ) { + $index_name ||= mk_name( $table_name, 'pk' ); + push @field_defs, 'CONSTRAINT '.$index_name.' PRIMARY KEY '. + '(' . join( ', ', @fields ) . ')'; + } + elsif ( $index_type eq NORMAL ) { + $index_name ||= mk_name( $table_name, $index_name || 'i' ); + push @index_defs, "CREATE INDEX $index_name on $table_name_ur (". join( ', ', @fields ). ");"; @@ -310,16 +447,29 @@ 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);" + + if ( my @table_comments = $table->comments ) { + for my $comment ( @table_comments ) { + next unless $comment; + push @field_comments, "COMMENT ON TABLE $table_name is\n '". + $comment."';" + ; + } + } + + my $table_options = @table_options + ? "\n".join("\n", @table_options) : ''; + $create_statement .= "CREATE TABLE $table_name_ur (\n" . + join( ",\n", map { " $_" } @field_defs, @constraint_defs ) . + "\n)$table_options;" ; $output .= join( "\n\n", @comments, $create_statement, - @trigger_decs, - @index_decs, + @trigger_defs, + @index_defs, + @field_comments, '' ); } @@ -342,7 +492,11 @@ sub produce { # ------------------------------------------------------------------- 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) @@ -377,11 +531,13 @@ sub mk_name { # ------------------------------------------------------------------- sub unreserve { - my ( $name, $schema_obj_name ) = @_; + 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"}; @@ -401,40 +557,19 @@ sub unreserve { # 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 -Ken Y. Clark Ekclark@cpan.orgE +Ken Y. Clark Ekclark@cpan.orgE. =head1 SEE ALSO -perl(1). +SQL::Translator, DDL::Oracle, mysql2ora. =cut