[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Parser / Oracle.pm

package SQL::Translator::Parser::Oracle;

# -------------------------------------------------------------------
# $Id: Oracle.pm,v 1.9 2003-08-26 21:50:03 kycl4rk Exp $
# -------------------------------------------------------------------
# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# 02111-1307  USA
# -------------------------------------------------------------------

=head1 NAME

SQL::Translator::Parser::Oracle - parser for Oracle

=head1 SYNOPSIS

  use SQL::Translator;
  use SQL::Translator::Parser::Oracle;

  my $translator = SQL::Translator->new;
  $translator->parser("SQL::Translator::Parser::Oracle");

=head1 DESCRIPTION

From http://www.ss64.com/ora/table_c.html:

 CREATE [GLOBAL TEMPORARY] TABLE [schema.]table (tbl_defs,...)
     [ON COMMIT {DELETE|PRESERVE} ROWS]
         [storage_options | CLUSTER cluster_name (col1, col2,... )
            | ORGANIZATION {HEAP [storage_options] 
            | INDEX idx_organized_tbl_clause}]
               [LOB_storage_clause][varray_clause][nested_storage_clause]
                   partitioning_options
                      [[NO]CACHE] [[NO]MONITORING] [PARALLEL parallel_clause]
                         [ENABLE enable_clause | DISABLE disable_clause]
                             [AS subquery]

tbl_defs:
   column datatype [DEFAULT expr] [column_constraint(s)]
   table_constraint
   table_ref_constraint

storage_options:
   PCTFREE int
   PCTUSED int
   INITTRANS int
   MAXTRANS int
   STORAGE storage_clause
   TABLESPACE tablespace
   [LOGGING|NOLOGGING]

idx_organized_tbl_clause:
   storage_option(s) [PCTTHRESHOLD int]
     [COMPRESS int|NOCOMPRESS]
         [ [INCLUDING column_name] OVERFLOW [storage_option(s)] ]

nested_storage_clause:
   NESTED TABLE nested_item STORE AS storage_table
      [RETURN AS {LOCATOR|VALUE} ]

partitioning_options:
   Partition_clause {ENABLE|DISABLE} ROW MOVEMENT

Column Constraints
(http://www.ss64.com/ora/clause_constraint_col.html)

   CONSTRAINT constrnt_name {UNIQUE|PRIMARY KEY} constrnt_state

   CONSTRAINT constrnt_name CHECK(condition) constrnt_state

   CONSTRAINT constrnt_name [NOT] NULL constrnt_state

   CONSTRAINT constrnt_name REFERENCES [schema.]table[(column)]
      [ON DELETE {CASCADE|SET NULL}] constrnt_state

constrnt_state   
    [[NOT] DEFERRABLE] [INITIALLY {IMMEDIATE|DEFERRED}]
       [RELY | NORELY] [USING INDEX using_index_clause]
          [ENABLE|DISABLE] [VALIDATE|NOVALIDATE]
              [EXCEPTIONS INTO [schema.]table]

=cut

use strict;
use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
$VERSION = sprintf "%d.%02d", q$Revision: 1.9 $ =~ /(\d+)\.(\d+)/;
$DEBUG   = 0 unless defined $DEBUG;

use Data::Dumper;
use Parse::RecDescent;
use Exporter;
use base qw(Exporter);

@EXPORT_OK = qw(parse);

# Enable warnings within the Parse::RecDescent module.
$::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
$::RD_WARN   = 1; # Enable warnings. This will warn on unused rules &c.
$::RD_HINT   = 1; # Give out hints to help fix problems.

my $parser; 

$GRAMMAR = q!

{ my ( %tables, $table_order, @table_comments ) }

#
# The "eofile" rule makes the parser fail if any "statement" rule
# fails.  Otherwise, the first successful match by a "statement" 
# won't cause the failure needed to know that the parse, as a whole,
# failed. -ky
#
startrule : statement(s) eofile { \%tables }

eofile : /^\Z/

statement : create
    | comment
    | comment_on_table
    | comment_on_column
    | alter
    | drop
    | <error>

alter : /alter/i WORD /[^;]+/ ';'
    { @table_comments = () }

drop : /drop/i TABLE ';'

drop : /drop/i WORD(s) ';'
    { @table_comments = () }

create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
    {
        my $table_name                       = $item{'table_name'};
        $tables{ $table_name }{'order'}      = ++$table_order;
        $tables{ $table_name }{'table_name'} = $table_name;

        if ( @table_comments ) {
            $tables{ $table_name }{'comments'} = [ @table_comments ];
            @table_comments = ();
        }

        my $i = 1;
        my @constraints;
        for my $definition ( @{ $item[4] } ) {
            if ( $definition->{'type'} eq 'field' ) {
                my $field_name = $definition->{'name'};
                $tables{ $table_name }{'fields'}{ $field_name } = 
                    { %$definition, order => $i };
                $i++;
				
                for my $constraint ( @{ $definition->{'constraints'} || [] } ) {
                    $constraint->{'fields'} = [ $field_name ];
                    push @{ $tables{ $table_name }{'constraints'} }, 
                        $constraint;
                }
            }
            elsif ( $definition->{'type'} eq 'constraint' ) {
                $definition->{'type'} = $definition->{'constraint_type'};
                # group FKs at the field level
#                if ( $definition->{'type'} eq 'foreign_key' ) {
#                    for my $fld ( @{ $definition->{'fields'} || [] } ) {
#                        push @{ 
#                            $tables{$table_name}{'fields'}{$fld}{'constraints'}
#                        }, $definition;
#                    }
#                }
#                else {
                    push @{ $tables{ $table_name }{'constraints'} }, 
                        $definition;
#                }
            }
            else {
                push @{ $tables{ $table_name }{'indices'} }, $definition;
            }
        }

        for my $option ( @{ $item[6] } ) {
            $tables{ $table_name }{'table_options'}{ $option->{'type'} } = 
                $option;
        }

        1;
    }

# Create anything else (e.g., domain, function, etc.)
create : /create/i WORD /[^;]+/ ';'
    { @table_comments = () }

global_temporary: /global/i /temporary/i

table_name : NAME '.' NAME
    { $item[3] }
    | NAME 
    { $item[1] }

create_definition : field
    | table_constraint
    | <error>

comment : /^\s*(?:#|-{2}).*\n/
    {
        my $comment =  $item[1];
        $comment    =~ s/^\s*(#|-{2})\s*//;
        $comment    =~ s/\s*$//;
        $return     = $comment;
        push @table_comments, $comment;
    }

comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
    {
        push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
    }

comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
    {
        my $table_name = $item[4]->{'table'};
        my $field_name = $item[4]->{'field'};
        push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} }, 
            $item{'comment_phrase'};
    }

column_name : NAME '.' NAME
    { $return = { table => $item[1], field => $item[3] } }

comment_phrase : /'.*?'/ 
    { 
        my $val = $item[1];
        $val =~ s/^'|'$//g;
        $return = $val;
    }

field : comment(s?) field_name data_type field_meta(s?) comment(s?)
    {
        my ( $is_pk, $default, @constraints );
        my $null = 1;
        for my $meta ( @{ $item[4] } ) {
            if ( $meta->{'type'} eq 'default' ) {
                $default = $meta;
                next;
            }
            elsif ( $meta->{'type'} eq 'not_null' ) {
                $null = 0;
                next;
            }
            elsif ( $meta->{'type'} eq 'primary_key' ) {
                $is_pk = 1;
            }

            push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
        }

        my @comments = ( @{ $item[1] }, @{ $item[5] } );

        $return = { 
            type           => 'field',
            name           => $item{'field_name'}, 
            data_type      => $item{'data_type'}{'type'},
            size           => $item{'data_type'}{'size'},
            null           => $null,
            default        => $default->{'value'},
            is_primary_key => $is_pk,
            constraints    => [ @constraints ],
            comments       => [ @comments ],
        } 
    }
    | <error>

field_name : NAME

data_type : ora_data_type parens_value_list(?)
    { 
        $return  = { 
            type => $item[1],
            size => $item[2][0] || '',
        } 
    }

column_constraint : constraint_name(?) column_constraint_type 
#constraint_state(s /,/)
    {
        my $desc       = $item{'column_constraint_type'};
        my $type       = $desc->{'type'};
        my $fields     = $desc->{'fields'}     || [];
        my $expression = $desc->{'expression'} || '';

        $return              =  {
            supertype        => 'constraint',
            name             => $item{'constraint_name(?)'}[0] || '',
            type             => $type,
            expression       => $type eq 'check' ? $expression : '',
            deferrable       => $item{'deferrable'},
            deferred         => $item{'deferred'},
            reference_table  => $desc->{'reference_table'},
            reference_fields => $desc->{'reference_fields'},
#            match_type       => $desc->{'match_type'},
#            on_update_do     => $desc->{'on_update_do'},
        } 
    }

constraint_name : /constraint/i NAME { $item[2] }

column_constraint_type : /not null/i { $return = { type => 'not_null' } }
    | /null/ 
        { $return = { type => 'null' } }
    | /unique/ 
        { $return = { type => 'unique' } }
    | /primary key/i 
        { $return = { type => 'primary_key' } }
    | /check/i '(' /[^)]+/ ')' 
        { $return = { type => 'check', expression => $item[2] } }
    | /references/i table_name parens_word_list(?) on_delete_do(?) 
    {
        $return              =  {
            type             => 'foreign_key',
            reference_table  => $item[2],
            reference_fields => $item[3][0],
#            match_type       => $item[4][0],
            on_delete_do     => $item[5][0],
        }
    }

#constraint_state : deferrable { $return = { type => $item[1] } }
#    | deferred { $return = { type => $item[1] } }
#    | /(no)?rely/ { $return = { type => $item[1] } }
#    | /using/i /index/i using_index_clause 
#        { $return = { type => 'using_index', index => $item[3] }
#    | (dis)?enable { $return = { type => $item[1] } }
#    | (no)?validate { $return = { type => $item[1] } }
#    | /exceptions/i /into/i table_name 
#        { $return = { type => 'exceptions_into', table => $item[3] } }

deferrable : /not/i /deferrable/i 
    { $return = 'not_deferrable' }
    | /deferrable/i 
    { $return = 'deferrable' }

deferred : /initially/i /(deferred|immediate)/i { $item[2] }

ora_data_type :
    /(n?varchar2|varchar)/i { $return = 'varchar2' }
    |
    /n?char/i { $return = 'character' }
    |
	/n?dec/i { $return = 'decimal' }
	|
    /number/i { $return = 'number' }
    |
    /(pls_integer|binary_integer)/i { $return = 'integer' }
    |
    /interval\s+day/i { $return = 'interval_day' }
    |
    /interval\s+year/i { $return = 'interval_year' }
    |
    /long\s+raw/i { $return = 'long_raw' }
    |
    /(long|date|timestamp|raw|rowid|urowid|mlslabel|clob|nclob|blob|bfile)/i { $item[1] }

parens_value_list : '(' VALUE(s /,/) ')'
    { $item[2] }

parens_word_list : '(' WORD(s /,/) ')'
    { $item[2] }

field_meta : default_val
    | column_constraint

default_val  : /default/i /(?:')?[\w\d.-]*(?:')?/ 
    { 
        my $val =  $item[2] || '';
        $val    =~ s/'//g; 
        $return =  {
            supertype => 'constraint',
            type      => 'default',
            value     => $val,
        }
    }

create_table : /create/i global_temporary(?) /table/i

table_option : /[^;]+/

table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
    {
        my $desc       = $item{'table_constraint_type'};
        my $type       = $desc->{'type'};
        my $fields     = $desc->{'fields'};
        my $expression = $desc->{'expression'};
        my @comments   = ( @{ $item[1] }, @{ $item[-1] } );

        $return              =  {
            name             => $item{'constraint_name(?)'}[0] || '',
            type             => 'constraint',
            constraint_type  => $type,
            fields           => $type ne 'check' ? $fields : [],
            expression       => $type eq 'check' ? $expression : '',
            deferrable       => $item{'deferrable(?)'},
            deferred         => $item{'deferred(?)'},
            reference_table  => $desc->{'reference_table'},
            reference_fields => $desc->{'reference_fields'},
#            match_type       => $desc->{'match_type'}[0],
            on_delete_do     => $desc->{'on_delete_do'},
            on_update_do     => $desc->{'on_update_do'},
            comments         => [ @comments ],
        } 
    }

table_constraint_type : /primary key/i '(' NAME(s /,/) ')' 
    { 
        $return = {
            type   => 'primary_key',
            fields => $item[3],
        }
    }
    |
    /unique/i '(' NAME(s /,/) ')' 
    { 
        $return    =  {
            type   => 'unique',
            fields => $item[3],
        }
    }
    |
    /check/ '(' /(.+)/ ')'
    {
        $return        =  {
            type       => 'check',
            expression => $item[3],
        }
    }
    |
    /foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete_do(?)
    {
        $return              =  {
            type             => 'foreign_key',
            fields           => $item[3],
            reference_table  => $item[6],
            reference_fields => $item[7][0],
            match_type       => $item[8][0],
            on_delete_do     => $item[9][0],
            on_update_do     => $item[10][0],
        }
    }

on_delete_do : /on delete/i WORD(s)
    { $item[2] }

WORD : /\w+/

NAME : /\w+/ { $item[1] }

TABLE : /table/i

VALUE   : /[-+]?\.?\d+(?:[eE]\d+)?/
    { $item[1] }
    | /'.*?'/   # XXX doesn't handle embedded quotes
    { $item[1] }
    | /NULL/
    { 'NULL' }

!;

# -------------------------------------------------------------------
sub parse {
    my ( $translator, $data ) = @_;
    $parser ||= Parse::RecDescent->new($GRAMMAR);

    local $::RD_TRACE = $translator->trace ? 1 : undef;
    local $DEBUG      = $translator->debug;

    unless (defined $parser) {
        return $translator->error("Error instantiating Parse::RecDescent ".
            "instance: Bad grammer");
    }

    my $result = $parser->startrule($data);
    die "Parse failed.\n" unless defined $result;
    warn Dumper($result) if $DEBUG;

    my $schema = $translator->schema;
    my @tables = sort { 
        $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
    } keys %{ $result };

    for my $table_name ( @tables ) {
        my $tdata    =  $result->{ $table_name };
        my $table    =  $schema->add_table( 
            name     => $tdata->{'table_name'},
            comments => $tdata->{'comments'},
        ) or die $schema->error;

        my @fields = sort { 
            $tdata->{'fields'}->{$a}->{'order'} 
            <=>
            $tdata->{'fields'}->{$b}->{'order'}
        } keys %{ $tdata->{'fields'} };

        for my $fname ( @fields ) {
            my $fdata = $tdata->{'fields'}{ $fname };
            my $field = $table->add_field(
                name              => $fdata->{'name'},
                data_type         => $fdata->{'data_type'},
                size              => $fdata->{'size'},
                default_value     => $fdata->{'default'},
                is_auto_increment => $fdata->{'is_auto_inc'},
                is_nullable       => $fdata->{'null'},
                comments          => $fdata->{'comments'},
            ) or die $table->error;

            for my $cdata ( @{ $fdata->{'constraints'} } ) {
                next unless $cdata->{'type'} eq 'foreign_key';
                $cdata->{'fields'} ||= [ $field->name ];
                push @{ $tdata->{'constraints'} }, $cdata;
            }
        }

        for my $idata ( @{ $tdata->{'indices'} || [] } ) {
            my $index  =  $table->add_index(
                name   => $idata->{'name'},
                type   => uc $idata->{'type'},
                fields => $idata->{'fields'},
            ) or die $table->error;
        }

        for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
            my $constraint       =  $table->add_constraint(
                name             => $cdata->{'name'},
                type             => $cdata->{'type'},
                fields           => $cdata->{'fields'},
                reference_table  => $cdata->{'reference_table'},
                reference_fields => $cdata->{'reference_fields'},
                match_type       => $cdata->{'match_type'} || '',
                on_delete        => $cdata->{'on_delete_do'},
                on_update        => $cdata->{'on_update_do'},
            ) or die $table->error;
        }
    }

    return 1;
}

