1 package SQL::Translator::Parser::Oracle;
3 # -------------------------------------------------------------------
4 # $Id: Oracle.pm,v 1.8 2003-08-26 21:38:24 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.8 $ =~ /(\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 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 comment : /^\s*(?:#|-{2}).*\n/
216 push @table_comments, $comment;
219 comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
221 push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
224 comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
226 my $table_name = $item[4]->{'table'};
227 my $field_name = $item[4]->{'field'};
228 push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
229 $item{'comment_phrase'};
232 column_name : NAME '.' NAME
233 { $return = { table => $item[1], field => $item[3] } }
235 comment_phrase : /'.*?'/
242 field : comment(s?) field_name data_type field_meta(s?) comment(s?)
244 my ( $is_pk, $default, @constraints );
246 for my $meta ( @{ $item[4] } ) {
247 if ( $meta->{'type'} eq 'default' ) {
251 elsif ( $meta->{'type'} eq 'not_null' ) {
255 elsif ( $meta->{'type'} eq 'primary_key' ) {
259 push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
262 my @comments = ( @{ $item[1] }, @{ $item[5] } );
266 name => $item{'field_name'},
267 data_type => $item{'data_type'}{'type'},
268 size => $item{'data_type'}{'size'},
270 default => $default->{'value'},
271 is_primary_key => $is_pk,
272 constraints => [ @constraints ],
273 comments => [ @comments ],
280 data_type : ora_data_type parens_value_list(?)
284 size => $item[2][0] || '',
288 column_constraint : constraint_name(?) column_constraint_type
289 #constraint_state(s /,/)
291 my $desc = $item{'column_constraint_type'};
292 my $type = $desc->{'type'};
293 my $fields = $desc->{'fields'} || [];
294 my $expression = $desc->{'expression'} || '';
297 supertype => 'constraint',
298 name => $item{'constraint_name(?)'}[0] || '',
300 expression => $type eq 'check' ? $expression : '',
301 deferrable => $item{'deferrable'},
302 deferred => $item{'deferred'},
303 reference_table => $desc->{'reference_table'},
304 reference_fields => $desc->{'reference_fields'},
305 # match_type => $desc->{'match_type'},
306 # on_update_do => $desc->{'on_update_do'},
310 constraint_name : /constraint/i NAME { $item[2] }
312 column_constraint_type : /not null/i { $return = { type => 'not_null' } }
314 { $return = { type => 'null' } }
316 { $return = { type => 'unique' } }
318 { $return = { type => 'primary_key' } }
319 | /check/i '(' /[^)]+/ ')'
320 { $return = { type => 'check', expression => $item[2] } }
321 | /references/i table_name parens_word_list(?) on_delete_do(?)
324 type => 'foreign_key',
325 reference_table => $item[2],
326 reference_fields => $item[3][0],
327 # match_type => $item[4][0],
328 on_delete_do => $item[5][0],
332 #constraint_state : deferrable { $return = { type => $item[1] } }
333 # | deferred { $return = { type => $item[1] } }
334 # | /(no)?rely/ { $return = { type => $item[1] } }
335 # | /using/i /index/i using_index_clause
336 # { $return = { type => 'using_index', index => $item[3] }
337 # | (dis)?enable { $return = { type => $item[1] } }
338 # | (no)?validate { $return = { type => $item[1] } }
339 # | /exceptions/i /into/i table_name
340 # { $return = { type => 'exceptions_into', table => $item[3] } }
342 deferrable : /not/i /deferrable/i
343 { $return = 'not_deferrable' }
345 { $return = 'deferrable' }
347 deferred : /initially/i /(deferred|immediate)/i { $item[2] }
350 /(n?varchar2|varchar)/i { $return = 'varchar2' }
352 /n?char/i { $return = 'character' }
354 /n?dec/i { $return = 'decimal' }
356 /number/i { $return = 'number' }
358 /(pls_integer|binary_integer)/i { $return = 'integer' }
360 /interval\s+day/i { $return = 'interval_day' }
362 /interval\s+year/i { $return = 'interval_year' }
364 /long\s+raw/i { $return = 'long_raw' }
366 /(long|date|timestamp|raw|rowid|urowid|mlslabel|clob|nclob|blob|bfile)/i { $item[1] }
368 parens_value_list : '(' VALUE(s /,/) ')'
371 parens_word_list : '(' WORD(s /,/) ')'
374 field_meta : default_val
377 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
379 my $val = $item[2] || '';
382 supertype => 'constraint',
388 create_table : /create/i global_temporary(?) /table/i
390 table_option : /[^;]+/
392 table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
394 my $desc = $item{'table_constraint_type'};
395 my $type = $desc->{'type'};
396 my $fields = $desc->{'fields'};
397 my $expression = $desc->{'expression'};
398 my @comments = ( @{ $item[1] }, @{ $item[-1] } );
401 name => $item{'constraint_name(?)'}[0] || '',
402 type => 'constraint',
403 constraint_type => $type,
404 fields => $type ne 'check' ? $fields : [],
405 expression => $type eq 'check' ? $expression : '',
406 deferrable => $item{'deferrable(?)'},
407 deferred => $item{'deferred(?)'},
408 reference_table => $desc->{'reference_table'},
409 reference_fields => $desc->{'reference_fields'},
410 # match_type => $desc->{'match_type'}[0],
411 on_delete_do => $desc->{'on_delete_do'},
412 on_update_do => $desc->{'on_update_do'},
413 comments => [ @comments ],
417 table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
420 type => 'primary_key',
425 /unique/i '(' NAME(s /,/) ')'
433 /check/ '(' /(.+)/ ')'
437 expression => $item[3],
441 /foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete_do(?)
444 type => 'foreign_key',
446 reference_table => $item[6],
447 reference_fields => $item[7][0],
448 match_type => $item[8][0],
449 on_delete_do => $item[9][0],
450 on_update_do => $item[10][0],
454 on_delete_do : /on delete/i WORD(s)
459 NAME : /\w+/ { $item[1] }
463 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
465 | /'.*?'/ # XXX doesn't handle embedded quotes
472 # -------------------------------------------------------------------
474 my ( $translator, $data ) = @_;
475 $parser ||= Parse::RecDescent->new($GRAMMAR);
477 local $::RD_TRACE = $translator->trace ? 1 : undef;
478 local $DEBUG = $translator->debug;
480 unless (defined $parser) {
481 return $translator->error("Error instantiating Parse::RecDescent ".
482 "instance: Bad grammer");
485 my $result = $parser->startrule($data);
486 die "Parse failed.\n" unless defined $result;
487 warn Dumper($result) if $DEBUG;
489 my $schema = $translator->schema;
491 $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
494 for my $table_name ( @tables ) {
495 my $tdata = $result->{ $table_name };
496 my $table = $schema->add_table(
497 name => $tdata->{'table_name'},
498 comments => $tdata->{'comments'},
499 ) or die $schema->error;
502 $tdata->{'fields'}->{$a}->{'order'}
504 $tdata->{'fields'}->{$b}->{'order'}
505 } keys %{ $tdata->{'fields'} };
507 for my $fname ( @fields ) {
508 my $fdata = $tdata->{'fields'}{ $fname };
509 my $field = $table->add_field(
510 name => $fdata->{'name'},
511 data_type => $fdata->{'data_type'},
512 size => $fdata->{'size'},
513 default_value => $fdata->{'default'},
514 is_auto_increment => $fdata->{'is_auto_inc'},
515 is_nullable => $fdata->{'null'},
516 comments => $fdata->{'comments'},
517 ) or die $table->error;
519 for my $cdata ( @{ $fdata->{'constraints'} } ) {
520 next unless $cdata->{'type'} eq 'foreign_key';
521 $cdata->{'fields'} ||= [ $field->name ];
522 push @{ $tdata->{'constraints'} }, $cdata;
526 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
527 my $index = $table->add_index(
528 name => $idata->{'name'},
529 type => uc $idata->{'type'},
530 fields => $idata->{'fields'},
531 ) or die $table->error;
534 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
535 my $constraint = $table->add_constraint(
536 name => $cdata->{'name'},
537 type => $cdata->{'type'},
538 fields => $cdata->{'fields'},
539 reference_table => $cdata->{'reference_table'},
540 reference_fields => $cdata->{'reference_fields'},
541 match_type => $cdata->{'match_type'} || '',
542 on_delete => $cdata->{'on_delete_do'},
543 on_update => $cdata->{'on_update_do'},
544 ) or die $table->error;
553 # -------------------------------------------------------------------
554 # Something there is that doesn't love a wall.
556 # -------------------------------------------------------------------
562 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
566 perl(1), Parse::RecDescent.