1 package SQL::Translator::Parser::SQLServer;
3 # -------------------------------------------------------------------
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-2009 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 $GRAMMAR @EXPORT_OK ];
42 $DEBUG = 0 unless defined $DEBUG;
45 use Parse::RecDescent;
47 use base qw(Exporter);
49 @EXPORT_OK = qw(parse);
58 my ( %tables, @table_comments, $table_order, %procedures, $proc_order, %views, $view_order );
61 startrule : statement(s) eofile
65 procedures => \%procedures,
72 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{([^*]+|\*(?!/))*}
139 create_table : /create/i /table/i ident '(' create_def(s /,/) ')' lock(?) on_system(?) END_STATEMENT
141 my $table_owner = $item[3]{'owner'};
142 my $table_name = $item[3]{'name'};
144 if ( @table_comments ) {
145 $tables{ $table_name }{'comments'} = [ @table_comments ];
146 @table_comments = ();
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];
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 };
162 if ( $def->{'is_primary_key'} ) {
163 push @{ $tables{ $table_name }{'constraints'} }, {
164 type => 'primary_key',
165 fields => [ $field_name ],
169 elsif ( $def->{'supertype'} eq 'constraint' ) {
170 push @{ $tables{ $table_name }{'constraints'} }, $def;
173 push @{ $tables{ $table_name }{'indices'} }, $def;
178 create_constraint : /create/i constraint
180 @table_comments = ();
181 push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
184 create_index : /create/i index
186 @table_comments = ();
187 push @{ $tables{ $item[2]{'table'} }{'indices'} }, $item[2];
190 create_procedure : /create/i PROCEDURE WORD not_go GO
192 @table_comments = ();
193 my $proc_name = $item[3];
195 my $sql = "$item[1] $item[2] $proc_name $item[4]";
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;
203 create_procedure : /create/i PROCEDURE '[' WORD '].' WORD not_go GO
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]";
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;
216 PROCEDURE : /procedure/i
219 create_view : /create/i /view/i WORD not_go GO
221 @table_comments = ();
222 my $view_name = $item[3];
223 my $sql = "$item[1] $item[2] $item[3] $item[4]";
225 $views{ $view_name }{'order'} = ++$view_order;
226 $views{ $view_name }{'name'} = $view_name;
227 $views{ $view_name }{'sql'} = $sql;
230 not_go : /((?!\bgo\b).)*/is
232 create_def : constraint
238 field : field_name data_type field_qualifier(s?)
240 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
241 my $nullable = defined $qualifiers{'nullable'}
242 ? $qualifiers{'nullable'} : 1;
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],
255 field_qualifier : nullable
258 nullable => $item{'nullable'},
262 field_qualifier : default_val
265 default_val => $item{'default_val'},
269 field_qualifier : auto_inc
272 is_auto_inc => $item{'auto_inc'},
276 constraint : primary_key_constraint
277 | foreign_key_constraint
286 data_type : WORD field_size(?)
294 lock : /lock/i /datarows/i
298 field_size : '(' num_range ')' { $item{'num_range'} }
300 num_range : DIGITS ',' DIGITS
301 { $return = $item[1].','.$item[3] }
303 { $return = $item[1] }
306 nullable : /not/i /null/i
311 default_val : /default/i /null/i
313 | /default/i /'[^']*'/
314 { $item[2]=~ s/'//g; $return = $item[2] }
316 auto_inc : /identity/i { 1 }
318 primary_key_constraint : /constraint/i index_name(?) /primary/i /key/i parens_field_list
321 supertype => 'constraint',
323 type => 'primary_key',
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(?)
331 supertype => 'constraint',
333 type => 'foreign_key',
335 reference_table => $item[7],
336 reference_fields => $item[8][0],
337 on_delete => $item[9][0],
338 on_update => $item[10][0],
342 unique_constraint : /unique/i clustered(?) INDEX(?) index_name(?) on_table(?) parens_field_list
345 supertype => 'constraint',
347 clustered => $item[2][0],
349 table => $item[5][0],
354 on_delete : /on delete/i reference_option
357 on_update : /on update/i reference_option
360 reference_option: /cascade/i
365 clustered : /clustered/i
372 on_table : /on/i table_name
373 { $return = $item[2] }
375 on_system : /on/i /system/i
378 index : clustered(?) INDEX index_name(?) on_table(?) parens_field_list ';'
381 supertype => 'index',
383 clustered => $item[1][0],
385 table => $item[4][0],
390 parens_field_list : '(' field_name(s /,/) ')'
393 ident : QUOTE(?) WORD '.' WORD QUOTE(?)
394 { $return = { owner => $item[2], name => $item[4] } }
396 { $return = { name => $item[1] } }
403 NAME : QUOTE(?) /\w+/ QUOTE(?)
416 # -------------------------------------------------------------------
418 my ( $translator, $data ) = @_;
419 my $parser = Parse::RecDescent->new($GRAMMAR);
421 local $::RD_TRACE = $translator->trace ? 1 : undef;
422 local $DEBUG = $translator->debug;
424 unless (defined $parser) {
425 return $translator->error("Error instantiating Parse::RecDescent ".
426 "instance: Bad grammer");
429 my $result = $parser->startrule($data);
430 return $translator->error( "Parse failed." ) unless defined $result;
431 warn Dumper( $result ) if $DEBUG;
433 my $schema = $translator->schema;
435 $result->{tables}->{ $a }->{'order'} <=> $result->{tables}->{ $b }->{'order'}
436 } keys %{ $result->{tables} };
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;
443 $table->comments( $tdata->{'comments'} );
446 $tdata->{'fields'}->{$a}->{'order'}
448 $tdata->{'fields'}->{$b}->{'order'}
449 } keys %{ $tdata->{'fields'} };
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;
463 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
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 );
472 if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
473 my %extra = $field->extra;
475 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
476 $longest = $len if $len > $longest;
478 $field->size( $longest ) if $longest;
481 for my $cdata ( @{ $fdata->{'constraints'} } ) {
482 next unless $cdata->{'type'} eq 'foreign_key';
483 $cdata->{'fields'} ||= [ $field->name ];
484 push @{ $tdata->{'constraints'} }, $cdata;
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;
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;
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(
516 owner => $result->{procedures}->{$proc_name}->{owner},
517 sql => $result->{procedures}->{$proc_name}->{sql},
522 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
523 } keys %{ $result->{views} };
524 for my $view_name (keys %{ $result->{views} }) {
527 sql => $result->{views}->{$view_name}->{sql},
536 # -------------------------------------------------------------------
537 # Every hero becomes a bore at last.
538 # Ralph Waldo Emerson
539 # -------------------------------------------------------------------
545 Chris Hilton E<lt>chris@dctank.comE<gt> - Bulk of code from
546 Sybase parser, I just tweaked it for SQLServer. Thanks.
550 SQL::Translator, SQL::Translator::Parser::DBI, L<http://www.midsomer.org/>.