1;

# -------------------------------------------------------------------
# Something there is that doesn't love a wall.
# Robert Frost
# -------------------------------------------------------------------

=pod

=head1 AUTHOR

Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.

=head1 SEE ALSO

perl(1), Parse::RecDescent.

=cut
Commit	Line	Data
17cae8ab	1	package SQL::Translator::Parser::Oracle;
	2
	3	# -------------------------------------------------------------------
39129b47	4	# $Id: Oracle.pm,v 1.9 2003-08-26 21:50:03 kycl4rk Exp $
17cae8ab	5	# -------------------------------------------------------------------
	6	# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
	7	#
	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.
	11	#
	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.
	16	#
	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
	20	# 02111-1307 USA
	21	# -------------------------------------------------------------------
	22
	23	=head1 NAME
	24
	25	SQL::Translator::Parser::Oracle - parser for Oracle
	26
	27	=head1 SYNOPSIS
	28
	29	use SQL::Translator;
	30	use SQL::Translator::Parser::Oracle;
	31
	32	my $translator = SQL::Translator->new;
	33	$translator->parser("SQL::Translator::Parser::Oracle");
	34
	35	=head1 DESCRIPTION
	36
	37	From http://www.ss64.com/ora/table_c.html:
	38
	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]
	45	partitioning_options
	46	[[NO]CACHE] [[NO]MONITORING] [PARALLEL parallel_clause]
	47	[ENABLE enable_clause \| DISABLE disable_clause]
	48	[AS subquery]
	49
	50	tbl_defs:
	51	column datatype [DEFAULT expr] [column_constraint(s)]
	52	table_constraint
	53	table_ref_constraint
	54
	55	storage_options:
	56	PCTFREE int
	57	PCTUSED int
	58	INITTRANS int
	59	MAXTRANS int
	60	STORAGE storage_clause
	61	TABLESPACE tablespace
	62	[LOGGING\|NOLOGGING]
	63
	64	idx_organized_tbl_clause:
	65	storage_option(s) [PCTTHRESHOLD int]
	66	[COMPRESS int\|NOCOMPRESS]
	67	[ [INCLUDING column_name] OVERFLOW [storage_option(s)] ]
	68
