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

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

# -------------------------------------------------------------------
# $Id: Oracle.pm,v 1.18 2004-04-22 19:56:28 kycl4rk Exp $
# -------------------------------------------------------------------
# Copyright (C) 2002-4 SQLFairy Authors
#
# 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]

Note that probably not all of the above syntax is supported, but the grammar 
was altered to better handle the syntax created by DDL::Oracle.

=cut

use strict;
use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
$VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\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, %indices, %constraints, $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 
    { 
        $return = {
            tables      => \%tables,
            indices     => \%indices,
            constraints => \%constraints,
        };
    }

eofile : /^\Z/

statement : remark
    | prompt
    | create
    | table_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'};
                push @{ $tables{ $table_name }{'constraints'} }, $definition;
            }
            else {
                push @{ $tables{ $table_name }{'indices'} }, $definition;
            }
        }

        for my $option ( @{ $item[6] } ) {
            push @{ $tables{ $table_name }{'table_options'} }, $option;
        }

        1;
    }

create : /create/i UNIQUE(?) /index/i WORD /on/i table_name parens_word_list table_option(?) ';'
    {
        my $table_name = $item[6];
        if ( $item[2] ) {
            push @{ $constraints{ $table_name } }, {
                name   => $item[4],
                type   => 'unique',
                fields => $item[7][0],
            };
        }
        else {
            push @{ $indices{ $table_name } }, {
                name   => $item[4],
                type   => 'normal',
                fields => $item[7][0],
            };
        }
    }

# 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>

table_comment : comment
    {
        my $comment = $item[1];
        $return     = $comment;
        push @table_comments, $comment;
    }

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

comment : /\/\*/ /[^\*]+/ /\*\// 
    {
        my $comment = $item[2];
        $comment    =~ s/^\s*|\s*$//g;
        $return = $comment;
    }

remark : /^REM\s+.*\n/

prompt : /prompt/i /(table|index|sequence|trigger)/i ';'

prompt : /prompt\s+create\s+.*\n/i

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 
    {
        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' }
    |
    /integer/i { $return = 'integer' }
    |
    /(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 if defined $val; 
        $return =  {
            supertype => 'constraint',
            type      => 'default',
            value     => $val,
        }
    }

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

table_option : /organization/i WORD
    {
        $return = { 'ORGANIZATION' => $item[2] }
    }

table_option : /nomonitoring/i
    {
        $return = { 'NOMONITORING' => undef }
    }

table_option : /parallel/i '(' key_value(s) ')'
    {
        $return = { 'PARALLEL' => $item[3] }
    }

key_value : WORD VALUE
    {
        $return = { $item[1], $item[2] }
    }

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] }

UNIQUE : /unique/i { $return = 1 }

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 $indices     = $result->{'indices'};
    my $constraints = $result->{'constraints'};
    my @tables      = sort { 
        $result->{'tables'}{ $a }{'order'} 
        <=> 
        $result->{'tables'}{ $b }{'order'}
    } keys %{ $result->{'tables'} };

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

        $table->options( $tdata->{'table_options'} );

        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;
            }
        }

        push @{ $tdata->{'indices'} }, @{ $indices->{ $table_name } || [] };
        push @{ $tdata->{'constraints'} }, 
             @{ $constraints->{ $table_name } || [] };

        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

SQL::Translator, Parse::RecDescent, DDL::Oracle.

=cut
Commit	Line	Data
17cae8ab	1	package SQL::Translator::Parser::Oracle;
	2
	3	# -------------------------------------------------------------------
6a36a3d8	4	# $Id: Oracle.pm,v 1.18 2004-04-22 19:56:28 kycl4rk Exp $
17cae8ab	5	# -------------------------------------------------------------------
90075866	6	# Copyright (C) 2002-4 SQLFairy Authors
17cae8ab	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
3b2be65a	94	Note that probably not all of the above syntax is supported, but the grammar
	95	was altered to better handle the syntax created by DDL::Oracle.
	96
17cae8ab	97	=cut
	98
	99	use strict;
	100	use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
