lib/SQL/Translator/Parser/Sybase.pm

   1 package SQL::Translator::Parser::Sybase;
   2
   3 # -------------------------------------------------------------------
   4 # Copyright (C) 2002-2009 SQLFairy Authors
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License as
   8 # published by the Free Software Foundation; version 2.
   9 #
  10 # This program is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18 # 02111-1307  USA
  19 # -------------------------------------------------------------------
  20
  21 =head1 NAME
  22
  23 SQL::Translator::Parser::Sybase - parser for Sybase
  24
  25 =head1 SYNOPSIS
  26
  27   use SQL::Translator::Parser::Sybase;
  28
  29 =head1 DESCRIPTION
  30
  31 Mostly parses the output of "dbschema.pl," a Perl script freely
  32 available from http://www.midsomer.org.  The parsing is not complete,
  33 however, and you would probably have much better luck using the
  34 DBI-Sybase parser included with SQL::Translator.
  35
  36 =cut
  37
  38 use strict;
  39
  40 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
  41 $VERSION = '1.59';
  42 $DEBUG   = 0 unless defined $DEBUG;
  43
  44 use Data::Dumper;
  45 use Parse::RecDescent;
  46 use Exporter;
  47 use base qw(Exporter);
  48
  49 @EXPORT_OK = qw(parse);
  50
  51 $::RD_ERRORS = 1;
  52 $::RD_WARN   = 1;
  53 $::RD_HINT   = 1;
  54
  55 $GRAMMAR = q{
  56
  57 {
  58     my ( %tables, @table_comments, $table_order );
  59 }
  60
  61 startrule : statement(s) eofile { \%tables }
  62
  63 eofile : /^\Z/
  64
  65 statement : create_table
  66     | create_procedure
  67     | create_index
  68     | create_constraint
  69     | comment
  70     | use
  71     | setuser
  72     | if
  73     | print
  74     | grant
  75     | exec
  76     | <error>
  77
  78 use : /use/i WORD GO
  79     { @table_comments = () }
  80
  81 setuser : /setuser/i NAME GO
  82
  83 if : /if/i object_not_null begin if_command end GO
  84
  85 if_command : grant
  86     | create_index
  87     | create_constraint
  88
  89 object_not_null : /object_id/i '(' ident ')' /is not null/i
  90
  91 print : /\s*/ /print/i /.*/
  92
  93 else : /else/i /.*/
  94
  95 begin : /begin/i
  96
  97 end : /end/i
  98
  99 grant : /grant/i /[^\n]*/
 100
 101 exec : exec_statement(s) GO
 102
 103 exec_statement : /exec/i /[^\n]+/
 104
 105 comment : comment_start comment_middle comment_end
 106     {
 107         my $comment = $item[2];
 108         $comment =~ s/^\s*|\s*$//mg;
 109         $comment =~ s/^\**\s*//mg;
 110         push @table_comments, $comment;
 111     }
 112
 113 comment_start : /^\s*\/\*/
 114
 115 comment_end : /\s*\*\//
 116
 117 comment_middle : m{([^*]+|\*(?!/))*}
 118
 119 #
 120 # Create table.
 121 #
 122 create_table : /create/i /table/i ident '(' create_def(s /,/) ')' lock(?) on_system(?) GO
 123     {
 124         my $table_owner = $item[3]{'owner'};
 125         my $table_name  = $item[3]{'name'};
 126
 127         if ( @table_comments ) {
 128             $tables{ $table_name }{'comments'} = [ @table_comments ];
 129             @table_comments = ();
 130         }
 131
 132         $tables{ $table_name }{'order'}  = ++$table_order;
 133         $tables{ $table_name }{'name'}   = $table_name;
 134         $tables{ $table_name }{'owner'}  = $table_owner;
 135         $tables{ $table_name }{'system'} = $item[7];
 136
 137         my $i = 0;
 138         for my $def ( @{ $item[5] } ) {
 139             if ( $def->{'supertype'} eq 'field' ) {
 140                 my $field_name = $def->{'name'};
 141                 $tables{ $table_name }{'fields'}{ $field_name } =
 142                     { %$def, order => $i };
 143                 $i++;
 144
 145                 if ( $def->{'is_primary_key'} ) {
 146                     push @{ $tables{ $table_name }{'constraints'} }, {
 147                         type   => 'primary_key',
 148                         fields => [ $field_name ],
 149                     };
 150                 }
 151             }
 152             elsif ( $def->{'supertype'} eq 'constraint' ) {
 153                 push @{ $tables{ $table_name }{'constraints'} }, $def;
 154             }
 155             else {
 156                 push @{ $tables{ $table_name }{'indices'} }, $def;
 157             }
 158         }
 159     }
 160
 161 create_constraint : /create/i constraint
 162     {
 163         @table_comments = ();
 164         push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
 165     }
 166
 167 create_index : /create/i index
 168     {
 169         @table_comments = ();
 170         push @{ $tables{ $item[2]{'table'} }{'indices'} }, $item[2];
 171     }
 172
 173 create_procedure : /create/i /procedure/i procedure_body GO
 174     {
 175         @table_comments = ();
 176     }
 177
 178 procedure_body : not_go(s)
 179
 180 not_go : /((?!go).)*/
 181
 182 create_def : field
 183     | index
 184     | constraint
 185
 186 blank : /\s*/
 187
 188 field : field_name data_type nullable(?)
 189     {
 190         $return = {
 191             supertype      => 'field',
 192             name           => $item{'field_name'},
 193             data_type      => $item{'data_type'}{'type'},
 194             size           => $item{'data_type'}{'size'},
 195             nullable       => $item[3][0],
 196 #            default        => $item{'default_val'}[0],
 197 #            is_auto_inc    => $item{'auto_inc'}[0],
 198 #            is_primary_key => $item{'primary_key'}[0],
 199         }
 200     }
 201
 202 constraint : primary_key_constraint
 203     | unique_constraint
 204
 205 field_name : WORD
 206
 207 index_name : WORD
 208
 209 table_name : WORD
 210
 211 data_type : WORD field_size(?)
 212     {
 213         $return = {
 214             type => $item[1],
 215             size => $item[2][0]
 216         }
 217     }
 218
 219 lock : /lock/i /datarows/i
 220
 221 field_type : WORD
 222
 223 field_size : '(' num_range ')' { $item{'num_range'} }
 224
 225 num_range : DIGITS ',' DIGITS
 226     { $return = $item[1].','.$item[3] }
 227                | DIGITS
 228     { $return = $item[1] }
 229
 230
 231 nullable : /not/i /null/i
 232     { $return = 0 }
 233     | /null/i
 234     { $return = 1 }
 235
 236 default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
 237     { $item[2]=~s/'//g; $return=$item[2] }
 238
 239 auto_inc : /auto_increment/i { 1 }
 240
 241 primary_key_constraint : /primary/i /key/i index_name(?) parens_field_list
 242     {
 243         $return = {
 244             supertype => 'constraint',
 245             name      => $item{'index_name'}[0],
 246             type      => 'primary_key',
 247             fields    => $item[4],
 248         }
 249     }
 250
 251 unique_constraint : /unique/i clustered(?) INDEX(?) index_name(?) on_table(?) parens_field_list
 252     {
 253         $return = {
 254             supertype => 'constraint',
 255             type      => 'unique',
 256             clustered => $item[2][0],
 257             name      => $item[4][0],
 258             table     => $item[5][0],
 259             fields    => $item[6],
 260         }
 261     }
 262
 263 clustered : /clustered/i
 264     { $return = 1 }
 265     | /nonclustered/i
 266     { $return = 0 }
 267
 268 INDEX : /index/i
 269
 270 on_table : /on/i table_name
 271     { $return = $item[2] }
 272
 273 on_system : /on/i /system/i
 274     { $return = 1 }
 275
 276 index : clustered(?) INDEX index_name(?) on_table(?) parens_field_list
 277     {
 278         $return = {
 279             supertype => 'index',
 280             type      => 'normal',
 281             clustered => $item[1][0],
 282             name      => $item[3][0],
 283             table     => $item[4][0],
 284             fields    => $item[5],
 285         }
 286     }
 287
 288 parens_field_list : '(' field_name(s /,/) ')'
 289     { $item[2] }
 290
 291 ident : QUOTE(?) WORD '.' WORD QUOTE(?)
 292     { $return = { owner => $item[2], name => $item[4] } }
 293     | WORD
 294     { $return = { name  => $item[2] } }
 295
 296 GO : /^go/i
 297
 298 NAME : QUOTE(?) /\w+/ QUOTE(?)
 299     { $item[2] }
 300
 301 WORD : /[\w#]+/
 302
 303 DIGITS : /\d+/
 304
 305 COMMA : ','
 306
 307 QUOTE : /'/
 308
 309 };
 310
 311 sub parse {
 312     my ( $translator, $data ) = @_;
 313     my $parser = Parse::RecDescent->new($GRAMMAR);
 314
 315     local $::RD_TRACE  = $translator->trace ? 1 : undef;
 316     local $DEBUG       = $translator->debug;
 317
 318     unless (defined $parser) {
 319         return $translator->error("Error instantiating Parse::RecDescent ".
 320             "instance: Bad grammer");
 321     }
 322
 323     my $result = $parser->startrule($data);
 324     return $translator->error( "Parse failed." ) unless defined $result;
 325     warn Dumper( $result ) if $DEBUG;
 326
 327     my $schema = $translator->schema;
 328     my @tables = sort {
 329         $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
 330     } keys %{ $result };
 331
 332     for my $table_name ( @tables ) {
 333         my $tdata = $result->{ $table_name };
 334         my $table = $schema->add_table( name => $tdata->{'name'} )
 335                     or die "Can't create table '$table_name': ", $schema->error;
 336
 337         $table->comments( $tdata->{'comments'} );
 338
 339         my @fields = sort {
 340             $tdata->{'fields'}->{$a}->{'order'}
 341             <=>
 342             $tdata->{'fields'}->{$b}->{'order'}
 343         } keys %{ $tdata->{'fields'} };
 344
 345         for my $fname ( @fields ) {
 346             my $fdata = $tdata->{'fields'}{ $fname };
 347             my $field = $table->add_field(
 348                 name              => $fdata->{'name'},
 349                 data_type         => $fdata->{'data_type'},
 350                 size              => $fdata->{'size'},
 351                 default_value     => $fdata->{'default'},
 352                 is_auto_increment => $fdata->{'is_auto_inc'},
 353                 is_nullable       => $fdata->{'nullable'},
 354                 comments          => $fdata->{'comments'},
 355             ) or die $table->error;
 356
 357             $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
 358
 359             for my $qual ( qw[ binary unsigned zerofill list ] ) {
 360                 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
 361                     next if ref $val eq 'ARRAY' && !@$val;
 362                     $field->extra( $qual, $val );
 363                 }
 364             }
 365
 366             if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
 367                 my %extra = $field->extra;
 368                 my $longest = 0;
 369                 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
 370                     $longest = $len if $len > $longest;
 371                 }
 372                 $field->size( $longest ) if $longest;
 373             }
 374
 375             for my $cdata ( @{ $fdata->{'constraints'} } ) {
 376                 next unless $cdata->{'type'} eq 'foreign_key';
 377                 $cdata->{'fields'} ||= [ $field->name ];
 378                 push @{ $tdata->{'constraints'} }, $cdata;
 379             }
 380         }
 381
 382         for my $idata ( @{ $tdata->{'indices'} || [] } ) {
 383             my $index  =  $table->add_index(
 384                 name   => $idata->{'name'},
 385                 type   => uc $idata->{'type'},
 386                 fields => $idata->{'fields'},
 387             ) or die $table->error;
 388         }
 389
 390         for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
 391             my $constraint       =  $table->add_constraint(
 392                 name             => $cdata->{'name'},
 393                 type             => $cdata->{'type'},
 394                 fields           => $cdata->{'fields'},
 395                 reference_table  => $cdata->{'reference_table'},
 396                 reference_fields => $cdata->{'reference_fields'},
 397                 match_type       => $cdata->{'match_type'} || '',
 398                 on_delete        => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
 399                 on_update        => $cdata->{'on_update'} || $cdata->{'on_update_do'},
 400             ) or die $table->error;
 401         }
 402     }
 403
 404     return 1;
 405 }
 406
 407 1;
 408
 409 # -------------------------------------------------------------------
 410 # Every hero becomes a bore at last.
 411 # Ralph Waldo Emerson
 412 # -------------------------------------------------------------------
 413
 414 =pod
 415
 416 =head1 AUTHOR
 417
 418 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 419
 420 =head1 SEE ALSO
 421
 422 SQL::Translator, SQL::Translator::Parser::DBI, L<http://www.midsomer.org/>.
 423
 424 =cut