69	nested_storage_clause:
70	NESTED TABLE nested_item STORE AS storage_table
71	[RETURN AS {LOCATOR\|VALUE} ]
72
73	partitioning_options:
74	Partition_clause {ENABLE\|DISABLE} ROW MOVEMENT
75
76	Column Constraints
77	(http://www.ss64.com/ora/clause_constraint_col.html)
78
79	CONSTRAINT constrnt_name {UNIQUE\|PRIMARY KEY} constrnt_state
80
81	CONSTRAINT constrnt_name CHECK(condition) constrnt_state
82
83	CONSTRAINT constrnt_name [NOT] NULL constrnt_state
84
85	CONSTRAINT constrnt_name REFERENCES [schema.]table[(column)]
86	[ON DELETE {CASCADE\|SET NULL}] constrnt_state
87
88	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]
93
94	=cut
95
96	use strict;
97	use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
39129b47	98	$VERSION = sprintf "%d.%02d", q$Revision: 1.9 $ =~ /(\d+)\.(\d+)/;
17cae8ab	99	$DEBUG = 0 unless defined $DEBUG;
	100
	101	use Data::Dumper;
	102	use Parse::RecDescent;
	103	use Exporter;
	104	use base qw(Exporter);
	105
	106	@EXPORT_OK = qw(parse);
	107
	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.
	112
	113	my $parser;
	114
	115	$GRAMMAR = q!
	116
