1 package SQL::Translator::Parser::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.26 2006-06-29 19:24:14 kycl4rk 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.26 $ =~ /(\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 ) }
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,
147 alter : /alter/i WORD /[^;]+/ ';'
148 { @table_comments = () }
150 drop : /drop/i TABLE ';'
152 drop : /drop/i WORD(s) ';'
153 { @table_comments = () }
155 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
157 my $table_name = $item{'table_name'};
158 $tables{ $table_name }{'order'} = ++$table_order;
159 $tables{ $table_name }{'table_name'} = $table_name;
161 if ( @table_comments ) {
162 $tables{ $table_name }{'comments'} = [ @table_comments ];
163 @table_comments = ();
168 for my $definition ( @{ $item[4] } ) {
169 if ( $definition->{'type'} eq 'field' ) {
170 my $field_name = $definition->{'name'};
171 $tables{ $table_name }{'fields'}{ $field_name } =
172 { %$definition, order => $i };
175 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
176 $constraint->{'fields'} = [ $field_name ];
177 push @{ $tables{ $table_name }{'constraints'} },
181 elsif ( $definition->{'type'} eq 'constraint' ) {
182 $definition->{'type'} = $definition->{'constraint_type'};
183 push @{ $tables{ $table_name }{'constraints'} }, $definition;
186 push @{ $tables{ $table_name }{'indices'} }, $definition;
190 for my $option ( @{ $item[6] } ) {
191 push @{ $tables{ $table_name }{'table_options'} }, $option;
197 create : create_index index_name /on/i table_name index_expr table_option(?) ';'
199 my $table_name = $item[4];
201 push @{ $constraints{ $table_name } }, {
208 push @{ $indices{ $table_name } }, {
216 index_expr: parens_word_list
218 | '(' WORD parens_word_list ')'
220 my $arg_list = join(",", @{$item[3]});
221 $return = "$item[2]($arg_list)";
224 # Create anything else (e.g., domain, function, etc.)
225 create : ...!create_table ...!create_index /create/i WORD /[^;]+/ ';'
226 { @table_comments = () }
228 create_index : /create/i UNIQUE(?) /index/i
229 { $return = $item[2] }
231 index_name : NAME '.' NAME
236 global_temporary: /global/i /temporary/i
238 table_name : NAME '.' NAME
243 create_definition : field
247 table_comment : comment
249 my $comment = $item[1];
251 push @table_comments, $comment;
254 comment : /^\s*(?:#|-{2}).*\n/
256 my $comment = $item[1];
257 $comment =~ s/^\s*(#|-{2})\s*//;
258 $comment =~ s/\s*$//;
262 comment : /\/\*/ /[^\*]+/ /\*\//
264 my $comment = $item[2];
265 $comment =~ s/^\s*|\s*$//g;
269 remark : /^REM\s+.*\n/
271 run : /^(RUN|\/)\s+.*\n/
273 prompt : /prompt/i /(table|index|sequence|trigger)/i ';'
275 prompt : /prompt\s+create\s+.*\n/i
277 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
279 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
282 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
284 my $table_name = $item[4]->{'table'};
285 my $field_name = $item[4]->{'field'};
286 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
287 $item{'comment_phrase'};
290 column_name : NAME '.' NAME
291 { $return = { table => $item[1], field => $item[3] } }
293 comment_phrase : /'.*?'/
300 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
302 my ( $is_pk, $default, @constraints );
304 for my $meta ( @{ $item[4] } ) {
305 if ( $meta->{'type'} eq 'default' ) {
309 elsif ( $meta->{'type'} eq 'not_null' ) {
313 elsif ( $meta->{'type'} eq 'primary_key' ) {
317 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
320 my @comments = ( @{ $item[1] }, @{ $item[5] } );
324 name => $item{'field_name'},
325 data_type => $item{'data_type'}{'type'},
326 size => $item{'data_type'}{'size'},
328 default => $default->{'value'},
329 is_primary_key => $is_pk,
330 constraints => [ @constraints ],
331 comments => [ @comments ],
338 data_type : ora_data_type data_size(?)
342 size => $item[2][0] || '',
346 data_size : '(' VALUE(s /,/) data_size_modifier(?) ')'
349 data_size_modifier: /byte/i
352 column_constraint : constraint_name(?) column_constraint_type constraint_state(s?)
354 my $desc = $item{'column_constraint_type'};
355 my $type = $desc->{'type'};
356 my $fields = $desc->{'fields'} || [];
357 my $expression = $desc->{'expression'} || '';
360 supertype => 'constraint',
361 name => $item{'constraint_name(?)'}[0] || '',
363 expression => $type eq 'check' ? $expression : '',
364 deferrable => $item{'deferrable'},
365 deferred => $item{'deferred'},
366 reference_table => $desc->{'reference_table'},
367 reference_fields => $desc->{'reference_fields'},
368 # match_type => $desc->{'match_type'},
369 # on_update => $desc->{'on_update'},
373 constraint_name : /constraint/i NAME { $item[2] }
375 column_constraint_type : /not\s+null/i { $return = { type => 'not_null' } }
377 { $return = { type => 'unique' } }
379 { $return = { type => 'primary_key' } }
380 | /check/i '(' /[^)]+/ ')'
381 { $return = { type => 'check', expression => $item[3] } }
382 | /references/i table_name parens_word_list(?) on_delete(?)
385 type => 'foreign_key',
386 reference_table => $item[2],
387 reference_fields => $item[3][0],
388 # match_type => $item[4][0],
389 on_delete => $item[5][0],
393 constraint_state : deferrable { $return = { type => $item[1] } }
394 | deferred { $return = { type => $item[1] } }
395 | /(no)?rely/i { $return = { type => $item[1] } }
396 # | /using/i /index/i using_index_clause
397 # { $return = { type => 'using_index', index => $item[3] } }
398 | /(dis|en)able/i { $return = { type => $item[1] } }
399 | /(no)?validate/i { $return = { type => $item[1] } }
400 | /exceptions/i /into/i table_name
401 { $return = { type => 'exceptions_into', table => $item[3] } }
403 deferrable : /not/i /deferrable/i
404 { $return = 'not_deferrable' }
406 { $return = 'deferrable' }
408 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
411 /(n?varchar2|varchar)/i { $return = 'varchar2' }
413 /n?char/i { $return = 'character' }
415 /n?dec/i { $return = 'decimal' }
417 /number/i { $return = 'number' }
419 /integer/i { $return = 'integer' }
421 /(pls_integer|binary_integer)/i { $return = 'integer' }
423 /interval\s+day/i { $return = 'interval day' }
425 /interval\s+year/i { $return = 'interval year' }
427 /long\s+raw/i { $return = 'long raw' }
429 /(long|date|timestamp|raw|rowid|urowid|mlslabel|clob|nclob|blob|bfile|float)/i { $item[1] }
431 parens_value_list : '(' VALUE(s /,/) ')'
434 parens_word_list : '(' WORD(s /,/) ')'
437 field_meta : default_val
440 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
443 $val =~ s/'//g if defined $val;
445 supertype => 'constraint',
453 supertype => 'constraint',
459 create_table : /create/i global_temporary(?) /table/i
461 table_option : /organization/i WORD
463 $return = { 'ORGANIZATION' => $item[2] }
466 table_option : /nomonitoring/i
468 $return = { 'NOMONITORING' => undef }
471 table_option : /parallel/i '(' key_value(s) ')'
473 $return = { 'PARALLEL' => $item[3] }
476 key_value : WORD VALUE
478 $return = { $item[1], $item[2] }
481 table_option : /[^;]+/
483 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) constraint_state(s?) comment(s?)
485 my $desc = $item{'table_constraint_type'};
486 my $type = $desc->{'type'};
487 my $fields = $desc->{'fields'};
488 my $expression = $desc->{'expression'};
489 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
492 name => $item{'constraint_name(?)'}[0] || '',
493 type => 'constraint',
494 constraint_type => $type,
495 fields => $type ne 'check' ? $fields : [],
496 expression => $type eq 'check' ? $expression : '',
497 deferrable => $item{'deferrable(?)'},
498 deferred => $item{'deferred(?)'},
499 reference_table => $desc->{'reference_table'},
500 reference_fields => $desc->{'reference_fields'},
501 # match_type => $desc->{'match_type'}[0],
502 on_delete => $desc->{'on_delete'} || $desc->{'on_delete_do'},
503 on_update => $desc->{'on_update'} || $desc->{'on_update_do'},
504 comments => [ @comments ],
508 table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
511 type => 'primary_key',
516 /unique/i '(' NAME(s /,/) ')'
524 /check/ '(' /(.+)/ ')'
528 expression => $item[3],
532 /foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete(?)
535 type => 'foreign_key',
537 reference_table => $item[6],
538 reference_fields => $item[7][0],
539 # match_type => $item[8][0],
540 on_delete => $item[8][0],
541 # on_update => $item[9][0],
545 on_delete : /on delete/i WORD(s)
546 { join(' ', @{$item[2]}) }
548 UNIQUE : /unique/i { $return = 1 }
552 NAME : /\w+/ { $item[1] }
556 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
558 | /'.*?'/ # XXX doesn't handle embedded quotes
565 # -------------------------------------------------------------------
567 my ( $translator, $data ) = @_;
568 my $parser = Parse::RecDescent->new($GRAMMAR);
570 local $::RD_TRACE = $translator->trace ? 1 : undef;
571 local $DEBUG = $translator->debug;
573 unless (defined $parser) {
574 return $translator->error("Error instantiating Parse::RecDescent ".
575 "instance: Bad grammer");
578 my $result = $parser->startrule( $data );
579 die "Parse failed.\n" unless defined $result;
581 warn "Parser results =\n", Dumper($result), "\n";
584 my $schema = $translator->schema;
585 my $indices = $result->{'indices'};
586 my $constraints = $result->{'constraints'};
588 $result->{'tables'}{ $a }{'order'}
590 $result->{'tables'}{ $b }{'order'}
591 } keys %{ $result->{'tables'} };
593 for my $table_name ( @tables ) {
594 my $tdata = $result->{'tables'}{ $table_name };
595 next unless $tdata->{'table_name'};
596 my $table = $schema->add_table(
597 name => $tdata->{'table_name'},
598 comments => $tdata->{'comments'},
599 ) or die $schema->error;
601 $table->options( $tdata->{'table_options'} );
604 $tdata->{'fields'}->{$a}->{'order'}
606 $tdata->{'fields'}->{$b}->{'order'}
607 } keys %{ $tdata->{'fields'} };
609 for my $fname ( @fields ) {
610 my $fdata = $tdata->{'fields'}{ $fname };
611 my $field = $table->add_field(
612 name => $fdata->{'name'},
613 data_type => $fdata->{'data_type'},
614 size => $fdata->{'size'},
615 default_value => $fdata->{'default'},
616 is_auto_increment => $fdata->{'is_auto_inc'},
617 is_nullable => $fdata->{'null'},
618 comments => $fdata->{'comments'},
619 ) or die $table->error;
622 push @{ $tdata->{'indices'} }, @{ $indices->{ $table_name } || [] };
623 push @{ $tdata->{'constraints'} },
624 @{ $constraints->{ $table_name } || [] };
626 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
627 my $index = $table->add_index(
628 name => $idata->{'name'},
629 type => uc $idata->{'type'},
630 fields => $idata->{'fields'},
631 ) or die $table->error;
634 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
635 my $constraint = $table->add_constraint(
636 name => $cdata->{'name'},
637 type => $cdata->{'type'},
638 fields => $cdata->{'fields'},
639 reference_table => $cdata->{'reference_table'},
640 reference_fields => $cdata->{'reference_fields'},
641 match_type => $cdata->{'match_type'} || '',
642 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
643 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
644 ) or die $table->error;
653 # -------------------------------------------------------------------
654 # Something there is that doesn't love a wall.
656 # -------------------------------------------------------------------
662 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
666 SQL::Translator, Parse::RecDescent, DDL::Oracle.