1 package SQL::Translator::Parser::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.29 2007-03-19 22:32:31 duality72 Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
25 SQL::Translator::Parser::Oracle - parser for Oracle
30 use SQL::Translator::Parser::Oracle;
32 my $translator = SQL::Translator->new;
33 $translator->parser("SQL::Translator::Parser::Oracle");
37 From http://www.ss64.com/ora/table_c.html:
39 CREATE [GLOBAL TEMPORARY] TABLE [schema.]table (tbl_defs,...)
40 [ON COMMIT {DELETE|PRESERVE} ROWS]
41 [storage_options | CLUSTER cluster_name (col1, col2,... )
42 | ORGANIZATION {HEAP [storage_options]
43 | INDEX idx_organized_tbl_clause}]
44 [LOB_storage_clause][varray_clause][nested_storage_clause]
46 [[NO]CACHE] [[NO]MONITORING] [PARALLEL parallel_clause]
47 [ENABLE enable_clause | DISABLE disable_clause]
51 column datatype [DEFAULT expr] [column_constraint(s)]
59 STORAGE storage_clause
63 idx_organized_tbl_clause:
64 storage_option(s) [PCTTHRESHOLD int]
65 [COMPRESS int|NOCOMPRESS]
66 [ [INCLUDING column_name] OVERFLOW [storage_option(s)] ]
68 nested_storage_clause:
69 NESTED TABLE nested_item STORE AS storage_table
70 [RETURN AS {LOCATOR|VALUE} ]
73 Partition_clause {ENABLE|DISABLE} ROW MOVEMENT
76 (http://www.ss64.com/ora/clause_constraint_col.html)
78 CONSTRAINT constrnt_name {UNIQUE|PRIMARY KEY} constrnt_state
80 CONSTRAINT constrnt_name CHECK(condition) constrnt_state
82 CONSTRAINT constrnt_name [NOT] NULL constrnt_state
84 CONSTRAINT constrnt_name REFERENCES [schema.]table[(column)]
85 [ON DELETE {CASCADE|SET NULL}] constrnt_state
88 [[NOT] DEFERRABLE] [INITIALLY {IMMEDIATE|DEFERRED}]
89 [RELY | NORELY] [USING INDEX using_index_clause]
90 [ENABLE|DISABLE] [VALIDATE|NOVALIDATE]
91 [EXCEPTIONS INTO [schema.]table]
93 Note that probably not all of the above syntax is supported, but the grammar
94 was altered to better handle the syntax created by DDL::Oracle.
99 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
100 $VERSION = sprintf "%d.%02d", q$Revision: 1.29 $ =~ /(\d+)\.(\d+)/;
101 $DEBUG = 0 unless defined $DEBUG;
104 use Parse::RecDescent;
106 use base qw(Exporter);
108 @EXPORT_OK = qw(parse);
110 # Enable warnings within the Parse::RecDescent module.
111 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
112 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
113 $::RD_HINT = 1; # Give out hints to help fix problems.
117 { my ( %tables, %indices, %constraints, $table_order, @table_comments, %views, $view_order, %procedures, $proc_order ) }
120 # The "eofile" rule makes the parser fail if any "statement" rule
121 # fails. Otherwise, the first successful match by a "statement"
122 # won't cause the failure needed to know that the parse, as a whole,
125 startrule : statement(s) eofile
129 indices => \%indices,
130 constraints => \%constraints,
132 procedures => \%procedures,
149 alter : /alter/i WORD /[^;]+/ ';'
150 { @table_comments = () }
152 drop : /drop/i TABLE ';'
154 drop : /drop/i WORD(s) ';'
155 { @table_comments = () }
157 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
159 my $table_name = $item{'table_name'};
160 $tables{ $table_name }{'order'} = ++$table_order;
161 $tables{ $table_name }{'table_name'} = $table_name;
163 if ( @table_comments ) {
164 $tables{ $table_name }{'comments'} = [ @table_comments ];
165 @table_comments = ();
170 for my $definition ( @{ $item[4] } ) {
171 if ( $definition->{'type'} eq 'field' ) {
172 my $field_name = $definition->{'name'};
173 $tables{ $table_name }{'fields'}{ $field_name } =
174 { %$definition, order => $i };
177 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
178 $constraint->{'fields'} = [ $field_name ];
179 push @{ $tables{ $table_name }{'constraints'} },
183 elsif ( $definition->{'type'} eq 'constraint' ) {
184 $definition->{'type'} = $definition->{'constraint_type'};
185 push @{ $tables{ $table_name }{'constraints'} }, $definition;
188 push @{ $tables{ $table_name }{'indices'} }, $definition;
192 for my $option ( @{ $item[6] } ) {
193 push @{ $tables{ $table_name }{'table_options'} }, $option;
199 create : create_index index_name /on/i table_name index_expr table_option(?) ';'
201 my $table_name = $item[4];
203 push @{ $constraints{ $table_name } }, {
210 push @{ $indices{ $table_name } }, {
218 index_expr: parens_word_list
220 | '(' WORD parens_word_list ')'
222 my $arg_list = join(",", @{$item[3]});
223 $return = "$item[2]($arg_list)";
226 create : /create/i /or replace/i /procedure/i table_name not_end m#^/$#im
228 @table_comments = ();
229 my $proc_name = $item[4];
230 # Hack to strip owner from procedure name
231 $proc_name =~ s#.*\.##;
233 my $sql = "$item[1] $item[2] $item[3] $item[4] $item[5]";
235 $procedures{ $proc_name }{'order'} = ++$proc_order;
236 $procedures{ $proc_name }{'name'} = $proc_name;
237 $procedures{ $proc_name }{'owner'} = $owner;
238 $procedures{ $proc_name }{'sql'} = $sql;
241 not_end: m#.*?(?=^/$)#ism
243 create : /create/i /or replace/i /force/i /view/i table_name not_delimiter ';'
245 @table_comments = ();
246 my $view_name = $item[5];
247 # Hack to strip owner from view name
248 $view_name =~ s#.*\.##;
249 my $sql = "$item[1] $item[2] $item[3] $item[4] $item[5] $item[6] $item[7]";
251 $views{ $view_name }{'order'} = ++$view_order;
252 $views{ $view_name }{'name'} = $view_name;
253 $views{ $view_name }{'sql'} = $sql;
256 not_delimiter: /.*?(?=;)/is
258 # Create anything else (e.g., domain, function, etc.)
259 create : ...!create_table ...!create_index /create/i WORD /[^;]+/ ';'
260 { @table_comments = () }
262 create_index : /create/i UNIQUE(?) /index/i
263 { $return = @{$item[2]} }
265 index_name : NAME '.' NAME
270 global_temporary: /global/i /temporary/i
272 table_name : NAME '.' NAME
277 create_definition : field
281 table_comment : comment
283 my $comment = $item[1];
285 push @table_comments, $comment;
288 comment : /^\s*(?:#|-{2}).*\n/
290 my $comment = $item[1];
291 $comment =~ s/^\s*(#|-{2})\s*//;
292 $comment =~ s/\s*$//;
296 comment : /\/\*/ /[^\*]+/ /\*\//
298 my $comment = $item[2];
299 $comment =~ s/^\s*|\s*$//g;
303 remark : /^REM\s+.*\n/
305 run : /^(RUN|\/)\s+.*\n/
307 prompt : /prompt/i /(table|index|sequence|trigger)/i ';'
309 prompt : /prompt\s+create\s+.*\n/i
311 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
313 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
316 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
318 my $table_name = $item[4]->{'table'};
319 my $field_name = $item[4]->{'field'};
320 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
321 $item{'comment_phrase'};
324 column_name : NAME '.' NAME
325 { $return = { table => $item[1], field => $item[3] } }
327 comment_phrase : /'.*?'/
334 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
336 my ( $is_pk, $default, @constraints );
338 for my $meta ( @{ $item[4] } ) {
339 if ( $meta->{'type'} eq 'default' ) {
343 elsif ( $meta->{'type'} eq 'not_null' ) {
347 elsif ( $meta->{'type'} eq 'primary_key' ) {
351 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
354 my @comments = ( @{ $item[1] }, @{ $item[5] } );
358 name => $item{'field_name'},
359 data_type => $item{'data_type'}{'type'},
360 size => $item{'data_type'}{'size'},
362 default => $default->{'value'},
363 is_primary_key => $is_pk,
364 constraints => [ @constraints ],
365 comments => [ @comments ],
372 data_type : ora_data_type data_size(?)
376 size => $item[2][0] || '',
380 data_size : '(' VALUE(s /,/) data_size_modifier(?) ')'
383 data_size_modifier: /byte/i
386 column_constraint : constraint_name(?) column_constraint_type constraint_state(s?)
388 my $desc = $item{'column_constraint_type'};
389 my $type = $desc->{'type'};
390 my $fields = $desc->{'fields'} || [];
391 my $expression = $desc->{'expression'} || '';
394 supertype => 'constraint',
395 name => $item{'constraint_name(?)'}[0] || '',
397 expression => $type eq 'check' ? $expression : '',
398 deferrable => $item{'deferrable'},
399 deferred => $item{'deferred'},
400 reference_table => $desc->{'reference_table'},
401 reference_fields => $desc->{'reference_fields'},
402 # match_type => $desc->{'match_type'},
403 # on_update => $desc->{'on_update'},
407 constraint_name : /constraint/i NAME { $item[2] }
409 column_constraint_type : /not\s+null/i { $return = { type => 'not_null' } }
411 { $return = { type => 'unique' } }
413 { $return = { type => 'primary_key' } }
414 | /check/i '(' /[^)]+/ ')'
415 { $return = { type => 'check', expression => $item[3] } }
416 | /references/i table_name parens_word_list(?) on_delete(?)
419 type => 'foreign_key',
420 reference_table => $item[2],
421 reference_fields => $item[3][0],
422 # match_type => $item[4][0],
423 on_delete => $item[5][0],
427 constraint_state : deferrable { $return = { type => $item[1] } }
428 | deferred { $return = { type => $item[1] } }
429 | /(no)?rely/i { $return = { type => $item[1] } }
430 # | /using/i /index/i using_index_clause
431 # { $return = { type => 'using_index', index => $item[3] } }
432 | /(dis|en)able/i { $return = { type => $item[1] } }
433 | /(no)?validate/i { $return = { type => $item[1] } }
434 | /exceptions/i /into/i table_name
435 { $return = { type => 'exceptions_into', table => $item[3] } }
437 deferrable : /not/i /deferrable/i
438 { $return = 'not_deferrable' }
440 { $return = 'deferrable' }
442 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
445 /(n?varchar2|varchar)/i { $return = 'varchar2' }
447 /n?char/i { $return = 'character' }
449 /n?dec/i { $return = 'decimal' }
451 /number/i { $return = 'number' }
453 /integer/i { $return = 'integer' }
455 /(pls_integer|binary_integer)/i { $return = 'integer' }
457 /interval\s+day/i { $return = 'interval day' }
459 /interval\s+year/i { $return = 'interval year' }
461 /long\s+raw/i { $return = 'long raw' }
463 /(long|date|timestamp|raw|rowid|urowid|mlslabel|clob|nclob|blob|bfile|float)/i { $item[1] }
465 parens_value_list : '(' VALUE(s /,/) ')'
468 parens_word_list : '(' WORD(s /,/) ')'
471 field_meta : default_val
474 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
477 $val =~ s/'//g if defined $val;
479 supertype => 'constraint',
487 supertype => 'constraint',
493 create_table : /create/i global_temporary(?) /table/i
495 table_option : /organization/i WORD
497 $return = { 'ORGANIZATION' => $item[2] }
500 table_option : /nomonitoring/i
502 $return = { 'NOMONITORING' => undef }
505 table_option : /parallel/i '(' key_value(s) ')'
507 $return = { 'PARALLEL' => $item[3] }
510 key_value : WORD VALUE
512 $return = { $item[1], $item[2] }
515 table_option : /[^;]+/
517 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) constraint_state(s?) comment(s?)
519 my $desc = $item{'table_constraint_type'};
520 my $type = $desc->{'type'};
521 my $fields = $desc->{'fields'};
522 my $expression = $desc->{'expression'};
523 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
526 name => $item{'constraint_name(?)'}[0] || '',
527 type => 'constraint',
528 constraint_type => $type,
529 fields => $type ne 'check' ? $fields : [],
530 expression => $type eq 'check' ? $expression : '',
531 deferrable => $item{'deferrable(?)'},
532 deferred => $item{'deferred(?)'},
533 reference_table => $desc->{'reference_table'},
534 reference_fields => $desc->{'reference_fields'},
535 # match_type => $desc->{'match_type'}[0],
536 on_delete => $desc->{'on_delete'} || $desc->{'on_delete_do'},
537 on_update => $desc->{'on_update'} || $desc->{'on_update_do'},
538 comments => [ @comments ],
542 table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
545 type => 'primary_key',
550 /unique/i '(' NAME(s /,/) ')'
558 /check/ '(' /(.+)/ ')'
562 expression => $item[3],
566 /foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete(?)
569 type => 'foreign_key',
571 reference_table => $item[6],
572 reference_fields => $item[7][0],
573 # match_type => $item[8][0],
574 on_delete => $item[8][0],
575 # on_update => $item[9][0],
579 on_delete : /on delete/i WORD(s)
580 { join(' ', @{$item[2]}) }
582 UNIQUE : /unique/i { $return = 1 }
586 NAME : /\w+/ { $item[1] }
590 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
592 | /'.*?'/ # XXX doesn't handle embedded quotes
599 # -------------------------------------------------------------------
601 my ( $translator, $data ) = @_;
602 my $parser = Parse::RecDescent->new($GRAMMAR);
604 local $::RD_TRACE = $translator->trace ? 1 : undef;
605 local $DEBUG = $translator->debug;
607 unless (defined $parser) {
608 return $translator->error("Error instantiating Parse::RecDescent ".
609 "instance: Bad grammer");
612 my $result = $parser->startrule( $data );
613 die "Parse failed.\n" unless defined $result;
615 warn "Parser results =\n", Dumper($result), "\n";
618 my $schema = $translator->schema;
619 my $indices = $result->{'indices'};
620 my $constraints = $result->{'constraints'};
622 $result->{'tables'}{ $a }{'order'}
624 $result->{'tables'}{ $b }{'order'}
625 } keys %{ $result->{'tables'} };
627 for my $table_name ( @tables ) {
628 my $tdata = $result->{'tables'}{ $table_name };
629 next unless $tdata->{'table_name'};
630 my $table = $schema->add_table(
631 name => $tdata->{'table_name'},
632 comments => $tdata->{'comments'},
633 ) or die $schema->error;
635 $table->options( $tdata->{'table_options'} );
638 $tdata->{'fields'}->{$a}->{'order'}
640 $tdata->{'fields'}->{$b}->{'order'}
641 } keys %{ $tdata->{'fields'} };
643 for my $fname ( @fields ) {
644 my $fdata = $tdata->{'fields'}{ $fname };
645 my $field = $table->add_field(
646 name => $fdata->{'name'},
647 data_type => $fdata->{'data_type'},
648 size => $fdata->{'size'},
649 default_value => $fdata->{'default'},
650 is_auto_increment => $fdata->{'is_auto_inc'},
651 is_nullable => $fdata->{'null'},
652 comments => $fdata->{'comments'},
653 ) or die $table->error;
656 push @{ $tdata->{'indices'} }, @{ $indices->{ $table_name } || [] };
657 push @{ $tdata->{'constraints'} },
658 @{ $constraints->{ $table_name } || [] };
660 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
661 my $index = $table->add_index(
662 name => $idata->{'name'},
663 type => uc $idata->{'type'},
664 fields => $idata->{'fields'},
665 ) or die $table->error;
668 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
669 my $constraint = $table->add_constraint(
670 name => $cdata->{'name'},
671 type => $cdata->{'type'},
672 fields => $cdata->{'fields'},
673 reference_table => $cdata->{'reference_table'},
674 reference_fields => $cdata->{'reference_fields'},
675 match_type => $cdata->{'match_type'} || '',
676 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
677 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
678 ) or die $table->error;
682 my @procedures = sort {
683 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
684 } keys %{ $result->{procedures} };
685 foreach my $proc_name (@procedures) {
686 $schema->add_procedure(
688 owner => $result->{procedures}->{$proc_name}->{owner},
689 sql => $result->{procedures}->{$proc_name}->{sql},
694 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
695 } keys %{ $result->{views} };
696 foreach my $view_name (keys %{ $result->{views} }) {
699 sql => $result->{views}->{$view_name}->{sql},
708 # -------------------------------------------------------------------
709 # Something there is that doesn't love a wall.
711 # -------------------------------------------------------------------
717 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
721 SQL::Translator, Parse::RecDescent, DDL::Oracle.