067e3cf4	117	{ my ( %tables, $table_order, @table_comments ) }
17cae8ab	118
	119	#
	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,
	123	# failed. -ky
	124	#
	125	startrule : statement(s) eofile { \%tables }
	126
	127	eofile : /^\Z/
	128
	129	statement : create
067e3cf4	130	\| comment
	131	\| comment_on_table
	132	\| comment_on_column
	133	\| alter
	134	\| drop
	135	\| <error>
17cae8ab	136
44567b47	137	alter : /alter/i WORD /[^;]+/ ';'
067e3cf4	138	{ @table_comments = () }
	139
	140	drop : /drop/i TABLE ';'
	141
	142	drop : /drop/i WORD(s) ';'
	143	{ @table_comments = () }
44567b47	144
17cae8ab	145	create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
	146	{
	147	my $table_name = $item{'table_name'};
	148	$tables{ $table_name }{'order'} = ++$table_order;
	149	$tables{ $table_name }{'table_name'} = $table_name;
	150
067e3cf4	151	if ( @table_comments ) {
	152	$tables{ $table_name }{'comments'} = [ @table_comments ];
	153	@table_comments = ();
	154	}
	155
17cae8ab	156	my $i = 1;
	157	my @constraints;
	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 };
	163	$i++;
	164
