1 package SQL::Translator::Parser::SQLServer;
3 # -------------------------------------------------------------------
4 # $Id: SQLServer.pm,v 1.5 2007-03-14 17:03:52 duality72 Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 SQLFairy Authors
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.
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.
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
21 # -------------------------------------------------------------------
25 SQL::Translator::Parser::SQLServer - parser for SQL Server
29 use SQL::Translator::Parser::SQLServer;
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.
41 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
42 $VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
43 $DEBUG = 0 unless defined $DEBUG;
46 use Parse::RecDescent;
48 use base qw(Exporter);
50 @EXPORT_OK = qw(parse);
59 my ( %tables, @table_comments, $table_order, %procedures, $proc_order, %views, $view_order );
62 startrule : statement(s) eofile
66 procedures => \%procedures,
73 statement : create_table
88 { @table_comments = () }
90 setuser : /setuser/i NAME GO
92 if : /if/i object_not_null begin if_command end GO
98 object_not_null : /object_id/i '(' ident ')' /is not null/i
100 print : /\s*/ /print/i /.*/
108 grant : /grant/i /[^\n]*/
110 exec : exec_statement(s) GO
112 exec_statement : /exec/i /[^\n]+/
114 comment : /^\s*(?:#|-{2}).*\n/
116 my $comment = $item[1];
117 $comment =~ s/^\s*(#|--)\s*//;
118 $comment =~ s/\s*$//;
120 push @table_comments, $comment;
123 comment : comment_start comment_middle comment_end
125 my $comment = $item[2];
126 $comment =~ s/^\s*|\s*$//mg;
127 $comment =~ s/^\**\s*//mg;
128 push @table_comments, $comment;
131 comment_start : m#^\s*\/\*#
133 comment_end : m#\s*\*\/#
135 comment_middle : m{([^*]+|\*(?!/))*}
140 create_table : /create/i /table/i ident '(' create_def(s /,/) ')' lock(?) on_system(?) END_STATEMENT
142 my $table_owner = $item[3]{'owner'};
143 my $table_name = $item[3]{'name'};
145 if ( @table_comments ) {
146 $tables{ $table_name }{'comments'} = [ @table_comments ];
147 @table_comments = ();
150 $tables{ $table_name }{'order'} = ++$table_order;
151 $tables{ $table_name }{'name'} = $table_name;
152 $tables{ $table_name }{'owner'} = $table_owner;
153 $tables{ $table_name }{'system'} = $item[7];
156 for my $def ( @{ $item[5] } ) {
157 if ( $def->{'supertype'} eq 'field' ) {
158 my $field_name = $def->{'name'};
159 $tables{ $table_name }{'fields'}{ $field_name } =
160 { %$def, order => $i };
163 if ( $def->{'is_primary_key'} ) {
164 push @{ $tables{ $table_name }{'constraints'} }, {
165 type => 'primary_key',
166 fields => [ $field_name ],
170 elsif ( $def->{'supertype'} eq 'constraint' ) {
171 push @{ $tables{ $table_name }{'constraints'} }, $def;
174 push @{ $tables{ $table_name }{'indices'} }, $def;
179 create_constraint : /create/i constraint
181 @table_comments = ();
182 push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
185 create_index : /create/i index
187 @table_comments = ();
188 push @{ $tables{ $item[2]{'table'} }{'indices'} }, $item[2];
191 create_procedure : /create/i PROCEDURE WORD not_go GO
193 @table_comments = ();
194 my $proc_name = $item[3];
196 my $sql = "$item[1] $item[2] $proc_name $item[4]";
198 $procedures{ $proc_name }{'order'} = ++$proc_order;
199 $procedures{ $proc_name }{'name'} = $proc_name;
200 $procedures{ $proc_name }{'owner'} = $owner;
201 $procedures{ $proc_name }{'sql'} = $sql;
204 create_procedure : /create/i PROCEDURE '[' WORD '].' WORD not_go GO
206 @table_comments = ();
207 my $proc_name = $item[6];
208 my $owner = $item[4];
209 my $sql = "$item[1] $item[2] [$owner].$proc_name $item[7]";
211 $procedures{ $proc_name }{'order'} = ++$proc_order;
212 $procedures{ $proc_name }{'name'} = $proc_name;
213 $procedures{ $proc_name }{'owner'} = $owner;
214 $procedures{ $proc_name }{'sql'} = $sql;
217 PROCEDURE : /procedure/i
220 procedure_body : not_go(s)
222 create_view : /create/i /view/i WORD not_go GO
224 @table_comments = ();
225 my $view_name = $item[3];
226 my $sql = "$item[1] $item[2] $item[3] $item[4]";
228 $views{ $view_name }{'order'} = ++$view_order;
229 $views{ $view_name }{'name'} = $view_name;
230 $views{ $view_name }{'sql'} = $sql;
233 view_body : not_go(s)
235 not_go : /((?!\bgo\b).)*/is
237 create_def : constraint
243 field : field_name data_type field_qualifier(s?)
245 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
246 my $nullable = defined $qualifiers{'nullable'}
247 ? $qualifiers{'nullable'} : 1;
249 supertype => 'field',
250 name => $item{'field_name'},
251 data_type => $item{'data_type'}{'type'},
252 size => $item{'data_type'}{'size'},
253 nullable => $nullable,
254 default => $qualifiers{'default_val'},
255 is_auto_inc => $qualifiers{'is_auto_inc'},
256 # is_primary_key => $item{'primary_key'}[0],
260 field_qualifier : nullable
263 nullable => $item{'nullable'},
267 field_qualifier : default_val
270 default_val => $item{'default_val'},
274 field_qualifier : auto_inc
277 is_auto_inc => $item{'auto_inc'},
281 constraint : primary_key_constraint
282 | foreign_key_constraint
291 data_type : WORD field_size(?)
299 lock : /lock/i /datarows/i
303 field_size : '(' num_range ')' { $item{'num_range'} }
305 num_range : DIGITS ',' DIGITS
306 { $return = $item[1].','.$item[3] }
308 { $return = $item[1] }
311 nullable : /not/i /null/i
316 default_val : /default/i /null/i
318 | /default/i /'[^']*'/
319 { $item[2]=~ s/'//g; $return = $item[2] }
321 auto_inc : /identity/i { 1 }
323 primary_key_constraint : /constraint/i index_name(?) /primary/i /key/i parens_field_list
326 supertype => 'constraint',
328 type => 'primary_key',
333 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(?)
336 supertype => 'constraint',
338 type => 'foreign_key',
340 reference_table => $item[7],
341 reference_fields => $item[8][0],
342 on_delete => $item[9][0],
343 on_update => $item[10][0],
347 unique_constraint : /unique/i clustered(?) INDEX(?) index_name(?) on_table(?) parens_field_list
350 supertype => 'constraint',
352 clustered => $item[2][0],
354 table => $item[5][0],
359 on_delete : /on delete/i reference_option
362 on_update : /on update/i reference_option
365 reference_option: /cascade/i
370 clustered : /clustered/i
377 on_table : /on/i table_name
378 { $return = $item[2] }
380 on_system : /on/i /system/i
383 index : clustered(?) INDEX index_name(?) on_table(?) parens_field_list ';'
386 supertype => 'index',
388 clustered => $item[1][0],
390 table => $item[4][0],
395 parens_field_list : '(' field_name(s /,/) ')'
398 ident : QUOTE(?) WORD '.' WORD QUOTE(?)
399 { $return = { owner => $item[2], name => $item[4] } }
401 { $return = { name => $item[1] } }
408 NAME : QUOTE(?) /\w+/ QUOTE(?)
421 # -------------------------------------------------------------------
423 my ( $translator, $data ) = @_;
424 my $parser = Parse::RecDescent->new($GRAMMAR);
426 local $::RD_TRACE = $translator->trace ? 1 : undef;
427 local $DEBUG = $translator->debug;
429 unless (defined $parser) {
430 return $translator->error("Error instantiating Parse::RecDescent ".
431 "instance: Bad grammer");
434 my $result = $parser->startrule($data);
435 return $translator->error( "Parse failed." ) unless defined $result;
436 warn Dumper( $result ) if $DEBUG;
438 my $schema = $translator->schema;
440 $result->{tables}->{ $a }->{'order'} <=> $result->{tables}->{ $b }->{'order'}
441 } keys %{ $result->{tables} };
443 for my $table_name ( @tables ) {
444 my $tdata = $result->{tables}->{ $table_name };
445 my $table = $schema->add_table( name => $tdata->{'name'} )
446 or die "Can't create table '$table_name': ", $schema->error;
448 $table->comments( $tdata->{'comments'} );
451 $tdata->{'fields'}->{$a}->{'order'}
453 $tdata->{'fields'}->{$b}->{'order'}
454 } keys %{ $tdata->{'fields'} };
456 for my $fname ( @fields ) {
457 my $fdata = $tdata->{'fields'}{ $fname };
458 my $field = $table->add_field(
459 name => $fdata->{'name'},
460 data_type => $fdata->{'data_type'},
461 size => $fdata->{'size'},
462 default_value => $fdata->{'default'},
463 is_auto_increment => $fdata->{'is_auto_inc'},
464 is_nullable => $fdata->{'nullable'},
465 comments => $fdata->{'comments'},
466 ) or die $table->error;
468 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
470 for my $qual ( qw[ binary unsigned zerofill list ] ) {
471 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
472 next if ref $val eq 'ARRAY' && !@$val;
473 $field->extra( $qual, $val );
477 if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
478 my %extra = $field->extra;
480 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
481 $longest = $len if $len > $longest;
483 $field->size( $longest ) if $longest;
486 for my $cdata ( @{ $fdata->{'constraints'} } ) {
487 next unless $cdata->{'type'} eq 'foreign_key';
488 $cdata->{'fields'} ||= [ $field->name ];
489 push @{ $tdata->{'constraints'} }, $cdata;
493 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
494 my $index = $table->add_index(
495 name => $idata->{'name'},
496 type => uc $idata->{'type'},
497 fields => $idata->{'fields'},
498 ) or die $table->error;
501 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
502 my $constraint = $table->add_constraint(
503 name => $cdata->{'name'},
504 type => $cdata->{'type'},
505 fields => $cdata->{'fields'},
506 reference_table => $cdata->{'reference_table'},
507 reference_fields => $cdata->{'reference_fields'},
508 match_type => $cdata->{'match_type'} || '',
509 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
510 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
511 ) or die $table->error;
515 my @procedures = sort {
516 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
517 } keys %{ $result->{procedures} };
518 for my $proc_name (@procedures) {
519 $schema->add_procedure(
521 owner => $result->{procedures}->{$proc_name}->{owner},
522 sql => $result->{procedures}->{$proc_name}->{sql},
527 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
528 } keys %{ $result->{views} };
529 for my $view_name (keys %{ $result->{views} }) {
532 sql => $result->{views}->{$view_name}->{sql},
541 # -------------------------------------------------------------------
542 # Every hero becomes a bore at last.
543 # Ralph Waldo Emerson
544 # -------------------------------------------------------------------
550 Chris Hilton E<lt>chris@dctank.comE<gt> - Bulk of code from
551 Sybase parser, I just tweaked it for SQLServer. Thanks.
555 SQL::Translator, SQL::Translator::Parser::DBI, L<http://www.midsomer.org/>.