Upped version numbers, cleaned up code, fixed my name.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Parser / Sybase.pm
index 0407c8f..4ea0850 100644 (file)
 package SQL::Translator::Parser::Sybase;
 
-#-----------------------------------------------------
-# $Id: Sybase.pm,v 1.2 2002-11-20 04:03:04 kycl4rk Exp $
+# -------------------------------------------------------------------
+# Copyright (C) 2002-2009 SQLFairy Authors
 #
-# File       : SQL/Translator/Parser/Sybase.pm
-# Programmer : Ken Y. Clark, kclark@logsoft.com
-# Created    : 2002/02/27
-# Purpose    : parser for Sybase (dbschema.pl)
-#-----------------------------------------------------
-
-my $grammar = q{
-
-    { our ( %tables ) }
-
-    file         : statement(s) { \%tables }
-#        { print "statements: ", join("\n", @{$item[1]}), "\n" }
-#                   | <error>
-
-    statement    : create
-                   | junk
-#        { 
-#            print "statement: ", join("\n", @{$item[1]}), "\n";
-#            $return = @{$item[1]};
-#            print "statement: '", $item[1], "'\n";
-#            $return = $item[1];
-#        }
-                   | <error>
-
-    junk         : comment 
-                   | use
-                   | setuser
-                   | if
-                   | print
-                   | else
-                   | begin
-                   | end
-                   | grant
-                   | exec
-                   | GO
-
-    GO           : /go/
-#        { print "GO: ", $item[1], "\n" }
-
-    use          : /use/i /.*/
-#        { print "USE: ", $item[2], "\n" }
-
-    setuser      : /setuser/i /.*/
-#        { print "SETUSER: ", $item[2], "\n" }
-
-    if           : /if/i /.*/
-#        { print "IF: ", $item[2], "\n" }
-
-    print        : /\s*/ /print/i /.*/
-#       { print "PRINT: ", $item[3], "\n" }
-
-    else        : /else/i /.*/
-#        { print "ELSE: ", $item[2], "\n" }
-
-    begin       : /begin/i
-#        { print "BEGIN\n" }
-
-    end         : /end/i
-#        { print "END\n" }
-
-    grant       : /grant/i /.*/
-#        { print "GRANT: ", $item[2], "\n" }
-
-    exec        : /exec/i /.*/
-#        { print "EXEC: ", $item[2], "\n" }
-
-    comment      : /^\s*\/\*.*\*\//m
-#        { print "COMMENT: ", $item[-1], "\n" }
-
-    create       : create_table table_name '(' field(s /,/) ')' lock(?)
-                { 
-#                    print "TABLE $item[2]: ", 
-#                        join(', ', map{$_->{'name'}}@{$item[4]}), "\n";
-                    my $i = 0;
-                    for my $line ( @{ $item[4] } ) {
-                        if ( $line->{'type'} eq 'field' ) {
-                            my $field_name = $line->{'name'};
-                            $tables{ $item{'table_name'} }
-                                {'fields'}{$field_name} = 
-                                { %$line, order => $i };
-                            $i++;
-                    
-                            if ( $line->{'is_primary_key'} ) {
-                                push
-                                @{ $tables{ $item{'table_name'} }{'indices'} },
-                                {
-                                    type   => 'primary_key',
-                                    fields => [ $field_name ],
-                                };
-                            }
-                        }
-                        else {
-                            push @{ $tables{ $item{'table_name'} }{'indices'} },
-                                $line;
-                        }
-                        $tables{ $item{'table_name'} }{'type'} = 
-                            $item{'table_type'}[0];
-                    }
-                }
-                   | <error>
-
-    blank        : /\s*/
-
-    field        : field_name data_type null(?) 
-                   { 
-                        $return = { 
-                            type           => 'field',
-                            name           => $item{'field_name'}, 
-                            data_type      => $item{'data_type'}{'type'},
-                            size           => $item{'data_type'}{'size'},
-                            null           => $item{'null'}[0], 
-#                            default        => $item{'default_val'}[0], 
-#                            is_auto_inc    => $item{'auto_inc'}[0], 
-#                            is_primary_key => $item{'primary_key'}[0], 
-                       } 
-                   }
-                | <error>
-
-    index        : primary_key_index
-                   | unique_index
-                   | normal_index
-
-    table_name   : WORD '.' WORD
-        { $return = $item[3] }
-
-    field_name   : WORD
-
-    index_name   : WORD
-
-    data_type    : WORD field_size(?) 
-        { 
-            $return = { 
-                type => $item[1], 
-                size => $item[2][0]
-            } 
-        }
+# 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::Sybase - parser for Sybase
+
+=head1 SYNOPSIS
 
-    lock         : /lock/i /datarows/i
+  use SQL::Translator::Parser::Sybase;
 
-    field_type   : WORD
+=head1 DESCRIPTION
 
-    field_size   : '(' num_range ')' { $item{'num_range'} }
+Mostly parses the output of "dbschema.pl," a Perl script freely
+available from http://www.midsomer.org.  The parsing is not complete,
+however, and you would probably have much better luck using the
+DBI-Sybase parser included with SQL::Translator.
 
-    num_range    : DIGITS ',' DIGITS
-        { $return = $item[1].','.$item[3] }
-                   | DIGITS
-        { $return = $item[1] }
+=cut
 
+use strict;
 
-    create_table : /create/i /table/i
+use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
+$VERSION = '1.60';
+$DEBUG   = 0 unless defined $DEBUG;
 
-    null         : /not/i /null/i
-        { $return = 0 }
-                   | /null/i
-        { $return = 1 }
+use Data::Dumper;
+use Parse::RecDescent;
+use Exporter;
+use base qw(Exporter);
 
-    default_val  : /default/i /(?:')?[\w\d.-]*(?:')?/ { $item[2]=~s/'//g; $return=$item[2] }
+@EXPORT_OK = qw(parse);
 
-    auto_inc     : /auto_increment/i { 1 }
+$::RD_ERRORS = 1;
+$::RD_WARN   = 1;
+$::RD_HINT   = 1;
 
-    primary_key  : /primary/i /key/i { 1 }
+$GRAMMAR = q{
 
-    primary_key_index : primary_key index_name(?) '(' field_name(s /,/) ')'
-        { 
-            $return = { 
-                name   => $item{'index_name'}[0],
-                type   => 'primary_key',
-                fields => $item[4],
-            } 
-        }
+{ 
+    my ( %tables, @table_comments, $table_order );
+}
+
+startrule : statement(s) eofile { \%tables }
+
+eofile : /^\Z/
+
+statement : create_table
+    | create_procedure
+    | create_index
+    | create_constraint
+    | comment
+    | use
+    | setuser
+    | if
+    | print
+    | grant
+    | exec
+    | <error>
+
+use : /use/i WORD GO 
+    { @table_comments = () }
 
-    normal_index      : key index_name(?) '(' field_name(s /,/) ')'
-        { 
-            $return = { 
-                name   => $item{'index_name'}[0],
-                type   => 'normal',
-                fields => $item[4],
-            } 
+setuser : /setuser/i NAME GO
+
+if : /if/i object_not_null begin if_command end GO
+
+if_command : grant
+    | create_index
+    | create_constraint
+
+object_not_null : /object_id/i '(' ident ')' /is not null/i
+
+print : /\s*/ /print/i /.*/
+
+else : /else/i /.*/
+
+begin : /begin/i
+
+end : /end/i
+
+grant : /grant/i /[^\n]*/
+
+exec : exec_statement(s) GO
+
+exec_statement : /exec/i /[^\n]+/
+
+comment : comment_start comment_middle comment_end
+    { 
+        my $comment = $item[2];
+        $comment =~ s/^\s*|\s*$//mg;
+        $comment =~ s/^\**\s*//mg;
+        push @table_comments, $comment;
+    }
+
+comment_start : /^\s*\/\*/
+
+comment_end : /\s*\*\//
+
+comment_middle : m{([^*]+|\*(?!/))*}
+
+#
+# Create table.
+#
+create_table : /create/i /table/i ident '(' create_def(s /,/) ')' lock(?) on_system(?) GO
+    { 
+        my $table_owner = $item[3]{'owner'};
+        my $table_name  = $item[3]{'name'};
+
+        if ( @table_comments ) {
+            $tables{ $table_name }{'comments'} = [ @table_comments ];
+            @table_comments = ();
         }
 
-    unique_index      : /unique/i key index_name(?) '(' field_name(s /,/) ')'
-        { 
-            $return = { 
-                name   => $item{'index_name'}[0],
-                type   => 'unique',
-                fields => $item[5],
-            } 
+        $tables{ $table_name }{'order'}  = ++$table_order;
+        $tables{ $table_name }{'name'}   = $table_name;
+        $tables{ $table_name }{'owner'}  = $table_owner;
+        $tables{ $table_name }{'system'} = $item[7];
+
+        my $i = 0;
+        for my $def ( @{ $item[5] } ) {
+            if ( $def->{'supertype'} eq 'field' ) {
+                my $field_name = $def->{'name'};
+                $tables{ $table_name }{'fields'}{ $field_name } = 
+                    { %$def, order => $i };
+                $i++;
+        
+                if ( $def->{'is_primary_key'} ) {
+                    push @{ $tables{ $table_name }{'constraints'} }, {
+                        type   => 'primary_key',
+                        fields => [ $field_name ],
+                    };
+                }
+            }
+            elsif ( $def->{'supertype'} eq 'constraint' ) {
+                push @{ $tables{ $table_name }{'constraints'} }, $def;
+            }
+            else {
+                push @{ $tables{ $table_name }{'indices'} }, $def;
+            }
         }
+    }
+
+create_constraint : /create/i constraint 
+    {
+        @table_comments = ();
+        push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
+    }
+
+create_index : /create/i index
+    {
+        @table_comments = ();
+        push @{ $tables{ $item[2]{'table'} }{'indices'} }, $item[2];
+    }
+
+create_procedure : /create/i /procedure/i procedure_body GO
+    {
+        @table_comments = ();
+    }
+
+procedure_body : not_go(s)
+
+not_go : /((?!go).)*/
+
+create_def : field
+    | index
+    | constraint
+
+blank : /\s*/
+
+field : field_name data_type nullable(?) 
+    { 
+        $return = { 
+            supertype      => 'field',
+            name           => $item{'field_name'}, 
+            data_type      => $item{'data_type'}{'type'},
+            size           => $item{'data_type'}{'size'},
+            nullable       => $item[3][0], 
+#            default        => $item{'default_val'}[0], 
+#            is_auto_inc    => $item{'auto_inc'}[0], 
+#            is_primary_key => $item{'primary_key'}[0], 
+        } 
+    }
+
+constraint : primary_key_constraint
+    | unique_constraint
+
+field_name : WORD
+
+index_name : WORD
 
-    key          : /key/i 
-                   | /index/i
+table_name : WORD
 
-    table_type   : /TYPE=/i /\w+/ { $item[2] }
+data_type : WORD field_size(?) 
+    { 
+        $return = { 
+            type => $item[1], 
+            size => $item[2][0]
+        } 
+    }
 
-    WORD         : /[\w#]+/
+lock : /lock/i /datarows/i
 
-    DIGITS       : /\d+/
+field_type : WORD
 
-    COMMA        : ','
+field_size : '(' num_range ')' { $item{'num_range'} }
+
+num_range : DIGITS ',' DIGITS
+    { $return = $item[1].','.$item[3] }
+               | DIGITS
+    { $return = $item[1] }
+
+
+nullable : /not/i /null/i
+    { $return = 0 }
+    | /null/i
+    { $return = 1 }
+
+default_val : /default/i /(?:')?[\w\d.-]*(?:')?/ 
+    { $item[2]=~s/'//g; $return=$item[2] }
+
+auto_inc : /auto_increment/i { 1 }
+
+primary_key_constraint : /primary/i /key/i index_name(?) parens_field_list 
+    { 
+        $return = { 
+            supertype => 'constraint',
+            name      => $item{'index_name'}[0],
+            type      => 'primary_key',
+            fields    => $item[4],
+        } 
+    }
+
+unique_constraint : /unique/i clustered(?) INDEX(?) index_name(?) on_table(?) parens_field_list
+    { 
+        $return = { 
+            supertype => 'constraint',
+            type      => 'unique',
+            clustered => $item[2][0],
+            name      => $item[4][0],
+            table     => $item[5][0],
+            fields    => $item[6],
+        } 
+    }
+
+clustered : /clustered/i
+    { $return = 1 }
+    | /nonclustered/i
+    { $return = 0 }
+
+INDEX : /index/i
+
+on_table : /on/i table_name
+    { $return = $item[2] }
+
+on_system : /on/i /system/i
+    { $return = 1 }
+
+index : clustered(?) INDEX index_name(?) on_table(?) parens_field_list
+    { 
+        $return = { 
+            supertype => 'index',
+            type      => 'normal',
+            clustered => $item[1][0],
+            name      => $item[3][0],
+            table     => $item[4][0],
+            fields    => $item[5],
+        } 
+    }
+
+parens_field_list : '(' field_name(s /,/) ')'
+    { $item[2] }
+
+ident : QUOTE(?) WORD '.' WORD QUOTE(?)
+    { $return = { owner => $item[2], name => $item[4] } }
+    | WORD
+    { $return = { name  => $item[2] } }
+
+GO : /^go/i
+
+NAME : QUOTE(?) /\w+/ QUOTE(?)
+    { $item[2] }
+
+WORD : /[\w#]+/
+
+DIGITS : /\d+/
+
+COMMA : ','
+
+QUOTE : /'/
 
 };
 
-1;
+# -------------------------------------------------------------------
+sub parse {
+    my ( $translator, $data ) = @_;
+    my $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);
+    return $translator->error( "Parse failed." ) 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->{'name'} ) 
+                    or die "Can't create table '$table_name': ", $schema->error;
+
+        $table->comments( $tdata->{'comments'} );
+
+        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->{'nullable'},
+                comments          => $fdata->{'comments'},
+            ) or die $table->error;
+
+            $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
+
+            for my $qual ( qw[ binary unsigned zerofill list ] ) {
+                if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
+                    next if ref $val eq 'ARRAY' && !@$val;
+                    $field->extra( $qual, $val );
+                }
+            }
 
-#-----------------------------------------------------
-# Every hero becomes a bore at last.
-# Ralph Waldo Emerson
-#-----------------------------------------------------
+            if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
+                my %extra = $field->extra;
+                my $longest = 0;
+                for my $len ( map { length } @{ $extra{'list'} || [] } ) {
+                    $longest = $len if $len > $longest;
+                }
+                $field->size( $longest ) if $longest;
+            }
+
+            for my $cdata ( @{ $fdata->{'constraints'} } ) {
+                next unless $cdata->{'type'} eq 'foreign_key';
+                $cdata->{'fields'} ||= [ $field->name ];
+                push @{ $tdata->{'constraints'} }, $cdata;
+            }
+        }
 
-=head1 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;
+        }
 
-SQL::Translator::Parser::Sybase - parser for Sybase
+        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'} || $cdata->{'on_delete_do'},
+                on_update        => $cdata->{'on_update'} || $cdata->{'on_update_do'},
+            ) or die $table->error;
+        }
+    }
 
-=head1 SYNOPSIS
+    return 1;
+}
 
-  use SQL::Translator::Parser::Sybase;
+1;
 
-=head1 DESCRIPTION
+# -------------------------------------------------------------------
+# Every hero becomes a bore at last.
+# Ralph Waldo Emerson
+# -------------------------------------------------------------------
 
-Blah blah blah.
+=pod
 
 =head1 AUTHOR
 
-Ken Y. Clark, kclark@logsoft.com
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 
 =head1 SEE ALSO
 
-perl(1).
+SQL::Translator, SQL::Translator::Parser::DBI, L<http://www.midsomer.org/>.
 
 =cut