17cae8ab	165	for my $constraint ( @{ $definition->{'constraints'} \|\| [] } ) {
	166	$constraint->{'fields'} = [ $field_name ];
	167	push @{ $tables{ $table_name }{'constraints'} },
	168	$constraint;
	169	}
	170	}
	171	elsif ( $definition->{'type'} eq 'constraint' ) {
	172	$definition->{'type'} = $definition->{'constraint_type'};
	173	# group FKs at the field level
947dfd86	174	# if ( $definition->{'type'} eq 'foreign_key' ) {
	175	# for my $fld ( @{ $definition->{'fields'} \|\| [] } ) {
	176	# push @{
	177	# $tables{$table_name}{'fields'}{$fld}{'constraints'}
	178	# }, $definition;
	179	# }
	180	# }
	181	# else {
17cae8ab	182	push @{ $tables{ $table_name }{'constraints'} },
17cae8ab	183	$definition;
947dfd86	184	# }
17cae8ab	185	}
	186	else {
	187	push @{ $tables{ $table_name }{'indices'} }, $definition;
	188	}
	189	}
	190
	191	for my $option ( @{ $item[6] } ) {
	192	$tables{ $table_name }{'table_options'}{ $option->{'type'} } =
	193	$option;
	194	}
	195
	196	1;
	197	}
	198
	199	# Create anything else (e.g., domain, function, etc.)
	200	create : /create/i WORD /[^;]+/ ';'