6a36a3d8	101	$VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/;
17cae8ab	102	$DEBUG = 0 unless defined $DEBUG;
	103
	104	use Data::Dumper;
	105	use Parse::RecDescent;
	106	use Exporter;
	107	use base qw(Exporter);
	108
	109	@EXPORT_OK = qw(parse);
	110
	111	# Enable warnings within the Parse::RecDescent module.
	112	$::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
	113	$::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
	114	$::RD_HINT = 1; # Give out hints to help fix problems.
	115
	116	my $parser;
	117
	118	$GRAMMAR = q!
	119
6a36a3d8	120	{ my ( %tables, %indices, %constraints, $table_order, @table_comments ) }
17cae8ab	121
	122	#
	123	# The "eofile" rule makes the parser fail if any "statement" rule
	124	# fails. Otherwise, the first successful match by a "statement"
	125	# won't cause the failure needed to know that the parse, as a whole,
	126	# failed. -ky
	127	#
87053733	128	startrule : statement(s) eofile
	129	{
	130	$return = {
6a36a3d8	131	tables => \%tables,
	132	indices => \%indices,
	133	constraints => \%constraints,
87053733	134	};
87053733	135	}
17cae8ab	136
	137	eofile : /^\Z/
	138
87053733	139	statement : remark
	140	\| prompt
	141	\| create
f77a985b	142	\| table_comment
067e3cf4	143	\| comment_on_table
	144	\| comment_on_column
	145	\| alter
	146	\| drop
	147	\| <error>
17cae8ab	148
44567b47	149	alter : /alter/i WORD /[^;]+/ ';'
067e3cf4	150	{ @table_comments = () }
	151
	152	drop : /drop/i TABLE ';'
	153
	154	drop : /drop/i WORD(s) ';'
	155	{ @table_comments = () }
44567b47	156
87053733	157	create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
17cae8ab	158	{
	159	my $table_name = $item{'table_name'};
	160	$tables{ $table_name }{'order'} = ++$table_order;
	161	$tables{ $table_name }{'table_name'} = $table_name;
	162
067e3cf4	163	if ( @table_comments ) {
	164	$tables{ $table_name }{'comments'} = [ @table_comments ];
	165	@table_comments = ();
	166	}
	167
17cae8ab	168	my $i = 1;
17cae8ab	169	my @constraints;
87053733	170	for my $definition ( @{ $item[4] } ) {
17cae8ab	171	if ( $definition->{'type'} eq 'field' ) {
	172	my $field_name = $definition->{'name'};
	173	$tables{ $table_name }{'fields'}{ $field_name } =
	174	{ %$definition, order => $i };
	175	$i++;
	176
17cae8ab	177	for my $constraint ( @{ $definition->{'constraints'} \|\| [] } ) {
	178	$constraint->{'fields'} = [ $field_name ];
	179	push @{ $tables{ $table_name }{'constraints'} },
	180	$constraint;
	181	}
	182	}
	183	elsif ( $definition->{'type'} eq 'constraint' ) {
	184	$definition->{'type'} = $definition->{'constraint_type'};
f77a985b	185	push @{ $tables{ $table_name }{'constraints'} }, $definition;
17cae8ab	186	}
	187	else {
	188	push @{ $tables{ $table_name }{'indices'} }, $definition;
	189	}
	190	}
	191
87053733	192	for my $option ( @{ $item[6] } ) {
7c4cf567	193	push @{ $tables{ $table_name }{'table_options'} }, $option;
17cae8ab	194	}
	195
	196	1;
	197	}
	198
6a36a3d8	199	create : /create/i UNIQUE(?) /index/i WORD /on/i table_name parens_word_list table_option(?) ';'
b85a95ec	200	{
6a36a3d8	201	my $table_name = $item[6];
	202	if ( $item[2] ) {
	203	push @{ $constraints{ $table_name } }, {
	204	name => $item[4],
	205	type => 'unique',
	206	fields => $item[7][0],
	207	};
	208	}
	209	else {
	210	push @{ $indices{ $table_name } }, {
	211	name => $item[4],
	212	type => 'normal',
	213	fields => $item[7][0],
	214	};
	215	}
b85a95ec	216	}
b85a95ec	217
17cae8ab	218	# Create anything else (e.g., domain, function, etc.)
17cae8ab	219	create : /create/i WORD /[^;]+/ ';'
067e3cf4	220	{ @table_comments = () }
17cae8ab	221
	222	global_temporary: /global/i /temporary/i
	223
	224	table_name : NAME '.' NAME
	225	{ $item[3] }
	226	\| NAME
	227	{ $item[1] }
	228
	229	create_definition : field
	230	\| table_constraint
	231	\| <error>
	232
