1 package SQL::Translator::Parser::Oracle;
3 # -------------------------------------------------------------------
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-2009 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 $GRAMMAR @EXPORT_OK ];
100 $DEBUG = 0 unless defined $DEBUG;
103 use Parse::RecDescent;
105 use base qw(Exporter);
107 @EXPORT_OK = qw(parse);
109 # Enable warnings within the Parse::RecDescent module.
110 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
111 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
112 $::RD_HINT = 1; # Give out hints to help fix problems.
116 { my ( %tables, %indices, %constraints, $table_order, @table_comments, %views, $view_order, %procedures, $proc_order ) }
119 # The "eofile" rule makes the parser fail if any "statement" rule
120 # fails. Otherwise, the first successful match by a "statement"
121 # won't cause the failure needed to know that the parse, as a whole,
124 startrule : statement(s) eofile
128 indices => \%indices,
129 constraints => \%constraints,
131 procedures => \%procedures,
148 alter : /alter/i WORD /[^;]+/ ';'
149 { @table_comments = () }
151 drop : /drop/i TABLE ';'
153 drop : /drop/i WORD(s) ';'
154 { @table_comments = () }
156 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
158 my $table_name = $item{'table_name'};
159 $tables{ $table_name }{'order'} = ++$table_order;
160 $tables{ $table_name }{'table_name'} = $table_name;
162 if ( @table_comments ) {
163 $tables{ $table_name }{'comments'} = [ @table_comments ];
164 @table_comments = ();
169 for my $definition ( @{ $item[4] } ) {
170 if ( $definition->{'type'} eq 'field' ) {
171 my $field_name = $definition->{'name'};
172 $tables{ $table_name }{'fields'}{ $field_name } =
173 { %$definition, order => $i };
176 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
177 $constraint->{'fields'} = [ $field_name ];
178 push @{ $tables{ $table_name }{'constraints'} },
182 elsif ( $definition->{'type'} eq 'constraint' ) {
183 $definition->{'type'} = $definition->{'constraint_type'};
184 push @{ $tables{ $table_name }{'constraints'} }, $definition;
187 push @{ $tables{ $table_name }{'indices'} }, $definition;
191 for my $option ( @{ $item[6] } ) {
192 push @{ $tables{ $table_name }{'table_options'} }, $option;
198 create : create_index index_name /on/i table_name index_expr table_option(?) ';'
200 my $table_name = $item[4];
202 push @{ $constraints{ $table_name } }, {
209 push @{ $indices{ $table_name } }, {
217 index_expr: parens_word_list
219 | '(' WORD parens_word_list ')'
221 my $arg_list = join(",", @{$item[3]});
222 $return = "$item[2]($arg_list)";
225 create : /create/i /or replace/i /procedure/i table_name not_end m#^/$#im
227 @table_comments = ();
228 my $proc_name = $item[4];
229 # Hack to strip owner from procedure name
230 $proc_name =~ s#.*\.##;
232 my $sql = "$item[1] $item[2] $item[3] $item[4] $item[5]";
234 $procedures{ $proc_name }{'order'} = ++$proc_order;
235 $procedures{ $proc_name }{'name'} = $proc_name;
236 $procedures{ $proc_name }{'owner'} = $owner;
237 $procedures{ $proc_name }{'sql'} = $sql;
240 not_end: m#.*?(?=^/$)#ism
242 create : /create/i /or replace/i /force/i /view/i table_name not_delimiter ';'
244 @table_comments = ();
245 my $view_name = $item[5];
246 # Hack to strip owner from view name
247 $view_name =~ s#.*\.##;
248 my $sql = "$item[1] $item[2] $item[3] $item[4] $item[5] $item[6] $item[7]";
250 $views{ $view_name }{'order'} = ++$view_order;
251 $views{ $view_name }{'name'} = $view_name;
252 $views{ $view_name }{'sql'} = $sql;
255 not_delimiter: /.*?(?=;)/is
257 # Create anything else (e.g., domain, function, etc.)
258 create : ...!create_table ...!create_index /create/i WORD /[^;]+/ ';'
259 { @table_comments = () }
261 create_index : /create/i UNIQUE(?) /index/i
262 { $return = @{$item[2]} }
264 index_name : NAME '.' NAME
269 global_temporary: /global/i /temporary/i
271 table_name : NAME '.' NAME
276 create_definition : field
280 table_comment : comment
282 my $comment = $item[1];
284 push @table_comments, $comment;
287 comment : /^\s*(?:#|-{2}).*\n/
289 my $comment = $item[1];
290 $comment =~ s/^\s*(#|-{2})\s*//;
291 $comment =~ s/\s*$//;
295 comment : /\/\*/ /[^\*]+/ /\*\//
297 my $comment = $item[2];
298 $comment =~ s/^\s*|\s*$//g;
302 remark : /^REM\s+.*\n/
304 run : /^(RUN|\/)\s+.*\n/
306 prompt : /prompt/i /(table|index|sequence|trigger)/i ';'
308 prompt : /prompt\s+create\s+.*\n/i
310 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
312 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
315 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
317 my $table_name = $item[4]->{'table'};
318 my $field_name = $item[4]->{'field'};
319 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
320 $item{'comment_phrase'};
323 column_name : NAME '.' NAME
324 { $return = { table => $item[1], field => $item[3] } }
326 comment_phrase : /'.*?'/
333 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
335 my ( $is_pk, $default, @constraints );
337 for my $meta ( @{ $item[4] } ) {
338 if ( $meta->{'type'} eq 'default' ) {
342 elsif ( $meta->{'type'} eq 'not_null' ) {
346 elsif ( $meta->{'type'} eq 'primary_key' ) {
350 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
353 my @comments = ( @{ $item[1] }, @{ $item[5] } );
357 name => $item{'field_name'},
358 data_type => $item{'data_type'}{'type'},
359 size => $item{'data_type'}{'size'},
361 default => $default->{'value'},
362 is_primary_key => $is_pk,
363 constraints => [ @constraints ],
364 comments => [ @comments ],
371 data_type : ora_data_type data_size(?)
375 size => $item[2][0] || '',
379 data_size : '(' VALUE(s /,/) data_size_modifier(?) ')'
382 data_size_modifier: /byte/i
385 column_constraint : constraint_name(?) column_constraint_type constraint_state(s?)
387 my $desc = $item{'column_constraint_type'};
388 my $type = $desc->{'type'};
389 my $fields = $desc->{'fields'} || [];
390 my $expression = $desc->{'expression'} || '';
393 supertype => 'constraint',
394 name => $item{'constraint_name(?)'}[0] || '',
396 expression => $type eq 'check' ? $expression : '',
397 deferrable => $item{'deferrable'},
398 deferred => $item{'deferred'},
399 reference_table => $desc->{'reference_table'},
400 reference_fields => $desc->{'reference_fields'},
401 # match_type => $desc->{'match_type'},
402 # on_update => $desc->{'on_update'},
406 constraint_name : /constraint/i NAME { $item[2] }
408 column_constraint_type : /not\s+null/i { $return = { type => 'not_null' } }
410 { $return = { type => 'unique' } }
412 { $return = { type => 'primary_key' } }
413 | /check/i '(' /[^)]+/ ')'
414 { $return = { type => 'check', expression => $item[3] } }
415 | /references/i table_name parens_word_list(?) on_delete(?)
418 type => 'foreign_key',
419 reference_table => $item[2],
420 reference_fields => $item[3][0],
421 # match_type => $item[4][0],
422 on_delete => $item[5][0],
426 constraint_state : deferrable { $return = { type => $item[1] } }
427 | deferred { $return = { type => $item[1] } }
428 | /(no)?rely/i { $return = { type => $item[1] } }
429 # | /using/i /index/i using_index_clause
430 # { $return = { type => 'using_index', index => $item[3] } }
431 | /(dis|en)able/i { $return = { type => $item[1] } }
432 | /(no)?validate/i { $return = { type => $item[1] } }
433 | /exceptions/i /into/i table_name
434 { $return = { type => 'exceptions_into', table => $item[3] } }
436 deferrable : /not/i /deferrable/i
437 { $return = 'not_deferrable' }
439 { $return = 'deferrable' }
441 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
444 /(n?varchar2|varchar)/i { $return = 'varchar2' }
446 /n?char/i { $return = 'character' }
448 /n?dec/i { $return = 'decimal' }
450 /number/i { $return = 'number' }
452 /integer/i { $return = 'integer' }
454 /(pls_integer|binary_integer)/i { $return = 'integer' }
456 /interval\s+day/i { $return = 'interval day' }
458 /interval\s+year/i { $return = 'interval year' }
460 /long\s+raw/i { $return = 'long raw' }
462 /(long|date|timestamp|raw|rowid|urowid|mlslabel|clob|nclob|blob|bfile|float|double)/i { $item[1] }
464 parens_value_list : '(' VALUE(s /,/) ')'
467 parens_word_list : '(' WORD(s /,/) ')'
470 field_meta : default_val
473 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
476 $val =~ s/'//g if defined $val;
478 supertype => 'constraint',
486 supertype => 'constraint',
492 create_table : /create/i global_temporary(?) /table/i
494 table_option : /organization/i WORD
496 $return = { 'ORGANIZATION' => $item[2] }
499 table_option : /nomonitoring/i
501 $return = { 'NOMONITORING' => undef }
504 table_option : /parallel/i '(' key_value(s) ')'
506 $return = { 'PARALLEL' => $item[3] }
509 key_value : WORD VALUE
511 $return = { $item[1], $item[2] }
514 table_option : /[^;]+/
516 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) constraint_state(s?) comment(s?)
518 my $desc = $item{'table_constraint_type'};
519 my $type = $desc->{'type'};
520 my $fields = $desc->{'fields'};
521 my $expression = $desc->{'expression'};
522 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
525 name => $item{'constraint_name(?)'}[0] || '',
526 type => 'constraint',
527 constraint_type => $type,
528 fields => $type ne 'check' ? $fields : [],
529 expression => $type eq 'check' ? $expression : '',
530 deferrable => $item{'deferrable(?)'},
531 deferred => $item{'deferred(?)'},
532 reference_table => $desc->{'reference_table'},
533 reference_fields => $desc->{'reference_fields'},
534 # match_type => $desc->{'match_type'}[0],
535 on_delete => $desc->{'on_delete'} || $desc->{'on_delete_do'},
536 on_update => $desc->{'on_update'} || $desc->{'on_update_do'},
537 comments => [ @comments ],
541 table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
544 type => 'primary_key',
549 /unique/i '(' NAME(s /,/) ')'
557 /check/ '(' /(.+)/ ')'
561 expression => $item[3],
565 /foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete(?)
568 type => 'foreign_key',
570 reference_table => $item[6],
571 reference_fields => $item[7][0],
572 # match_type => $item[8][0],
573 on_delete => $item[8][0],
574 # on_update => $item[9][0],
578 on_delete : /on delete/i WORD(s)
579 { join(' ', @{$item[2]}) }
581 UNIQUE : /unique/i { $return = 1 }
585 NAME : /\w+/ { $item[1] }
589 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
591 | /'.*?'/ # XXX doesn't handle embedded quotes
598 # -------------------------------------------------------------------
600 my ( $translator, $data ) = @_;
601 my $parser = Parse::RecDescent->new($GRAMMAR);
603 local $::RD_TRACE = $translator->trace ? 1 : undef;
604 local $DEBUG = $translator->debug;
606 unless (defined $parser) {
607 return $translator->error("Error instantiating Parse::RecDescent ".
608 "instance: Bad grammer");
611 my $result = $parser->startrule( $data );
612 die "Parse failed.\n" unless defined $result;
614 warn "Parser results =\n", Dumper($result), "\n";
617 my $schema = $translator->schema;
618 my $indices = $result->{'indices'};
619 my $constraints = $result->{'constraints'};
621 $result->{'tables'}{ $a }{'order'}
623 $result->{'tables'}{ $b }{'order'}
624 } keys %{ $result->{'tables'} };
626 for my $table_name ( @tables ) {
627 my $tdata = $result->{'tables'}{ $table_name };
628 next unless $tdata->{'table_name'};
629 my $table = $schema->add_table(
630 name => $tdata->{'table_name'},
631 comments => $tdata->{'comments'},
632 ) or die $schema->error;
634 $table->options( $tdata->{'table_options'} );
637 $tdata->{'fields'}->{$a}->{'order'}
639 $tdata->{'fields'}->{$b}->{'order'}
640 } keys %{ $tdata->{'fields'} };
642 for my $fname ( @fields ) {
643 my $fdata = $tdata->{'fields'}{ $fname };
644 my $field = $table->add_field(
645 name => $fdata->{'name'},
646 data_type => $fdata->{'data_type'},
647 size => $fdata->{'size'},
648 default_value => $fdata->{'default'},
649 is_auto_increment => $fdata->{'is_auto_inc'},
650 is_nullable => $fdata->{'null'},
651 comments => $fdata->{'comments'},
652 ) or die $table->error;
655 push @{ $tdata->{'indices'} }, @{ $indices->{ $table_name } || [] };
656 push @{ $tdata->{'constraints'} },
657 @{ $constraints->{ $table_name } || [] };
659 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
660 my $index = $table->add_index(
661 name => $idata->{'name'},
662 type => uc $idata->{'type'},
663 fields => $idata->{'fields'},
664 ) or die $table->error;
667 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
668 my $constraint = $table->add_constraint(
669 name => $cdata->{'name'},
670 type => $cdata->{'type'},
671 fields => $cdata->{'fields'},
672 reference_table => $cdata->{'reference_table'},
673 reference_fields => $cdata->{'reference_fields'},
674 match_type => $cdata->{'match_type'} || '',
675 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
676 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
677 ) or die $table->error;
681 my @procedures = sort {
682 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
683 } keys %{ $result->{procedures} };
684 foreach my $proc_name (@procedures) {
685 $schema->add_procedure(
687 owner => $result->{procedures}->{$proc_name}->{owner},
688 sql => $result->{procedures}->{$proc_name}->{sql},
693 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
694 } keys %{ $result->{views} };
695 foreach my $view_name (keys %{ $result->{views} }) {
698 sql => $result->{views}->{$view_name}->{sql},
707 # -------------------------------------------------------------------
708 # Something there is that doesn't love a wall.
710 # -------------------------------------------------------------------
716 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
720 SQL::Translator, Parse::RecDescent, DDL::Oracle.