lib/SQL/Translator/Parser/SQLServer.pm

   1 package SQL::Translator::Parser::SQLServer;
   2
   3 # -------------------------------------------------------------------
   4 # $Id: SQLServer.pm 1440 2009-01-17 16:31:57Z jawnsy $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2002-2009 SQLFairy Authors
   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::SQLServer - parser for SQL Server
  26
  27 =head1 SYNOPSIS
  28
  29   use SQL::Translator::Parser::SQLServer;
  30
  31 =head1 DESCRIPTION
  32
  33 Adapted from Parser::Sybase and mostly parses the output of
  34 Producer::SQLServer.  The parsing is by no means complete and
  35 should probably be considered a work in progress.
  36
  37 =cut
  38
  39 use strict;
  40
  41 use vars qw[ $DEBUG $GRAMMAR @EXPORT_OK ];
  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, %procedures, $proc_order, %views, $view_order );
  59 }
  60
  61 startrule : statement(s) eofile
  62         {
  63                 return {
  64                         tables     => \%tables,
  65                         procedures => \%procedures,
  66                         views      => \%views,
  67                 }
  68         }
  69
  70 eofile : /^\Z/
  71
  72 statement : create_table
  73     | create_procedure
  74     | create_view
  75     | create_index
  76     | create_constraint
  77     | comment
  78     | use
  79     | setuser
  80     | if
  81     | print
  82     | grant
  83     | exec
  84     | <error>
  85
  86 use : /use/i WORD GO
  87     { @table_comments = () }
  88
  89 setuser : /setuser/i NAME GO
  90
  91 if : /if/i object_not_null begin if_command end GO
  92
  93 if_command : grant
  94     | create_index
  95     | create_constraint
  96
  97 object_not_null : /object_id/i '(' ident ')' /is not null/i
  98
  99 print : /\s*/ /print/i /.*/
 100
 101 else : /else/i /.*/
 102
 103 begin : /begin/i
 104
 105 end : /end/i
 106
 107 grant : /grant/i /[^\n]*/
 108
 109 exec : exec_statement(s) GO
 110
 111 exec_statement : /exec/i /[^\n]+/
 112
 113 comment : /^\s*(?:#|-{2}).*\n/
 114     {
 115         my $comment =  $item[1];
 116         $comment    =~ s/^\s*(#|--)\s*//;
 117         $comment    =~ s/\s*$//;
 118         $return     = $comment;
 119         push @table_comments, $comment;
 120     }
 121
 122 comment : comment_start comment_middle comment_end
 123     {
 124         my $comment = $item[2];
 125         $comment =~ s/^\s*|\s*$//mg;
 126         $comment =~ s/^\**\s*//mg;
 127         push @table_comments, $comment;
 128     }
 129
 130 comment_start : m#^\s*\/\*#
 131
 132 comment_end : m#\s*\*\/#
 133
 134 comment_middle : m{([^*]+|\*(?!/))*}
 135
 136 #
 137 # Create table.
 138 #
 139 create_table : /create/i /table/i ident '(' create_def(s /,/) ')' lock(?) on_system(?) END_STATEMENT
 140     {
 141         my $table_owner = $item[3]{'owner'};
 142         my $table_name  = $item[3]{'name'};
 143
 144         if ( @table_comments ) {
 145             $tables{ $table_name }{'comments'} = [ @table_comments ];
 146             @table_comments = ();
 147         }
 148
 149         $tables{ $table_name }{'order'}  = ++$table_order;
 150         $tables{ $table_name }{'name'}   = $table_name;
 151         $tables{ $table_name }{'owner'}  = $table_owner;
 152         $tables{ $table_name }{'system'} = $item[7];
 153
 154         my $i = 0;
 155         for my $def ( @{ $item[5] } ) {
 156             if ( $def->{'supertype'} eq 'field' ) {
 157                 my $field_name = $def->{'name'};
 158                 $tables{ $table_name }{'fields'}{ $field_name } =
 159                     { %$def, order => $i };
 160                 $i++;
 161
 162                 if ( $def->{'is_primary_key'} ) {
 163                     push @{ $tables{ $table_name }{'constraints'} }, {
 164                         type   => 'primary_key',
 165                         fields => [ $field_name ],
 166                     };
 167                 }
 168             }
 169             elsif ( $def->{'supertype'} eq 'constraint' ) {
 170                 push @{ $tables{ $table_name }{'constraints'} }, $def;
 171             }
 172             else {
 173                 push @{ $tables{ $table_name }{'indices'} }, $def;
 174             }
 175         }
 176     }
 177
 178 create_constraint : /create/i constraint
 179     {
 180         @table_comments = ();
 181         push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
 182     }
 183
 184 create_index : /create/i index
 185     {
 186         @table_comments = ();
 187         push @{ $tables{ $item[2]{'table'} }{'indices'} }, $item[2];
 188     }
 189
 190 create_procedure : /create/i PROCEDURE WORD not_go GO
 191     {
 192         @table_comments = ();
 193         my $proc_name = $item[3];
 194         my $owner = '';
 195         my $sql = "$item[1] $item[2] $proc_name $item[4]";
 196
 197         $procedures{ $proc_name }{'order'}  = ++$proc_order;
 198         $procedures{ $proc_name }{'name'}   = $proc_name;
 199         $procedures{ $proc_name }{'owner'}  = $owner;
 200         $procedures{ $proc_name }{'sql'}    = $sql;
 201     }
 202
 203 create_procedure : /create/i PROCEDURE '[' WORD '].' WORD not_go GO
 204     {
 205         @table_comments = ();
 206         my $proc_name = $item[6];
 207         my $owner = $item[4];
 208         my $sql = "$item[1] $item[2] [$owner].$proc_name $item[7]";
 209
 210         $procedures{ $proc_name }{'order'}  = ++$proc_order;
 211         $procedures{ $proc_name }{'name'}   = $proc_name;
 212         $procedures{ $proc_name }{'owner'}  = $owner;
 213         $procedures{ $proc_name }{'sql'}    = $sql;
 214     }
 215
 216 PROCEDURE : /procedure/i
 217         | /function/i
 218
 219 create_view : /create/i /view/i WORD not_go GO
 220     {
 221         @table_comments = ();
 222         my $view_name = $item[3];
 223         my $sql = "$item[1] $item[2] $item[3] $item[4]";
 224
 225         $views{ $view_name }{'order'}  = ++$view_order;
 226         $views{ $view_name }{'name'}   = $view_name;
 227         $views{ $view_name }{'sql'}    = $sql;
 228     }
 229
 230 not_go : /((?!\bgo\b).)*/is
 231
 232 create_def : constraint
 233     | index
 234     | field
 235
 236 blank : /\s*/
 237
 238 field : field_name data_type field_qualifier(s?)
 239     {
 240         my %qualifiers  = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
 241         my $nullable = defined $qualifiers{'nullable'}
 242                    ? $qualifiers{'nullable'} : 1;
 243         $return = {
 244             supertype      => 'field',
 245             name           => $item{'field_name'},
 246             data_type      => $item{'data_type'}{'type'},
 247             size           => $item{'data_type'}{'size'},
 248             nullable       => $nullable,
 249             default        => $qualifiers{'default_val'},
 250             is_auto_inc    => $qualifiers{'is_auto_inc'},
 251 #            is_primary_key => $item{'primary_key'}[0],
 252         }
 253     }
 254
 255 field_qualifier : nullable
 256     {
 257         $return = {
 258              nullable => $item{'nullable'},
 259         }
 260     }
 261
 262 field_qualifier : default_val
 263     {
 264         $return = {
 265              default_val => $item{'default_val'},
 266         }
 267     }
 268
 269 field_qualifier : auto_inc
 270     {
 271         $return = {
 272              is_auto_inc => $item{'auto_inc'},
 273         }
 274     }
 275
 276 constraint : primary_key_constraint
 277     | foreign_key_constraint
 278     | unique_constraint
 279
 280 field_name : WORD
 281
 282 index_name : WORD
 283
 284 table_name : WORD
 285
 286 data_type : WORD field_size(?)
 287     {
 288         $return = {
 289             type => $item[1],
 290             size => $item[2][0]
 291         }
 292     }
 293
 294 lock : /lock/i /datarows/i
 295
 296 field_type : WORD
 297
 298 field_size : '(' num_range ')' { $item{'num_range'} }
 299
 300 num_range : DIGITS ',' DIGITS
 301     { $return = $item[1].','.$item[3] }
 302                | DIGITS
 303     { $return = $item[1] }
 304
 305
 306 nullable : /not/i /null/i
 307     { $return = 0 }
 308     | /null/i
 309     { $return = 1 }
 310
 311 default_val : /default/i /null/i
 312     { $return = 'null' }
 313         | /default/i /'[^']*'/
 314     { $item[2]=~ s/'//g; $return = $item[2] }
 315
 316 auto_inc : /identity/i { 1 }
 317
 318 primary_key_constraint : /constraint/i index_name(?) /primary/i /key/i parens_field_list
 319     {
 320         $return = {
 321             supertype => 'constraint',
 322             name      => $item[2][0],
 323             type      => 'primary_key',
 324             fields    => $item[5],
 325         }
 326     }
 327
 328 foreign_key_constraint : /constraint/i index_name(?) /foreign/i /key/i parens_field_list /references/i table_name parens_field_list(?) on_delete(?) on_update(?)
 329     {
 330         $return = {
 331             supertype        => 'constraint',
 332             name             => $item[2][0],
 333             type             => 'foreign_key',
 334             fields           => $item[5],
 335             reference_table  => $item[7],
 336             reference_fields => $item[8][0],
 337             on_delete        => $item[9][0],
 338             on_update        => $item[10][0],
 339         }
 340     }
 341
 342 unique_constraint : /unique/i clustered(?) INDEX(?) index_name(?) on_table(?) parens_field_list
 343     {
 344         $return = {
 345             supertype => 'constraint',
 346             type      => 'unique',
 347             clustered => $item[2][0],
 348             name      => $item[4][0],
 349             table     => $item[5][0],
 350             fields    => $item[6],
 351         }
 352     }
 353
 354 on_delete : /on delete/i reference_option
 355     { $item[2] }
 356
 357 on_update : /on update/i reference_option
 358     { $item[2] }
 359
 360 reference_option: /cascade/i
 361     { $item[1] }
 362     | /no action/i
 363     { $item[1] }
 364
 365 clustered : /clustered/i
 366     { $return = 1 }
 367     | /nonclustered/i
 368     { $return = 0 }
 369
 370 INDEX : /index/i
 371
 372 on_table : /on/i table_name
 373     { $return = $item[2] }
 374
 375 on_system : /on/i /system/i
 376     { $return = 1 }
 377
 378 index : clustered(?) INDEX index_name(?) on_table(?) parens_field_list ';'
 379     {
 380         $return = {
 381             supertype => 'index',
 382             type      => 'normal',
 383             clustered => $item[1][0],
 384             name      => $item[3][0],
 385             table     => $item[4][0],
 386             fields    => $item[5],
 387         }
 388     }
 389
 390 parens_field_list : '(' field_name(s /,/) ')'
 391     { $item[2] }
 392
 393 ident : QUOTE(?) WORD '.' WORD QUOTE(?)
 394     { $return = { owner => $item[2], name => $item[4] } }
 395     | WORD
 396     { $return = { name  => $item[1] } }
 397
 398 END_STATEMENT : ';'
 399         | GO
 400
 401 GO : /^go/i
 402
 403 NAME : QUOTE(?) /\w+/ QUOTE(?)
 404     { $item[2] }
 405
 406 WORD : /[\w#]+/
 407
 408 DIGITS : /\d+/
 409
 410 COMMA : ','
 411
 412 QUOTE : /'/
 413
 414 };
 415
 416 # -------------------------------------------------------------------
 417 sub parse {
 418     my ( $translator, $data ) = @_;
 419     my $parser = Parse::RecDescent->new($GRAMMAR);
 420
 421     local $::RD_TRACE  = $translator->trace ? 1 : undef;
 422     local $DEBUG       = $translator->debug;
 423
 424     unless (defined $parser) {
 425         return $translator->error("Error instantiating Parse::RecDescent ".
 426             "instance: Bad grammer");
 427     }
 428
 429     my $result = $parser->startrule($data);
 430     return $translator->error( "Parse failed." ) unless defined $result;
 431     warn Dumper( $result ) if $DEBUG;
 432
 433     my $schema = $translator->schema;
 434     my @tables = sort {
 435         $result->{tables}->{ $a }->{'order'} <=> $result->{tables}->{ $b }->{'order'}
 436     } keys %{ $result->{tables} };
 437
 438     for my $table_name ( @tables ) {
 439         my $tdata = $result->{tables}->{ $table_name };
 440         my $table = $schema->add_table( name => $tdata->{'name'} )
 441                     or die "Can't create table '$table_name': ", $schema->error;
 442
 443         $table->comments( $tdata->{'comments'} );
 444
 445         my @fields = sort {
 446             $tdata->{'fields'}->{$a}->{'order'}
 447             <=>
 448             $tdata->{'fields'}->{$b}->{'order'}
 449         } keys %{ $tdata->{'fields'} };
 450
 451         for my $fname ( @fields ) {
 452             my $fdata = $tdata->{'fields'}{ $fname };
 453             my $field = $table->add_field(
 454                 name              => $fdata->{'name'},
 455                 data_type         => $fdata->{'data_type'},
 456                 size              => $fdata->{'size'},
 457                 default_value     => $fdata->{'default'},
 458                 is_auto_increment => $fdata->{'is_auto_inc'},
 459                 is_nullable       => $fdata->{'nullable'},
 460                 comments          => $fdata->{'comments'},
 461             ) or die $table->error;
 462
 463             $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
 464
 465             for my $qual ( qw[ binary unsigned zerofill list ] ) {
 466                 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
 467                     next if ref $val eq 'ARRAY' && !@$val;
 468                     $field->extra( $qual, $val );
 469                 }
 470             }
 471
 472             if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
 473                 my %extra = $field->extra;
 474                 my $longest = 0;
 475                 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
 476                     $longest = $len if $len > $longest;
 477                 }
 478                 $field->size( $longest ) if $longest;
 479             }
 480
 481             for my $cdata ( @{ $fdata->{'constraints'} } ) {
 482                 next unless $cdata->{'type'} eq 'foreign_key';
 483                 $cdata->{'fields'} ||= [ $field->name ];
 484                 push @{ $tdata->{'constraints'} }, $cdata;
 485             }
 486         }
 487
 488         for my $idata ( @{ $tdata->{'indices'} || [] } ) {
 489             my $index  =  $table->add_index(
 490                 name   => $idata->{'name'},
 491                 type   => uc $idata->{'type'},
 492                 fields => $idata->{'fields'},
 493             ) or die $table->error;
 494         }
 495
 496         for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
 497             my $constraint       =  $table->add_constraint(
 498                 name             => $cdata->{'name'},
 499                 type             => $cdata->{'type'},
 500                 fields           => $cdata->{'fields'},
 501                 reference_table  => $cdata->{'reference_table'},
 502                 reference_fields => $cdata->{'reference_fields'},
 503                 match_type       => $cdata->{'match_type'} || '',
 504                 on_delete        => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
 505                 on_update        => $cdata->{'on_update'} || $cdata->{'on_update_do'},
 506             ) or die $table->error;
 507         }
 508     }
 509
 510     my @procedures = sort {
 511         $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
 512     } keys %{ $result->{procedures} };
 513     for my $proc_name (@procedures) {
 514         $schema->add_procedure(
 515                 name  => $proc_name,
 516                 owner => $result->{procedures}->{$proc_name}->{owner},
 517                 sql   => $result->{procedures}->{$proc_name}->{sql},
 518                 );
 519     }
 520
 521     my @views = sort {
 522         $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
 523     } keys %{ $result->{views} };
 524     for my $view_name (keys %{ $result->{views} }) {
 525         $schema->add_view(
 526                 name => $view_name,
 527                 sql  => $result->{views}->{$view_name}->{sql},
 528                 );
 529     }
 530
 531     return 1;
 532 }
 533
 534 1;
 535
 536 # -------------------------------------------------------------------
 537 # Every hero becomes a bore at last.
 538 # Ralph Waldo Emerson
 539 # -------------------------------------------------------------------
 540
 541 =pod
 542
 543 =head1 AUTHOR
 544
 545 Chris Hilton E<lt>chris@dctank.comE<gt> - Bulk of code from
 546 Sybase parser, I just tweaked it for SQLServer. Thanks.
 547
 548 =head1 SEE ALSO
 549
 550 SQL::Translator, SQL::Translator::Parser::DBI, L<http://www.midsomer.org/>.
 551
 552 =cut