067e3cf4	201	{ @table_comments = () }
17cae8ab	202
	203	global_temporary: /global/i /temporary/i
	204
	205	table_name : NAME '.' NAME
	206	{ $item[3] }
	207	\| NAME
	208	{ $item[1] }
	209
	210	create_definition : field
	211	\| table_constraint
	212	\| <error>
	213
	214	comment : /^\s(?:#\|-{2}).\n/
067e3cf4	215	{
39129b47	216	my $comment = $item[1];
	217	$comment =~ s/^\s(#\|-{2})\s//;
	218	$comment =~ s/\s*$//;
	219	$return = $comment;
067e3cf4	220	push @table_comments, $comment;
067e3cf4	221	}
17cae8ab	222
947dfd86	223	comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
17cae8ab	224	{
947dfd86	225	push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
17cae8ab	226	}
17cae8ab	227
947dfd86	228	comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
17cae8ab	229	{
	230	my $table_name = $item[4]->{'table'};
	231	my $field_name = $item[4]->{'field'};
	232	push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
947dfd86	233	$item{'comment_phrase'};
17cae8ab	234	}
	235
	236	column_name : NAME '.' NAME
	237	{ $return = { table => $item[1], field => $item[3] } }
	238
947dfd86	239	comment_phrase : /'.*?'/
	240	{
	241	my $val = $item[1];
	242	$val =~ s/^'\|'$//g;
	243	$return = $val;
	244	}
17cae8ab	245
	246	field : comment(s?) field_name data_type field_meta(s?) comment(s?)
	247	{
947dfd86	248	my ( $is_pk, $default, @constraints );
947dfd86	249	my $null = 1;
17cae8ab	250	for my $meta ( @{ $item[4] } ) {
947dfd86	251	if ( $meta->{'type'} eq 'default' ) {
	252	$default = $meta;
	253	next;
	254	}
	255	elsif ( $meta->{'type'} eq 'not_null' ) {
	256	$null = 0;
	257	next;
	258	}
	259	elsif ( $meta->{'type'} eq 'primary_key' ) {
	260	$is_pk = 1;
	261	}
	262
	263	push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
17cae8ab	264	}
17cae8ab	265
947dfd86	266	my @comments = ( @{ $item[1] }, @{ $item[5] } );
17cae8ab	267
	268	$return = {
	269	type => 'field',
	270	name => $item{'field_name'},
	271	data_type => $item{'data_type'}{'type'},
	272	size => $item{'data_type'}{'size'},
17cae8ab	273	null => $null,
17cae8ab	274	default => $default->{'value'},
947dfd86	275	is_primary_key => $is_pk,
17cae8ab	276	constraints => [ @constraints ],
947dfd86	277	comments => [ @comments ],
17cae8ab	278	}
	279	}
	280	\| <error>
	281
	282	field_name : NAME
	283
	284	data_type : ora_data_type parens_value_list(?)
	285	{
	286	$return = {
	287	type => $item[1],
	288	size => $item[2][0] \|\| '',
	289	}
	290	}
	291
	292	column_constraint : constraint_name(?) column_constraint_type
	293	#constraint_state(s /,/)
	294	{
	295	my $desc = $item{'column_constraint_type'};
	296	my $type = $desc->{'type'};
	297	my $fields = $desc->{'fields'} \|\| [];
	298	my $expression = $desc->{'expression'} \|\| '';
	299
	300	$return = {
947dfd86	301	supertype => 'constraint',
947dfd86	302	name => $item{'constraint_name(?)'}[0] \|\| '',
17cae8ab	303	type => $type,
17cae8ab	304	expression => $type eq 'check' ? $expression : '',
40c5e2f4	305	deferrable => $item{'deferrable'},
17cae8ab	306	deferred => $item{'deferred'},
	307	reference_table => $desc->{'reference_table'},
	308	reference_fields => $desc->{'reference_fields'},
	309	# match_type => $desc->{'match_type'},
	310	# on_update_do => $desc->{'on_update_do'},
	311	}
	312	}
	313
	314	constraint_name : /constraint/i NAME { $item[2] }
	315
	316	column_constraint_type : /not null/i { $return = { type => 'not_null' } }
947dfd86	317	\| /null/
17cae8ab	318	{ $return = { type => 'null' } }
947dfd86	319	\| /unique/
17cae8ab	320	{ $return = { type => 'unique' } }
947dfd86	321	\| /primary key/i
17cae8ab	322	{ $return = { type => 'primary_key' } }
947dfd86	323	\| /check/i '(' /[^)]+/ ')'
17cae8ab	324	{ $return = { type => 'check', expression => $item[2] } }
947dfd86	325	\| /references/i table_name parens_word_list(?) on_delete_do(?)
17cae8ab	326	{
	327	$return = {
	328	type => 'foreign_key',
	329	reference_table => $item[2],
	330	reference_fields => $item[3][0],
	331	# match_type => $item[4][0],
	332	on_delete_do => $item[5][0],
	333	}
	334	}
	335
	336	#constraint_state : deferrable { $return = { type => $item[1] } }
	337	# \| deferred { $return = { type => $item[1] } }
	338	# \| /(no)?rely/ { $return = { type => $item[1] } }
	339	# \| /using/i /index/i using_index_clause
	340	# { $return = { type => 'using_index', index => $item[3] }
	341	# \| (dis)?enable { $return = { type => $item[1] } }
	342	# \| (no)?validate { $return = { type => $item[1] } }
	343	# \| /exceptions/i /into/i table_name
	344	# { $return = { type => 'exceptions_into', table => $item[3] } }
	345
	346	deferrable : /not/i /deferrable/i
	347	{ $return = 'not_deferrable' }
	348	\| /deferrable/i
	349	{ $return = 'deferrable' }
	350
	351	deferred : /initially/i /(deferred\|immediate)/i { $item[2] }
	352
	353	ora_data_type :
947dfd86	354	/(n?varchar2\|varchar)/i { $return = 'varchar2' }
17cae8ab	355	\|
	356	/n?char/i { $return = 'character' }
	357	\|
00e41431	358	/n?dec/i { $return = 'decimal' }
00e41431	359	\|
17cae8ab	360	/number/i { $return = 'number' }
	361	\|
	362	/(pls_integer\|binary_integer)/i { $return = 'integer' }
	363	\|
	364	/interval\s+day/i { $return = 'interval_day' }
	365	\|
	366	/interval\s+year/i { $return = 'interval_year' }
	367	\|
	368	/long\s+raw/i { $return = 'long_raw' }
	369	\|
	370	/(long\|date\|timestamp\|raw\|rowid\|urowid\|mlslabel\|clob\|nclob\|blob\|bfile)/i { $item[1] }
	371
	372	parens_value_list : '(' VALUE(s /,/) ')'
	373	{ $item[2] }
	374
	375	parens_word_list : '(' WORD(s /,/) ')'
	376	{ $item[2] }
	377
	378	field_meta : default_val
947dfd86	379	\| column_constraint
17cae8ab	380
	381	default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
	382	{
	383	my $val = $item[2] \|\| '';
	384	$val =~ s/'//g;
	385	$return = {
947dfd86	386	supertype => 'constraint',
947dfd86	387	type => 'default',
17cae8ab	388	value => $val,
	389	}
	390	}
	391
	392	create_table : /create/i global_temporary(?) /table/i
	393
	394	table_option : /[^;]+/
	395
	396	table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
	397	{
	398	my $desc = $item{'table_constraint_type'};
	399	my $type = $desc->{'type'};
	400	my $fields = $desc->{'fields'};
	401	my $expression = $desc->{'expression'};
	402	my @comments = ( @{ $item[1] }, @{ $item[-1] } );
	403
	404	$return = {
947dfd86	405	name => $item{'constraint_name(?)'}[0] \|\| '',
17cae8ab	406	type => 'constraint',
	407	constraint_type => $type,
	408	fields => $type ne 'check' ? $fields : [],
	409	expression => $type eq 'check' ? $expression : '',
40c5e2f4	410	deferrable => $item{'deferrable(?)'},
947dfd86	411	deferred => $item{'deferred(?)'},
17cae8ab	412	reference_table => $desc->{'reference_table'},
	413	reference_fields => $desc->{'reference_fields'},
	414	# match_type => $desc->{'match_type'}[0],
	415	on_delete_do => $desc->{'on_delete_do'},
	416	on_update_do => $desc->{'on_update_do'},
	417	comments => [ @comments ],
	418	}
	419	}
	420
	421	table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
	422	{
	423	$return = {
	424	type => 'primary_key',
	425	fields => $item[3],
	426	}
	427	}
	428	\|
	429	/unique/i '(' NAME(s /,/) ')'
	430	{
	431	$return = {
	432	type => 'unique',
	433	fields => $item[3],
	434	}
	435	}
	436	\|
	437	/check/ '(' /(.+)/ ')'
	438	{
	439	$return = {
	440	type => 'check',
	441	expression => $item[3],
	442	}
	443	}
	444	\|
	445	/foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete_do(?)
	446	{
	447	$return = {
	448	type => 'foreign_key',
	449	fields => $item[3],
	450	reference_table => $item[6],
	451	reference_fields => $item[7][0],
	452	match_type => $item[8][0],
	453	on_delete_do => $item[9][0],
	454	on_update_do => $item[10][0],
	455	}
	456	}
	457
	458	on_delete_do : /on delete/i WORD(s)
	459	{ $item[2] }
	460
	461	WORD : /\w+/
	462
	463	NAME : /\w+/ { $item[1] }
	464
067e3cf4	465	TABLE : /table/i
067e3cf4	466
17cae8ab	467	VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
	468	{ $item[1] }
	469	\| /'.*?'/ # XXX doesn't handle embedded quotes
	470	{ $item[1] }
	471	\| /NULL/
	472	{ 'NULL' }
	473
	474	!;
	475
	476	# -------------------------------------------------------------------
	477	sub parse {
	478	my ( $translator, $data ) = @_;
	479	$parser \|\|= Parse::RecDescent->new($GRAMMAR);
	480
	481	local $::RD_TRACE = $translator->trace ? 1 : undef;
	482	local $DEBUG = $translator->debug;
	483
	484	unless (defined $parser) {
	485	return $translator->error("Error instantiating Parse::RecDescent ".
	486	"instance: Bad grammer");
	487	}
	488
	489	my $result = $parser->startrule($data);
	490	die "Parse failed.\n" unless defined $result;
	491	warn Dumper($result) if $DEBUG;
947dfd86	492
	493	my $schema = $translator->schema;
	494	my @tables = sort {
	495	$result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
	496	} keys %{ $result };
	497
	498	for my $table_name ( @tables ) {
	499	my $tdata = $result->{ $table_name };
	500	my $table = $schema->add_table(
	501	name => $tdata->{'table_name'},
44567b47	502	comments => $tdata->{'comments'},
947dfd86	503	) or die $schema->error;
	504
	505	my @fields = sort {
	506	$tdata->{'fields'}->{$a}->{'order'}
	507	<=>
	508	$tdata->{'fields'}->{$b}->{'order'}
	509	} keys %{ $tdata->{'fields'} };
	510
	511	for my $fname ( @fields ) {
	512	my $fdata = $tdata->{'fields'}{ $fname };
	513	my $field = $table->add_field(
	514	name => $fdata->{'name'},
	515	data_type => $fdata->{'data_type'},
	516	size => $fdata->{'size'},
	517	default_value => $fdata->{'default'},
	518	is_auto_increment => $fdata->{'is_auto_inc'},
	519	is_nullable => $fdata->{'null'},
44567b47	520	comments => $fdata->{'comments'},
947dfd86	521	) or die $table->error;
	522
	523	for my $cdata ( @{ $fdata->{'constraints'} } ) {
	524	next unless $cdata->{'type'} eq 'foreign_key';
	525	$cdata->{'fields'} \|\|= [ $field->name ];
	526	push @{ $tdata->{'constraints'} }, $cdata;
	527	}
	528	}
	529
	530	for my $idata ( @{ $tdata->{'indices'} \|\| [] } ) {
	531	my $index = $table->add_index(
	532	name => $idata->{'name'},
	533	type => uc $idata->{'type'},
	534	fields => $idata->{'fields'},
	535	) or die $table->error;
	536	}
	537
	538	for my $cdata ( @{ $tdata->{'constraints'} \|\| [] } ) {
	539	my $constraint = $table->add_constraint(
	540	name => $cdata->{'name'},
	541	type => $cdata->{'type'},
	542	fields => $cdata->{'fields'},
	543	reference_table => $cdata->{'reference_table'},
	544	reference_fields => $cdata->{'reference_fields'},
	545	match_type => $cdata->{'match_type'} \|\| '',
	546	on_delete => $cdata->{'on_delete_do'},
	547	on_update => $cdata->{'on_update_do'},
	548	) or die $table->error;
	549	}
	550	}
	551
f62bd16c	552	return 1;
17cae8ab	553	}
	554
	555	1;
	556
947dfd86	557	# -------------------------------------------------------------------
	558	# Something there is that doesn't love a wall.
	559	# Robert Frost
	560	# -------------------------------------------------------------------
	561
17cae8ab	562	=pod
	563
	564	=head1 AUTHOR
	565
	566	Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
	567
	568	=head1 SEE ALSO
	569
	570	perl(1), Parse::RecDescent.
	571
	572	=cut