1 package SQL::Translator::Parser::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.10 2003-08-27 02:26:16 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.10 $ =~ /(\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 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
147 my $table_name = $item{'table_name'};
148 $tables{ $table_name }{'order'} = ++$table_order;
149 $tables{ $table_name }{'table_name'} = $table_name;
151 if ( @table_comments ) {
152 $tables{ $table_name }{'comments'} = [ @table_comments ];
153 @table_comments = ();
158 for my $definition ( @{ $item[4] } ) {
159 if ( $definition->{'type'} eq 'field' ) {
160 my $field_name = $definition->{'name'};
161 $tables{ $table_name }{'fields'}{ $field_name } =
162 { %$definition, order => $i };
165 for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
166 $constraint->{'fields'} = [ $field_name ];
167 push @{ $tables{ $table_name }{'constraints'} },
171 elsif ( $definition->{'type'} eq 'constraint' ) {
172 $definition->{'type'} = $definition->{'constraint_type'};
173 # group FKs at the field level
174 # if ( $definition->{'type'} eq 'foreign_key' ) {
175 # for my $fld ( @{ $definition->{'fields'} || [] } ) {
177 # $tables{$table_name}{'fields'}{$fld}{'constraints'}
182 push @{ $tables{ $table_name }{'constraints'} },
187 push @{ $tables{ $table_name }{'indices'} }, $definition;
191 for my $option ( @{ $item[6] } ) {
192 $tables{ $table_name }{'table_options'}{ $option->{'type'} } =
199 create : /create/i /index/i WORD /on/i table_name parens_word_list ';'
201 my $table_name = $item[5];
202 push @{ $tables{ $table_name }{'indices'} }, {
205 fields => $item[6][0],
209 # Create anything else (e.g., domain, function, etc.)
210 create : /create/i WORD /[^;]+/ ';'
211 { @table_comments = () }
213 global_temporary: /global/i /temporary/i
215 table_name : NAME '.' NAME
220 create_definition : field
224 comment : /^\s*(?:#|-{2}).*\n/
226 my $comment = $item[1];
227 $comment =~ s/^\s*(#|-{2})\s*//;
228 $comment =~ s/\s*$//;
230 push @table_comments, $comment;
233 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
235 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
238 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
240 my $table_name = $item[4]->{'table'};
241 my $field_name = $item[4]->{'field'};
242 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
243 $item{'comment_phrase'};
246 column_name : NAME '.' NAME
247 { $return = { table => $item[1], field => $item[3] } }
249 comment_phrase : /'.*?'/
256 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
258 my ( $is_pk, $default, @constraints );
260 for my $meta ( @{ $item[4] } ) {
261 if ( $meta->{'type'} eq 'default' ) {
265 elsif ( $meta->{'type'} eq 'not_null' ) {
269 elsif ( $meta->{'type'} eq 'primary_key' ) {
273 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
276 my @comments = ( @{ $item[1] }, @{ $item[5] } );
280 name => $item{'field_name'},
281 data_type => $item{'data_type'}{'type'},
282 size => $item{'data_type'}{'size'},
284 default => $default->{'value'},
285 is_primary_key => $is_pk,
286 constraints => [ @constraints ],
287 comments => [ @comments ],
294 data_type : ora_data_type parens_value_list(?)
298 size => $item[2][0] || '',
302 column_constraint : constraint_name(?) column_constraint_type
303 #constraint_state(s /,/)
305 my $desc = $item{'column_constraint_type'};
306 my $type = $desc->{'type'};
307 my $fields = $desc->{'fields'} || [];
308 my $expression = $desc->{'expression'} || '';
311 supertype => 'constraint',
312 name => $item{'constraint_name(?)'}[0] || '',
314 expression => $type eq 'check' ? $expression : '',
315 deferrable => $item{'deferrable'},
316 deferred => $item{'deferred'},
317 reference_table => $desc->{'reference_table'},
318 reference_fields => $desc->{'reference_fields'},
319 # match_type => $desc->{'match_type'},
320 # on_update_do => $desc->{'on_update_do'},
324 constraint_name : /constraint/i NAME { $item[2] }
326 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
328 { $return = { type => 'null' } }
330 { $return = { type => 'unique' } }
332 { $return = { type => 'primary_key' } }
333 | /check/i '(' /[^)]+/ ')'
334 { $return = { type => 'check', expression => $item[2] } }
335 | /references/i table_name parens_word_list(?) on_delete_do(?)
338 type => 'foreign_key',
339 reference_table => $item[2],
340 reference_fields => $item[3][0],
341 # match_type => $item[4][0],
342 on_delete_do => $item[5][0],
346 #constraint_state : deferrable { $return = { type => $item[1] } }
347 # | deferred { $return = { type => $item[1] } }
348 # | /(no)?rely/ { $return = { type => $item[1] } }
349 # | /using/i /index/i using_index_clause
350 # { $return = { type => 'using_index', index => $item[3] }
351 # | (dis)?enable { $return = { type => $item[1] } }
352 # | (no)?validate { $return = { type => $item[1] } }
353 # | /exceptions/i /into/i table_name
354 # { $return = { type => 'exceptions_into', table => $item[3] } }
356 deferrable : /not/i /deferrable/i
357 { $return = 'not_deferrable' }
359 { $return = 'deferrable' }
361 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
364 /(n?varchar2|varchar)/i { $return = 'varchar2' }
366 /n?char/i { $return = 'character' }
368 /n?dec/i { $return = 'decimal' }
370 /number/i { $return = 'number' }
372 /(pls_integer|binary_integer)/i { $return = 'integer' }
374 /interval\s+day/i { $return = 'interval_day' }
376 /interval\s+year/i { $return = 'interval_year' }
378 /long\s+raw/i { $return = 'long_raw' }
380 /(long|date|timestamp|raw|rowid|urowid|mlslabel|clob|nclob|blob|bfile)/i { $item[1] }
382 parens_value_list : '(' VALUE(s /,/) ')'
385 parens_word_list : '(' WORD(s /,/) ')'
388 field_meta : default_val
391 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
394 $val =~ s/'//g if defined $val;
396 supertype => 'constraint',
402 create_table : /create/i global_temporary(?) /table/i
404 table_option : /[^;]+/
406 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
408 my $desc = $item{'table_constraint_type'};
409 my $type = $desc->{'type'};
410 my $fields = $desc->{'fields'};
411 my $expression = $desc->{'expression'};
412 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
415 name => $item{'constraint_name(?)'}[0] || '',
416 type => 'constraint',
417 constraint_type => $type,
418 fields => $type ne 'check' ? $fields : [],
419 expression => $type eq 'check' ? $expression : '',
420 deferrable => $item{'deferrable(?)'},
421 deferred => $item{'deferred(?)'},
422 reference_table => $desc->{'reference_table'},
423 reference_fields => $desc->{'reference_fields'},
424 # match_type => $desc->{'match_type'}[0],
425 on_delete_do => $desc->{'on_delete_do'},
426 on_update_do => $desc->{'on_update_do'},
427 comments => [ @comments ],
431 table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
434 type => 'primary_key',
439 /unique/i '(' NAME(s /,/) ')'
447 /check/ '(' /(.+)/ ')'
451 expression => $item[3],
455 /foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete_do(?)
458 type => 'foreign_key',
460 reference_table => $item[6],
461 reference_fields => $item[7][0],
462 match_type => $item[8][0],
463 on_delete_do => $item[9][0],
464 on_update_do => $item[10][0],
468 on_delete_do : /on delete/i WORD(s)
473 NAME : /\w+/ { $item[1] }
477 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
479 | /'.*?'/ # XXX doesn't handle embedded quotes
486 # -------------------------------------------------------------------
488 my ( $translator, $data ) = @_;
489 $parser ||= Parse::RecDescent->new($GRAMMAR);
491 local $::RD_TRACE = $translator->trace ? 1 : undef;
492 local $DEBUG = $translator->debug;
494 unless (defined $parser) {
495 return $translator->error("Error instantiating Parse::RecDescent ".
496 "instance: Bad grammer");
499 my $result = $parser->startrule($data);
500 die "Parse failed.\n" unless defined $result;
501 warn Dumper($result) if $DEBUG;
503 my $schema = $translator->schema;
505 $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
508 for my $table_name ( @tables ) {
509 my $tdata = $result->{ $table_name };
510 my $table = $schema->add_table(
511 name => $tdata->{'table_name'},
512 comments => $tdata->{'comments'},
513 ) or die $schema->error;
516 $tdata->{'fields'}->{$a}->{'order'}
518 $tdata->{'fields'}->{$b}->{'order'}
519 } keys %{ $tdata->{'fields'} };
521 for my $fname ( @fields ) {
522 my $fdata = $tdata->{'fields'}{ $fname };
523 my $field = $table->add_field(
524 name => $fdata->{'name'},
525 data_type => $fdata->{'data_type'},
526 size => $fdata->{'size'},
527 default_value => $fdata->{'default'},
528 is_auto_increment => $fdata->{'is_auto_inc'},
529 is_nullable => $fdata->{'null'},
530 comments => $fdata->{'comments'},
531 ) or die $table->error;
533 for my $cdata ( @{ $fdata->{'constraints'} } ) {
534 next unless $cdata->{'type'} eq 'foreign_key';
535 $cdata->{'fields'} ||= [ $field->name ];
536 push @{ $tdata->{'constraints'} }, $cdata;
540 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
541 my $index = $table->add_index(
542 name => $idata->{'name'},
543 type => uc $idata->{'type'},
544 fields => $idata->{'fields'},
545 ) or die $table->error;
548 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
549 my $constraint = $table->add_constraint(
550 name => $cdata->{'name'},
551 type => $cdata->{'type'},
552 fields => $cdata->{'fields'},
553 reference_table => $cdata->{'reference_table'},
554 reference_fields => $cdata->{'reference_fields'},
555 match_type => $cdata->{'match_type'} || '',
556 on_delete => $cdata->{'on_delete_do'},
557 on_update => $cdata->{'on_update_do'},
558 ) or die $table->error;
567 # -------------------------------------------------------------------
568 # Something there is that doesn't love a wall.
570 # -------------------------------------------------------------------
576 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
580 perl(1), Parse::RecDescent.