X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FProducer%2FOracle.pm;h=00a9e2e9de2dfe184fee9f89194c7d4e826775fb;hb=ba506e52c480afe33dfec6b38a12759fad1e7fa2;hp=fd41b8e0ee121cb1b00df93f6b836319d09663c7;hpb=65ffb46ce790d0913350b20e5a0b9a789b052893;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Producer/Oracle.pm b/lib/SQL/Translator/Producer/Oracle.pm index fd41b8e..00a9e2e 100644 --- a/lib/SQL/Translator/Producer/Oracle.pm +++ b/lib/SQL/Translator/Producer/Oracle.pm @@ -1,9 +1,7 @@ package SQL::Translator::Producer::Oracle; # ------------------------------------------------------------------- -# $Id: Oracle.pm,v 1.34 2005-08-10 16:33:39 duality72 Exp $ -# ------------------------------------------------------------------- -# Copyright (C) 2002-4 SQLFairy Authors +# Copyright (C) 2002-2009 SQLFairy Authors # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License as @@ -35,11 +33,72 @@ SQL::Translator::Producer::Oracle - Oracle SQL producer 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. + +=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.34 $ =~ /(\d+)\.(\d+)/; +$VERSION = '1.60'; $DEBUG = 0 unless defined $DEBUG; use SQL::Translator::Schema::Constants; @@ -140,6 +199,20 @@ my %ora_reserved = map { $_, 1 } qw( WHENEVER WHERE WITH ); +# +# Oracle 8/9 max size of data types from: +# http://www.ss64.com/orasyntax/datatypes.html +# +my %max_size = ( + char => 2000, + 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; @@ -170,13 +243,14 @@ sub produce { } for my $table ( $schema->get_tables ) { - my ( $table_def, $fk_def, $trigger_def, $index_def, $constraint_def) = create_table( + 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 + add_drop_table => $add_drop_table, + show_warnings => $WARN, + no_comments => $no_comments, + delay_constraints => $delay_constraints, + wantarray => wantarray ? 1 : 0, } ); push @table_defs, @$table_def; @@ -191,7 +265,15 @@ sub produce { push @view_defs, create_view($view); } - return wantarray ? (defined $create ? $create : (), @table_defs, @view_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs) : $create . join ("\n\n", @table_defs, @view_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs, ''); + if (wantarray) { + return defined $create ? $create : (), @table_defs, @view_defs, @fk_defs, @trigger_defs, @index_defs, @constraint_defs; + } + else { + $create .= join ('', map { $_ ? "$_;\n\n" : () } @table_defs, @view_defs, @fk_defs, @index_defs, @constraint_defs); + # triggers may NOT end with a semicolon + $create .= join "\n\n", @trigger_defs; + return $create; + } } sub create_table { @@ -202,176 +284,19 @@ sub create_table { 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 CASCADE CONSTRAINTS;] if $options->{add_drop_table}; - my $table_name_ur = unreserve($table_name) or next; + push @create, "--\n-- Table: $table_name_ur\n--" unless $options->{no_comments}; + push @create, qq[DROP TABLE $table_name_ur CASCADE CONSTRAINTS] if $options->{add_drop_table}; + 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 - ); - my $field_name_ur = unreserve( $field_name, $table_name ); - my $field_def = $field_name_ur; - $field->name( $field_name_ur ); - - # - # Datatype - # - my $check; - 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' ) { - $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 :) - $data_type = 'varchar2'; - } - else { - $data_type = defined $translate{ $data_type } ? - $translate{ $data_type } : - $data_type; - $data_type ||= 'varchar2'; - } - - # - # 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; - } - - $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 ( - $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' : "'$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_ur . "_". $field_name; - my $seq_name = mk_name( $base_name, 'sq' ); - my $trigger_name = mk_name( $base_name, 'ai' ); - - push @create, qq[DROP SEQUENCE $seq_name;] if $options->{add_drop_table}; - push @create, "CREATE SEQUENCE $seq_name;"; - push @trigger_defs, - "CREATE OR REPLACE TRIGGER $trigger_name\n" . - "BEFORE INSERT ON $table_name_ur\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/"; - ; - } - - if ( lc $field->data_type eq 'timestamp' ) { - my $base_name = $table_name_ur . "_". $field_name_ur; - my $trig_name = mk_name( $base_name, 'ts' ); - 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". - "BEGIN \n". - " SELECT sysdate INTO :new.$field_name_ur FROM dual;\n". - "END;\n/"; - } - - push @field_defs, $field_def; - - if ( my $comment = $field->comments ) { - $comment =~ s/'/''/g; - push @field_comments, - "COMMENT ON COLUMN $table_name_ur.$field_name_ur is\n '" . - $comment . "';" unless $options->{no_comments}; - } + 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; } # @@ -408,7 +333,9 @@ sub create_table { next if !@fields && $c->type ne CHECK_C; if ( $c->type eq PRIMARY_KEY ) { - #$name ||= mk_name( $table_name, 'pk' ); + # create a name if delay_constraints + $name ||= mk_name( $table_name, 'pk' ) + if $options->{delay_constraints}; push @constraint_defs, ($name ? "CONSTRAINT $name " : '') . 'PRIMARY KEY (' . join( ', ', @fields ) . ')'; } @@ -441,7 +368,7 @@ sub create_table { push @constraint_defs, "CONSTRAINT $name CHECK ($expression)"; } elsif ( $c->type eq FOREIGN_KEY ) { - $name = mk_name( join('_', $table_name, $c->fields). '_fk' ); + $name = mk_name( join('_', $table_name, $c->fields). '_fk' ); my $def = "CONSTRAINT $name FOREIGN KEY "; if ( @fields ) { @@ -465,12 +392,12 @@ sub create_table { $def .= ' ON DELETE '.join( ' ', $c->on_delete ); } - # disabled by plu 2007-12-29 - doesn't exist for oracle - #if ( $c->on_update ) { - # $def .= ' ON UPDATE '.join( ' ', $c->on_update ); - #} + # disabled by plu 2007-12-29 - doesn't exist for oracle + #if ( $c->on_update ) { + # $def .= ' ON UPDATE '.join( ' ', $c->on_update ); + #} - push @fk_defs, sprintf("ALTER TABLE %s ADD %s;", $table, $def); + push @fk_defs, sprintf("ALTER TABLE %s ADD %s", $table_name_ur, $def); } } @@ -519,7 +446,7 @@ sub create_table { push @index_defs, "CREATE INDEX $index_name on $table_name_ur (". join( ', ', @fields ). - ")$index_options;"; + ")$index_options"; } elsif ( $index_type eq UNIQUE ) { $index_name = $index_name ? mk_name( $index_name ) @@ -527,7 +454,7 @@ sub create_table { push @index_defs, "CREATE UNIQUE INDEX $index_name on $table_name_ur (". join( ', ', @fields ). - ")$index_options;"; + ")$index_options"; } else { warn "Unknown index type ($index_type) on table $table_name.\n" @@ -540,7 +467,7 @@ sub create_table { next unless $comment; $comment =~ s/'/''/g; push @field_comments, "COMMENT ON TABLE $table_name_ur is\n '". - $comment . "';" unless $options->{no_comments} + $comment . "'" unless $options->{no_comments} ; } } @@ -550,7 +477,7 @@ sub create_table { push @create, "CREATE TABLE $table_name_ur (\n" . join( ",\n", map { " $_" } @field_defs, ($options->{delay_constraints} ? () : @constraint_defs) ) . - "\n)$table_options;"; + "\n)$table_options"; @constraint_defs = map { 'ALTER TABLE '.$table_name_ur.' ADD '.$_ } @constraint_defs; @@ -571,10 +498,248 @@ sub create_table { return \@create, \@fk_defs, \@trigger_defs, \@index_defs, ($options->{delay_constraints} ? \@constraint_defs : []); } +sub alter_field { + my ($from_field, $to_field, $options) = @_; + + 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 = $to_field->table->name; + my $table_name_ur = unreserve( $table_name ); + + return 'ALTER TABLE '.$table_name_ur.' MODIFY ( '.join('', @$field_defs).' )'; +} + +sub add_field { + my ($new_field, $options) = @_; + + my ($field_create, $field_defs, $trigger_defs, $field_comments) = + create_field($new_field, $options, {}); + + my $table_name = $new_field->table->name; + my $table_name_ur = unreserve( $table_name ); + + my $out = sprintf('ALTER TABLE %s ADD ( %s )', + $table_name_ur, + join('', @$field_defs)); + return $out; +} + +sub create_field { + my ($field, $options, $field_name_scope) = @_; + + my (@create, @field_defs, @trigger_defs, @field_comments); + + my $table_name = $field->table->name; + my $table_name_ur = unreserve( $table_name ); + + # + # Field name + # + my $field_name = mk_name( + $field->name, '', $field_name_scope, 1 + ); + + my $field_name_ur = unreserve( $field_name, $table_name ); + my $field_def = $field_name_ur; + $field->name( $field_name_ur ); + + # + # Datatype + # + my $check; + 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' ) { + $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 :) + $data_type = 'varchar2'; + } + else { + $data_type = defined $translate{ $data_type } ? + $translate{ $data_type } : + $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; + } + } + + # + # 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; + } + + $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' : "'$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_ur . "_". $field_name; + my $seq_name = mk_name( $base_name, 'sq' ); + my $trigger_name = mk_name( $base_name, 'ai' ); + + 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_ur\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"; + + # + # If wantarray is set we have to omit the last "/" in this statement so it + # can be executed by DBI->do() directly. + # + $trigger .= "/" unless $options->{wantarray}; + + push @trigger_defs, $trigger; + } + + if ( lc $field->data_type eq 'timestamp' ) { + my $base_name = $table_name_ur . "_". $field_name_ur; + my $trig_name = mk_name( $base_name, 'ts' ); + my $trigger = + "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"; + + # + # If wantarray is set we have to omit the last "/" in this statement so it + # can be executed by DBI->do() directly. + # + $trigger .= "/" unless $options->{wantarray}; + + push @trigger_defs, $trigger; + } + + push @field_defs, $field_def; + + if ( my $comment = $field->comments ) { + $comment =~ s/'/''/g; + push @field_comments, + "COMMENT ON COLUMN $table_name_ur.$field_name_ur is\n '" . + $comment . "';" unless $options->{no_comments}; + } + + return \@create, \@field_defs, \@trigger_defs, \@field_comments; + +} + + sub create_view { my ($view) = @_; - my $out = sprintf("CREATE VIEW %s AS\n%s;", + my $out = sprintf("CREATE VIEW %s AS\n%s", $view->name, $view->sql); @@ -657,7 +822,7 @@ script. =head1 AUTHOR -Ken Y. Clark Ekclark@cpan.orgE. +Ken Youens-Clark Ekclark@cpan.orgE. =head1 SEE ALSO