f77a985b	233	table_comment : comment
	234	{
	235	my $comment = $item[1];
	236	$return = $comment;
	237	push @table_comments, $comment;
	238	}
	239
17cae8ab	240	comment : /^\s(?:#\|-{2}).\n/
067e3cf4	241	{
39129b47	242	my $comment = $item[1];
	243	$comment =~ s/^\s(#\|-{2})\s//;
	244	$comment =~ s/\s*$//;
	245	$return = $comment;
f77a985b	246	}
	247
	248	comment : /\/\/ /[^\]+/ /\*\//
	249	{
	250	my $comment = $item[2];
	251	$comment =~ s/^\s\|\s$//g;
	252	$return = $comment;
067e3cf4	253	}
17cae8ab	254
87053733	255	remark : /^REM\s+.*\n/
	256
	257	prompt : /prompt/i /(table\|index\|sequence\|trigger)/i ';'
	258
	259	prompt : /prompt\s+create\s+.*\n/i
	260
947dfd86	261	comment_on_table : /comment/i /on/i /table/i table_name /is/i comment_phrase ';'
17cae8ab	262	{
947dfd86	263	push @{ $tables{ $item{'table_name'} }{'comments'} }, $item{'comment_phrase'};
17cae8ab	264	}
17cae8ab	265
947dfd86	266	comment_on_column : /comment/i /on/i /column/i column_name /is/i comment_phrase ';'
17cae8ab	267	{
	268	my $table_name = $item[4]->{'table'};
	269	my $field_name = $item[4]->{'field'};
	270	push @{ $tables{ $table_name }{'fields'}{ $field_name }{'comments'} },
947dfd86	271	$item{'comment_phrase'};
17cae8ab	272	}
	273
	274	column_name : NAME '.' NAME
	275	{ $return = { table => $item[1], field => $item[3] } }
	276
947dfd86	277	comment_phrase : /'.*?'/
	278	{
	279	my $val = $item[1];
	280	$val =~ s/^'\|'$//g;
	281	$return = $val;
	282	}
17cae8ab	283
	284	field : comment(s?) field_name data_type field_meta(s?) comment(s?)
	285	{
947dfd86	286	my ( $is_pk, $default, @constraints );
947dfd86	287	my $null = 1;
17cae8ab	288	for my $meta ( @{ $item[4] } ) {
947dfd86	289	if ( $meta->{'type'} eq 'default' ) {
	290	$default = $meta;
	291	next;
	292	}
	293	elsif ( $meta->{'type'} eq 'not_null' ) {
	294	$null = 0;
	295	next;
	296	}
	297	elsif ( $meta->{'type'} eq 'primary_key' ) {
	298	$is_pk = 1;
	299	}
	300
	301	push @constraints, $meta if $meta->{'supertype'} eq 'constraint';
17cae8ab	302	}
17cae8ab	303
947dfd86	304	my @comments = ( @{ $item[1] }, @{ $item[5] } );
17cae8ab	305
	306	$return = {
	307	type => 'field',
	308	name => $item{'field_name'},
	309	data_type => $item{'data_type'}{'type'},
	310	size => $item{'data_type'}{'size'},
17cae8ab	311	null => $null,
17cae8ab	312	default => $default->{'value'},
947dfd86	313	is_primary_key => $is_pk,
17cae8ab	314	constraints => [ @constraints ],
947dfd86	315	comments => [ @comments ],
17cae8ab	316	}
	317	}
	318	\| <error>
	319
	320	field_name : NAME
	321
	322	data_type : ora_data_type parens_value_list(?)
	323	{
	324	$return = {
	325	type => $item[1],
	326	size => $item[2][0] \|\| '',
	327	}
	328	}
	329
	330	column_constraint : constraint_name(?) column_constraint_type
17cae8ab	331	{
	332	my $desc = $item{'column_constraint_type'};
	333	my $type = $desc->{'type'};
	334	my $fields = $desc->{'fields'} \|\| [];
	335	my $expression = $desc->{'expression'} \|\| '';
	336
	337	$return = {
947dfd86	338	supertype => 'constraint',
947dfd86	339	name => $item{'constraint_name(?)'}[0] \|\| '',
17cae8ab	340	type => $type,
17cae8ab	341	expression => $type eq 'check' ? $expression : '',
40c5e2f4	342	deferrable => $item{'deferrable'},
17cae8ab	343	deferred => $item{'deferred'},
	344	reference_table => $desc->{'reference_table'},
	345	reference_fields => $desc->{'reference_fields'},
	346	# match_type => $desc->{'match_type'},
	347	# on_update_do => $desc->{'on_update_do'},
	348	}
	349	}
	350
	351	constraint_name : /constraint/i NAME { $item[2] }
	352
	353	column_constraint_type : /not null/i { $return = { type => 'not_null' } }
947dfd86	354	\| /null/
17cae8ab	355	{ $return = { type => 'null' } }
947dfd86	356	\| /unique/
17cae8ab	357	{ $return = { type => 'unique' } }
947dfd86	358	\| /primary key/i
17cae8ab	359	{ $return = { type => 'primary_key' } }
947dfd86	360	\| /check/i '(' /[^)]+/ ')'
17cae8ab	361	{ $return = { type => 'check', expression => $item[2] } }
947dfd86	362	\| /references/i table_name parens_word_list(?) on_delete_do(?)
17cae8ab	363	{
	364	$return = {
	365	type => 'foreign_key',
	366	reference_table => $item[2],
	367	reference_fields => $item[3][0],
	368	# match_type => $item[4][0],
	369	on_delete_do => $item[5][0],
	370	}
	371	}
	372
	373	#constraint_state : deferrable { $return = { type => $item[1] } }
	374	# \| deferred { $return = { type => $item[1] } }
	375	# \| /(no)?rely/ { $return = { type => $item[1] } }
	376	# \| /using/i /index/i using_index_clause
	377	# { $return = { type => 'using_index', index => $item[3] }
	378	# \| (dis)?enable { $return = { type => $item[1] } }
	379	# \| (no)?validate { $return = { type => $item[1] } }
	380	# \| /exceptions/i /into/i table_name
	381	# { $return = { type => 'exceptions_into', table => $item[3] } }
	382
	383	deferrable : /not/i /deferrable/i
	384	{ $return = 'not_deferrable' }
	385	\| /deferrable/i
	386	{ $return = 'deferrable' }
	387
	388	deferred : /initially/i /(deferred\|immediate)/i { $item[2] }
	389
	390	ora_data_type :
947dfd86	391	/(n?varchar2\|varchar)/i { $return = 'varchar2' }
17cae8ab	392	\|
	393	/n?char/i { $return = 'character' }
	394	\|
00e41431	395	/n?dec/i { $return = 'decimal' }
00e41431	396	\|
17cae8ab	397	/number/i { $return = 'number' }
17cae8ab	398	\|
87053733	399	/integer/i { $return = 'integer' }
87053733	400	\|
17cae8ab	401	/(pls_integer\|binary_integer)/i { $return = 'integer' }
	402	\|
	403	/interval\s+day/i { $return = 'interval_day' }
	404	\|
	405	/interval\s+year/i { $return = 'interval_year' }
	406	\|
	407	/long\s+raw/i { $return = 'long_raw' }
	408	\|
	409	/(long\|date\|timestamp\|raw\|rowid\|urowid\|mlslabel\|clob\|nclob\|blob\|bfile)/i { $item[1] }
	410
	411	parens_value_list : '(' VALUE(s /,/) ')'
	412	{ $item[2] }
	413
	414	parens_word_list : '(' WORD(s /,/) ')'
	415	{ $item[2] }
	416
	417	field_meta : default_val
947dfd86	418	\| column_constraint
17cae8ab	419
	420	default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
	421	{
b85a95ec	422	my $val = $item[2];
b85a95ec	423	$val =~ s/'//g if defined $val;
17cae8ab	424	$return = {
947dfd86	425	supertype => 'constraint',
947dfd86	426	type => 'default',
17cae8ab	427	value => $val,
	428	}
	429	}
	430
	431	create_table : /create/i global_temporary(?) /table/i
	432
7c4cf567	433	table_option : /organization/i WORD
	434	{
	435	$return = { 'ORGANIZATION' => $item[2] }
	436	}
	437
	438	table_option : /nomonitoring/i
	439	{
	440	$return = { 'NOMONITORING' => undef }
	441	}
	442
	443	table_option : /parallel/i '(' key_value(s) ')'
	444	{
	445	$return = { 'PARALLEL' => $item[3] }
	446	}
	447
	448	key_value : WORD VALUE
	449	{
	450	$return = { $item[1], $item[2] }
	451	}
	452
17cae8ab	453	table_option : /[^;]+/
	454
	455	table_constraint : comment(s?) constraint_name(?) table_constraint_type deferrable(?) deferred(?) comment(s?)
	456	{
	457	my $desc = $item{'table_constraint_type'};
	458	my $type = $desc->{'type'};
	459	my $fields = $desc->{'fields'};
	460	my $expression = $desc->{'expression'};
	461	my @comments = ( @{ $item[1] }, @{ $item[-1] } );
	462
	463	$return = {
947dfd86	464	name => $item{'constraint_name(?)'}[0] \|\| '',
17cae8ab	465	type => 'constraint',
	466	constraint_type => $type,
	467	fields => $type ne 'check' ? $fields : [],
	468	expression => $type eq 'check' ? $expression : '',
40c5e2f4	469	deferrable => $item{'deferrable(?)'},
947dfd86	470	deferred => $item{'deferred(?)'},
17cae8ab	471	reference_table => $desc->{'reference_table'},
	472	reference_fields => $desc->{'reference_fields'},
	473	# match_type => $desc->{'match_type'}[0],
	474	on_delete_do => $desc->{'on_delete_do'},
	475	on_update_do => $desc->{'on_update_do'},
	476	comments => [ @comments ],
	477	}
	478	}
	479
	480	table_constraint_type : /primary key/i '(' NAME(s /,/) ')'
	481	{
	482	$return = {
	483	type => 'primary_key',
	484	fields => $item[3],
	485	}
	486	}
	487	\|
	488	/unique/i '(' NAME(s /,/) ')'
	489	{
	490	$return = {
	491	type => 'unique',
	492	fields => $item[3],
	493	}
	494	}
	495	\|
	496	/check/ '(' /(.+)/ ')'
	497	{
	498	$return = {
	499	type => 'check',
	500	expression => $item[3],
	501	}
	502	}
	503	\|
	504	/foreign key/i '(' NAME(s /,/) ')' /references/i table_name parens_word_list(?) on_delete_do(?)
	505	{
	506	$return = {
	507	type => 'foreign_key',
	508	fields => $item[3],
	509	reference_table => $item[6],
	510	reference_fields => $item[7][0],
	511	match_type => $item[8][0],
	512	on_delete_do => $item[9][0],
	513	on_update_do => $item[10][0],
	514	}
	515	}
	516
	517	on_delete_do : /on delete/i WORD(s)
	518	{ $item[2] }
	519
6a36a3d8	520	UNIQUE : /unique/i { $return = 1 }
6a36a3d8	521
17cae8ab	522	WORD : /\w+/
	523
	524	NAME : /\w+/ { $item[1] }
	525
067e3cf4	526	TABLE : /table/i
067e3cf4	527
17cae8ab	528	VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
	529	{ $item[1] }
	530	\| /'.*?'/ # XXX doesn't handle embedded quotes
	531	{ $item[1] }
	532	\| /NULL/
	533	{ 'NULL' }
	534
	535	!;
	536
	537	# -------------------------------------------------------------------
	538	sub parse {
	539	my ( $translator, $data ) = @_;
	540	$parser \|\|= Parse::RecDescent->new($GRAMMAR);
	541
	542	local $::RD_TRACE = $translator->trace ? 1 : undef;
	543	local $DEBUG = $translator->debug;
	544
	545	unless (defined $parser) {
	546	return $translator->error("Error instantiating Parse::RecDescent ".
	547	"instance: Bad grammer");
	548	}
	549
87053733	550	my $result = $parser->startrule( $data );
17cae8ab	551	die "Parse failed.\n" unless defined $result;
17cae8ab	552	warn Dumper($result) if $DEBUG;
947dfd86	553
6a36a3d8	554	my $schema = $translator->schema;
	555	my $indices = $result->{'indices'};
	556	my $constraints = $result->{'constraints'};
	557	my @tables = sort {
87053733	558	$result->{'tables'}{ $a }{'order'}
	559	<=>
	560	$result->{'tables'}{ $b }{'order'}
	561	} keys %{ $result->{'tables'} };
947dfd86	562
947dfd86	563	for my $table_name ( @tables ) {
87053733	564	my $tdata = $result->{'tables'}{ $table_name };
87053733	565	next unless $tdata->{'table_name'};
947dfd86	566	my $table = $schema->add_table(
947dfd86	567	name => $tdata->{'table_name'},
44567b47	568	comments => $tdata->{'comments'},
947dfd86	569	) or die $schema->error;
947dfd86	570
7c4cf567	571	$table->options( $tdata->{'table_options'} );
7c4cf567	572
947dfd86	573	my @fields = sort {
	574	$tdata->{'fields'}->{$a}->{'order'}
	575	<=>
	576	$tdata->{'fields'}->{$b}->{'order'}
	577	} keys %{ $tdata->{'fields'} };
	578
	579	for my $fname ( @fields ) {
	580	my $fdata = $tdata->{'fields'}{ $fname };
	581	my $field = $table->add_field(
	582	name => $fdata->{'name'},
	583	data_type => $fdata->{'data_type'},
	584	size => $fdata->{'size'},
	585	default_value => $fdata->{'default'},
	586	is_auto_increment => $fdata->{'is_auto_inc'},
	587	is_nullable => $fdata->{'null'},
44567b47	588	comments => $fdata->{'comments'},
947dfd86	589	) or die $table->error;
	590
	591	for my $cdata ( @{ $fdata->{'constraints'} } ) {
	592	next unless $cdata->{'type'} eq 'foreign_key';
	593	$cdata->{'fields'} \|\|= [ $field->name ];
	594	push @{ $tdata->{'constraints'} }, $cdata;
	595	}
	596	}
	597
87053733	598	push @{ $tdata->{'indices'} }, @{ $indices->{ $table_name } \|\| [] };
6a36a3d8	599	push @{ $tdata->{'constraints'} },
6a36a3d8	600	@{ $constraints->{ $table_name } \|\| [] };
87053733	601
947dfd86	602	for my $idata ( @{ $tdata->{'indices'} \|\| [] } ) {
	603	my $index = $table->add_index(
	604	name => $idata->{'name'},
	605	type => uc $idata->{'type'},
	606	fields => $idata->{'fields'},
	607	) or die $table->error;
	608	}
	609
	610	for my $cdata ( @{ $tdata->{'constraints'} \|\| [] } ) {
	611	my $constraint = $table->add_constraint(
	612	name => $cdata->{'name'},
	613	type => $cdata->{'type'},
	614	fields => $cdata->{'fields'},
	615	reference_table => $cdata->{'reference_table'},
	616	reference_fields => $cdata->{'reference_fields'},
	617	match_type => $cdata->{'match_type'} \|\| '',
	618	on_delete => $cdata->{'on_delete_do'},
	619	on_update => $cdata->{'on_update_do'},
	620	) or die $table->error;
	621	}
	622	}
	623
f62bd16c	624	return 1;
17cae8ab	625	}
	626
	627	1;
	628
947dfd86	629	# -------------------------------------------------------------------
	630	# Something there is that doesn't love a wall.
	631	# Robert Frost
	632	# -------------------------------------------------------------------
	633
17cae8ab	634	=pod
	635
	636	=head1 AUTHOR
	637
	638	Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
	639
	640	=head1 SEE ALSO
	641
3b2be65a	642	SQL::Translator, Parse::RecDescent, DDL::Oracle.
17cae8ab	643
17cae8ab	644	=cut