1 package SQL::Translator::Parser::SQLServer;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
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.
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.
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
19 # -------------------------------------------------------------------
23 SQL::Translator::Parser::SQLServer - parser for SQL Server
27 use SQL::Translator::Parser::SQLServer;
31 Adapted from Parser::Sybase and mostly parses the output of
32 Producer::SQLServer. The parsing is by no means complete and
33 should probably be considered a work in progress.
39 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
41 $DEBUG = 0 unless defined $DEBUG;
44 use Parse::RecDescent;
46 use base qw(Exporter);
48 @EXPORT_OK = qw(parse);
57 my ( %tables, @table_comments, $table_order, %procedures, $proc_order, %views, $view_order );
60 startrule : statement(s) eofile
64 procedures => \%procedures,
71 statement : create_table
87 { @table_comments = () }
89 setuser : /setuser/i NAME GO
91 if : /if/i object_not_null begin if_command end GO
97 object_not_null : /object_id/i '(' ident ')' /is not null/i
99 print : /\s*/ /print/i /.*/
107 grant : /grant/i /[^\n]*/
109 exec : exec_statement(s) GO
111 exec_statement : /exec/i /[^\n]+/
113 comment : /^\s*(?:#|-{2}).*\n/
115 my $comment = $item[1];
116 $comment =~ s/^\s*(#|--)\s*//;
117 $comment =~ s/\s*$//;
119 push @table_comments, $comment;
122 comment : comment_start comment_middle comment_end
124 my $comment = $item[2];
125 $comment =~ s/^\s*|\s*$//mg;
126 $comment =~ s/^\**\s*//mg;
127 push @table_comments, $comment;
130 comment_start : m#^\s*\/\*#
132 comment_end : m#\s*\*\/#
134 comment_middle : m{([^*]+|\*(?!/))*}
136 drop : if_exists(?) /drop/i tbl_drop END_STATEMENT
138 tbl_drop : /table/i NAME
140 if_exists : /if exists/i '(' /select/i 'name' /from/i 'sysobjects' /[^\)]+/ ')'
145 create_table : /create/i /table/i ident '(' create_def(s /,/) ')' lock(?) on_system(?) END_STATEMENT
147 my $table_owner = $item[3]{'owner'};
148 my $table_name = $item[3]{'name'};
150 if ( @table_comments ) {
151 $tables{ $table_name }{'comments'} = [ @table_comments ];
152 @table_comments = ();
155 $tables{ $table_name }{'order'} = ++$table_order;
156 $tables{ $table_name }{'name'} = $table_name;
157 $tables{ $table_name }{'owner'} = $table_owner;
158 $tables{ $table_name }{'system'} = $item[7];
161 for my $def ( @{ $item[5] } ) {
162 if ( $def->{'supertype'} eq 'field' ) {
163 my $field_name = $def->{'name'};
164 $tables{ $table_name }{'fields'}{ $field_name } =
165 { %$def, order => $i };
168 if ( $def->{'is_primary_key'} ) {
169 push @{ $tables{ $table_name }{'constraints'} }, {
170 type => 'primary_key',
171 fields => [ $field_name ],
175 elsif ( $def->{'supertype'} eq 'constraint' ) {
176 push @{ $tables{ $table_name }{'constraints'} }, $def;
179 push @{ $tables{ $table_name }{'indices'} }, $def;
184 create_constraint : /create/i constraint
186 @table_comments = ();
187 push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
190 create_constraint : /alter/i /table/i ident /add/i foreign_key_constraint END_STATEMENT
192 push @{ $tables{ $item[3]{name} }{constraints} }, $item[5];
195 create_index : /create/i index
197 @table_comments = ();
198 push @{ $tables{ $item[2]{'table'} }{'indices'} }, $item[2];
201 create_procedure : /create/i PROCEDURE WORD not_go GO
203 @table_comments = ();
204 my $proc_name = $item[3];
206 my $sql = "$item[1] $item[2] $proc_name $item[4]";
208 $procedures{ $proc_name }{'order'} = ++$proc_order;
209 $procedures{ $proc_name }{'name'} = $proc_name;
210 $procedures{ $proc_name }{'owner'} = $owner;
211 $procedures{ $proc_name }{'sql'} = $sql;
214 create_procedure : /create/i PROCEDURE '[' WORD '].' WORD not_go GO
216 @table_comments = ();
217 my $proc_name = $item[6];
218 my $owner = $item[4];
219 my $sql = "$item[1] $item[2] [$owner].$proc_name $item[7]";
221 $procedures{ $proc_name }{'order'} = ++$proc_order;
222 $procedures{ $proc_name }{'name'} = $proc_name;
223 $procedures{ $proc_name }{'owner'} = $owner;
224 $procedures{ $proc_name }{'sql'} = $sql;
227 PROCEDURE : /procedure/i
230 create_view : /create/i /view/i WORD not_go GO
232 @table_comments = ();
233 my $view_name = $item[3];
234 my $sql = "$item[1] $item[2] $item[3] $item[4]";
236 $views{ $view_name }{'order'} = ++$view_order;
237 $views{ $view_name }{'name'} = $view_name;
238 $views{ $view_name }{'sql'} = $sql;
241 not_go : /((?!\bgo\b).)*/is
243 create_def : constraint
249 field : field_name data_type field_qualifier(s?)
251 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
252 my $nullable = defined $qualifiers{'nullable'}
253 ? $qualifiers{'nullable'} : 1;
255 supertype => 'field',
256 name => $item{'field_name'},
257 data_type => $item{'data_type'}{'type'},
258 size => $item{'data_type'}{'size'},
259 nullable => $nullable,
260 default => $qualifiers{'default_val'},
261 is_auto_inc => $qualifiers{'is_auto_inc'},
262 # is_primary_key => $item{'primary_key'}[0],
266 field_qualifier : nullable
269 nullable => $item{'nullable'},
273 field_qualifier : default_val
276 default_val => $item{'default_val'},
280 field_qualifier : auto_inc
283 is_auto_inc => $item{'auto_inc'},
287 constraint : primary_key_constraint
288 | foreign_key_constraint
297 data_type : WORD field_size(?)
305 lock : /lock/i /datarows/i
309 field_size : '(' num_range ')' { $item{'num_range'} }
311 num_range : DIGITS ',' DIGITS
312 { $return = $item[1].','.$item[3] }
314 { $return = $item[1] }
317 nullable : /not/i /null/i
322 default_val : /default/i /null/i
324 | /default/i /'[^']*'/
325 { $item[2]=~ s/'//g; $return = $item[2] }
327 auto_inc : /identity/i { 1 }
329 primary_key_constraint : /constraint/i index_name(?) /primary/i /key/i parens_field_list
332 supertype => 'constraint',
334 type => 'primary_key',
339 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(?)
342 supertype => 'constraint',
344 type => 'foreign_key',
346 reference_table => $item[7],
347 reference_fields => $item[8][0],
348 on_delete => $item[9][0],
349 on_update => $item[10][0],
353 unique_constraint : /constraint/i index_name(?) /unique/i parens_field_list
356 supertype => 'constraint',
363 unique_constraint : /unique/i clustered(?) INDEX(?) index_name(?) on_table(?) parens_field_list
366 supertype => 'constraint',
368 clustered => $item[2][0],
370 table => $item[5][0],
375 on_delete : /on delete/i reference_option
378 on_update : /on update/i reference_option
381 reference_option: /cascade/i
386 clustered : /clustered/i
393 on_table : /on/i table_name
394 { $return = $item[2] }
396 on_system : /on/i /system/i
399 index : clustered(?) INDEX index_name(?) on_table(?) parens_field_list END_STATEMENT
402 supertype => 'index',
404 clustered => $item[1][0],
406 table => $item[4][0],
411 parens_field_list : '(' field_name(s /,/) ')'
414 ident : QUOTE(?) WORD '.' WORD QUOTE(?)
415 { $return = { owner => $item[2], name => $item[4] } }
417 { $return = { name => $item[1] } }
424 NAME : QUOTE(?) /\w+/ QUOTE(?)
437 # -------------------------------------------------------------------
439 my ( $translator, $data ) = @_;
440 my $parser = Parse::RecDescent->new($GRAMMAR);
442 local $::RD_TRACE = $translator->trace ? 1 : undef;
443 local $DEBUG = $translator->debug;
445 unless (defined $parser) {
446 return $translator->error("Error instantiating Parse::RecDescent ".
447 "instance: Bad grammer");
450 my $result = $parser->startrule($data);
451 return $translator->error( "Parse failed." ) unless defined $result;
452 warn Dumper( $result ) if $DEBUG;
454 my $schema = $translator->schema;
456 $result->{tables}->{ $a }->{'order'} <=> $result->{tables}->{ $b }->{'order'}
457 } keys %{ $result->{tables} };
459 for my $table_name ( @tables ) {
460 my $tdata = $result->{tables}->{ $table_name };
461 my $table = $schema->add_table( name => $tdata->{'name'} )
462 or die "Can't create table '$table_name': ", $schema->error;
464 $table->comments( $tdata->{'comments'} );
467 $tdata->{'fields'}->{$a}->{'order'}
469 $tdata->{'fields'}->{$b}->{'order'}
470 } keys %{ $tdata->{'fields'} };
472 for my $fname ( @fields ) {
473 my $fdata = $tdata->{'fields'}{ $fname };
474 my $field = $table->add_field(
475 name => $fdata->{'name'},
476 data_type => $fdata->{'data_type'},
477 size => $fdata->{'size'},
478 default_value => $fdata->{'default'},
479 is_auto_increment => $fdata->{'is_auto_inc'},
480 is_nullable => $fdata->{'nullable'},
481 comments => $fdata->{'comments'},
482 ) or die $table->error;
484 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
486 for my $qual ( qw[ binary unsigned zerofill list ] ) {
487 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
488 next if ref $val eq 'ARRAY' && !@$val;
489 $field->extra( $qual, $val );
493 if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
494 my %extra = $field->extra;
496 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
497 $longest = $len if $len > $longest;
499 $field->size( $longest ) if $longest;
502 for my $cdata ( @{ $fdata->{'constraints'} } ) {
503 next unless $cdata->{'type'} eq 'foreign_key';
504 $cdata->{'fields'} ||= [ $field->name ];
505 push @{ $tdata->{'constraints'} }, $cdata;
509 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
510 my $index = $table->add_index(
511 name => $idata->{'name'},
512 type => uc $idata->{'type'},
513 fields => $idata->{'fields'},
514 ) or die $table->error;
517 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
518 my $constraint = $table->add_constraint(
519 name => $cdata->{'name'},
520 type => $cdata->{'type'},
521 fields => $cdata->{'fields'},
522 reference_table => $cdata->{'reference_table'},
523 reference_fields => $cdata->{'reference_fields'},
524 match_type => $cdata->{'match_type'} || '',
525 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
526 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
527 ) or die $table->error;
531 my @procedures = sort {
532 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
533 } keys %{ $result->{procedures} };
534 for my $proc_name (@procedures) {
535 $schema->add_procedure(
537 owner => $result->{procedures}->{$proc_name}->{owner},
538 sql => $result->{procedures}->{$proc_name}->{sql},
543 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
544 } keys %{ $result->{views} };
545 for my $view_name (keys %{ $result->{views} }) {
548 sql => $result->{views}->{$view_name}->{sql},
557 # -------------------------------------------------------------------
558 # Every hero becomes a bore at last.
559 # Ralph Waldo Emerson
560 # -------------------------------------------------------------------
566 Chris Hilton E<lt>chris@dctank.comE<gt> - Bulk of code from
567 Sybase parser, I just tweaked it for SQLServer. Thanks.
571 SQL::Translator, SQL::Translator::Parser::DBI, L<http://www.midsomer.org/>.