1 package SQL::Translator::Parser::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.13 2003-09-26 21:04:07 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
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)]
60 STORAGE storage_clause
64 idx_organized_tbl_clause:
65 storage_option(s) [PCTTHRESHOLD int]
66 [COMPRESS int|NOCOMPRESS]
67 [ [INCLUDING column_name] OVERFLOW [storage_option(s)] ]
69 nested_storage_clause:
70 NESTED TABLE nested_item STORE AS storage_table
71 [RETURN AS {LOCATOR|VALUE} ]
74 Partition_clause {ENABLE|DISABLE} ROW MOVEMENT
77 (http://www.ss64.com/ora/clause_constraint_col.html)
79 CONSTRAINT constrnt_name {UNIQUE|PRIMARY KEY} constrnt_state
81 CONSTRAINT constrnt_name CHECK(condition) constrnt_state
83 CONSTRAINT constrnt_name [NOT] NULL constrnt_state
85 CONSTRAINT constrnt_name REFERENCES [schema.]table[(column)]
86 [ON DELETE {CASCADE|SET NULL}] constrnt_state
89 [[NOT] DEFERRABLE] [INITIALLY {IMMEDIATE|DEFERRED}]
90 [RELY | NORELY] [USING INDEX using_index_clause]
91 [ENABLE|DISABLE] [VALIDATE|NOVALIDATE]
92 [EXCEPTIONS INTO [schema.]table]
97 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
98 $VERSION = sprintf "%d.%02d", q$Revision: 1.13 $ =~ /(\d+)\.(\d+)/;
99 $DEBUG = 0 unless defined $DEBUG;
102 use Parse::RecDescent;
104 use base qw(Exporter);
106 @EXPORT_OK = qw(parse);
108 # Enable warnings within the Parse::RecDescent module.
109 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
110 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
111 $::RD_HINT = 1; # Give out hints to help fix problems.
117 { my ( %tables, $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 { \%tables }
137 alter : /alter/i WORD /[^;]+/ ';'
138 { @table_comments = () }
140 drop : /drop/i TABLE ';'
142 drop : /drop/i WORD(s) ';'
143 { @table_comments = () }
145 prompt : /prompt/i create_table table_name
147 create : prompt(?) create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
149 my $table_name = $item{'table_name'};
150 $tables{ $table_name }{'order'} = ++$table_order;
151 $tables{ $table_name }{'table_name'} = $table_name;
153 if ( @table_comments ) {
154 $tables{ $table_name }{'comments'} = [ @table_comments ];
155 @table_comments = ();
160 for my $definition ( @{ $item[5] } ) {
161 if ( $definition->{'type'} eq 'field' ) {
162 my $field_name = $definition->{'name'};
163 $tables{ $table_name }{'fields'}{ $field_name } =
164 { %$definition, order => $i };
167 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
168 $constraint->{'fields'} = [ $field_name ];
169 push @{ $tables{ $table_name }{'constraints'} },
173 elsif ( $definition->{'type'} eq 'constraint' ) {
174 $definition->{'type'} = $definition->{'constraint_type'};
175 push @{ $tables{ $table_name }{'constraints'} }, $definition;
178 push @{ $tables{ $table_name }{'indices'} }, $definition;
182 for my $option ( @{ $item[7] } ) {
183 push @{ $tables{ $table_name }{'table_options'} }, $option;
189 create : /create/i /index/i WORD /on/i table_name parens_word_list ';'
191 my $table_name = $item[5];
192 push @{ $tables{ $table_name }{'indices'} }, {
195 fields => $item[6][0],
199 # Create anything else (e.g., domain, function, etc.)
200 create : /create/i WORD /[^;]+/ ';'
201 { @table_comments = () }
203 global_temporary: /global/i /temporary/i
205 table_name : NAME '.' NAME
210 create_definition : field
214 table_comment : comment
216 my $comment = $item[1];
218 push @table_comments, $comment;
221 comment : /^\s*(?:#|-{2}).*\n/
223 my $comment = $item[1];
224 $comment =~ s/^\s*(#|-{2})\s*//;
225 $comment =~ s/\s*$//;
229 comment : /\/\*/ /[^\*]+/ /\*\//
231 my $comment = $item[2];
232 $comment =~ s/^\s*|\s*$//g;
236 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
238 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
241 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
243 my $table_name = $item[4]->{'table'};
244 my $field_name = $item[4]->{'field'};
245 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
246 $item{'comment_phrase'};
249 column_name : NAME '.' NAME
250 { $return = { table => $item[1], field => $item[3] } }
252 comment_phrase : /'.*?'/
259 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
261 my ( $is_pk, $default, @constraints );
263 for my $meta ( @{ $item[4] } ) {
264 if ( $meta->{'type'} eq 'default' ) {
268 elsif ( $meta->{'type'} eq 'not_null' ) {
272 elsif ( $meta->{'type'} eq 'primary_key' ) {
276 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
279 my @comments = ( @{ $item[1] }, @{ $item[5] } );
283 name => $item{'field_name'},
284 data_type => $item{'data_type'}{'type'},
285 size => $item{'data_type'}{'size'},
287 default => $default->{'value'},
288 is_primary_key => $is_pk,
289 constraints => [ @constraints ],
290 comments => [ @comments ],
297 data_type : ora_data_type parens_value_list(?)
301 size => $item[2][0] || '',
305 column_constraint : constraint_name(?) column_constraint_type
306 #constraint_state(s /,/)
308 my $desc = $item{'column_constraint_type'};
309 my $type = $desc->{'type'};
310 my $fields = $desc->{'fields'} || [];
311 my $expression = $desc->{'expression'} || '';
314 supertype => 'constraint',
315 name => $item{'constraint_name(?)'}[0] || '',
317 expression => $type eq 'check' ? $expression : '',
318 deferrable => $item{'deferrable'},
319 deferred => $item{'deferred'},
320 reference_table => $desc->{'reference_table'},
321 reference_fields => $desc->{'reference_fields'},
322 # match_type => $desc->{'match_type'},
323 # on_update_do => $desc->{'on_update_do'},
327 constraint_name : /constraint/i NAME { $item[2] }
329 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
331 { $return = { type => 'null' } }
333 { $return = { type => 'unique' } }
335 { $return = { type => 'primary_key' } }
336 | /check/i '(' /[^)]+/ ')'
337 { $return = { type => 'check', expression => $item[2] } }
338 | /references/i table_name parens_word_list(?) on_delete_do(?)
341 type => 'foreign_key',
342 reference_table => $item[2],
343 reference_fields => $item[3][0],
344 # match_type => $item[4][0],
345 on_delete_do => $item[5][0],
349 #constraint_state : deferrable { $return = { type => $item[1] } }
350 # | deferred { $return = { type => $item[1] } }
351 # | /(no)?rely/ { $return = { type => $item[1] } }
352 # | /using/i /index/i using_index_clause
353 # { $return = { type => 'using_index', index => $item[3] }
354 # | (dis)?enable { $return = { type => $item[1] } }
355 # | (no)?validate { $return = { type => $item[1] } }
356 # | /exceptions/i /into/i table_name
357 # { $return = { type => 'exceptions_into', table => $item[3] } }
359 deferrable : /not/i /deferrable/i
360 { $return = 'not_deferrable' }
362 { $return = 'deferrable' }
364 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
367 /(n?varchar2|varchar)/i { $return = 'varchar2' }
369 /n?char/i { $return = 'character' }
371 /n?dec/i { $return = 'decimal' }
373 /number/i { $return = 'number' }
375 /(pls_integer|binary_integer)/i { $return = 'integer' }
377 /interval\s+day/i { $return = 'interval_day' }
379 /interval\s+year/i { $return = 'interval_year' }
381 /long\s+raw/i { $return = 'long_raw' }
383 /(long|date|timestamp|raw|rowid|urowid|mlslabel|clob|nclob|blob|bfile)/i { $item[1] }
385 parens_value_list : '(' VALUE(s /,/) ')'
388 parens_word_list : '(' WORD(s /,/) ')'
391 field_meta : default_val
394 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
397 $val =~ s/'//g if defined $val;
399 supertype => 'constraint',
405 create_table : /create/i global_temporary(?) /table/i
407 table_option : /organization/i WORD
409 $return = { 'ORGANIZATION' => $item[2] }
412 table_option : /nomonitoring/i
414 $return = { 'NOMONITORING' => undef }
417 table_option : /parallel/i '(' key_value(s) ')'
419 $return = { 'PARALLEL' => $item[3] }
422 key_value : WORD VALUE
424 $return = { $item[1], $item[2] }
427 table_option : /[^;]+/
429 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
431 my $desc = $item{'table_constraint_type'};
432 my $type = $desc->{'type'};
433 my $fields = $desc->{'fields'};
434 my $expression = $desc->{'expression'};
435 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
438 name => $item{'constraint_name(?)'}[0] || '',
439 type => 'constraint',
440 constraint_type => $type,
441 fields => $type ne 'check' ? $fields : [],
442 expression => $type eq 'check' ? $expression : '',
443 deferrable => $item{'deferrable(?)'},
444 deferred => $item{'deferred(?)'},
445 reference_table => $desc->{'reference_table'},
446 reference_fields => $desc->{'reference_fields'},
447 # match_type => $desc->{'match_type'}[0],
448 on_delete_do => $desc->{'on_delete_do'},
449 on_update_do => $desc->{'on_update_do'},
450 comments => [ @comments ],
454 table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
457 type => 'primary_key',
462 /unique/i '(' NAME(s /,/) ')'
470 /check/ '(' /(.+)/ ')'
474 expression => $item[3],
478 /foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete_do(?)
481 type => 'foreign_key',
483 reference_table => $item[6],
484 reference_fields => $item[7][0],
485 match_type => $item[8][0],
486 on_delete_do => $item[9][0],
487 on_update_do => $item[10][0],
491 on_delete_do : /on delete/i WORD(s)
496 NAME : /\w+/ { $item[1] }
500 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
502 | /'.*?'/ # XXX doesn't handle embedded quotes
509 # -------------------------------------------------------------------
511 my ( $translator, $data ) = @_;
512 $parser ||= Parse::RecDescent->new($GRAMMAR);
514 local $::RD_TRACE = $translator->trace ? 1 : undef;
515 local $DEBUG = $translator->debug;
517 unless (defined $parser) {
518 return $translator->error("Error instantiating Parse::RecDescent ".
519 "instance: Bad grammer");
522 my $result = $parser->startrule($data);
523 die "Parse failed.\n" unless defined $result;
524 warn Dumper($result) if $DEBUG;
526 my $schema = $translator->schema;
528 $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
531 for my $table_name ( @tables ) {
532 my $tdata = $result->{ $table_name };
533 my $table = $schema->add_table(
534 name => $tdata->{'table_name'},
535 comments => $tdata->{'comments'},
536 ) or die $schema->error;
538 $table->options( $tdata->{'table_options'} );
541 $tdata->{'fields'}->{$a}->{'order'}
543 $tdata->{'fields'}->{$b}->{'order'}
544 } keys %{ $tdata->{'fields'} };
546 for my $fname ( @fields ) {
547 my $fdata = $tdata->{'fields'}{ $fname };
548 my $field = $table->add_field(
549 name => $fdata->{'name'},
550 data_type => $fdata->{'data_type'},
551 size => $fdata->{'size'},
552 default_value => $fdata->{'default'},
553 is_auto_increment => $fdata->{'is_auto_inc'},
554 is_nullable => $fdata->{'null'},
555 comments => $fdata->{'comments'},
556 ) or die $table->error;
558 for my $cdata ( @{ $fdata->{'constraints'} } ) {
559 next unless $cdata->{'type'} eq 'foreign_key';
560 $cdata->{'fields'} ||= [ $field->name ];
561 push @{ $tdata->{'constraints'} }, $cdata;
565 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
566 my $index = $table->add_index(
567 name => $idata->{'name'},
568 type => uc $idata->{'type'},
569 fields => $idata->{'fields'},
570 ) or die $table->error;
573 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
574 my $constraint = $table->add_constraint(
575 name => $cdata->{'name'},
576 type => $cdata->{'type'},
577 fields => $cdata->{'fields'},
578 reference_table => $cdata->{'reference_table'},
579 reference_fields => $cdata->{'reference_fields'},
580 match_type => $cdata->{'match_type'} || '',
581 on_delete => $cdata->{'on_delete_do'},
582 on_update => $cdata->{'on_update_do'},
583 ) or die $table->error;
592 # -------------------------------------------------------------------
593 # Something there is that doesn't love a wall.
595 # -------------------------------------------------------------------
601 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
605 perl(1), Parse::RecDescent.