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 );
61 my @up_to_N_lines = split (/\n/, $_[1], $max_lines + 1);
62 die sprintf ("Unable to parse line %d:\n%s\n",
64 join "\n", (map { "'$_'" } @up_to_N_lines[0..$max_lines - 1 ]), @up_to_N_lines > $max_lines ? '...' : ()
70 startrule : statement(s) eofile
74 procedures => \%procedures,
81 statement : create_table
95 | /^\Z/ | { _err ($thisline, $text) }
98 { @table_comments = () }
100 setuser : /setuser/i NAME GO
102 if : /if/i object_not_null begin if_command end GO
108 object_not_null : /object_id/i '(' ident ')' /is not null/i
110 field_not_null : /where/i field_name /is \s+ not \s+ null/ix
112 print : /\s*/ /print/i /.*/
120 grant : /grant/i /[^\n]*/
122 exec : exec_statement(s) GO
124 exec_statement : /exec/i /[^\n]+/
126 comment : /^\s*(?:#|-{2}).*\n/
128 my $comment = $item[1];
129 $comment =~ s/^\s*(#|--)\s*//;
130 $comment =~ s/\s*$//;
132 push @table_comments, $comment;
135 comment : comment_start comment_middle comment_end
137 my $comment = $item[2];
138 $comment =~ s/^\s*|\s*$//mg;
139 $comment =~ s/^\**\s*//mg;
140 push @table_comments, $comment;
143 comment_start : m#^\s*\/\*#
145 comment_end : m#\s*\*\/#
147 comment_middle : m{([^*]+|\*(?!/))*}
149 drop : if_exists(?) /drop/i tbl_drop END_STATEMENT
151 tbl_drop : /table/i ident
153 if_exists : /if exists/i '(' /select/i 'name' /from/i 'sysobjects' /[^\)]+/ ')'
158 create_table : /create/i /table/i ident '(' create_def(s /,/) ')' lock(?) on_system(?) END_STATEMENT
160 my $table_owner = $item[3]{'owner'};
161 my $table_name = $item[3]{'name'};
163 if ( @table_comments ) {
164 $tables{ $table_name }{'comments'} = [ @table_comments ];
165 @table_comments = ();
168 $tables{ $table_name }{'order'} = ++$table_order;
169 $tables{ $table_name }{'name'} = $table_name;
170 $tables{ $table_name }{'owner'} = $table_owner;
171 $tables{ $table_name }{'system'} = $item[7];
174 for my $def ( @{ $item[5] } ) {
175 if ( $def->{'supertype'} eq 'field' ) {
176 my $field_name = $def->{'name'};
177 $tables{ $table_name }{'fields'}{ $field_name } =
178 { %$def, order => $i };
181 if ( $def->{'is_primary_key'} ) {
182 push @{ $tables{ $table_name }{'constraints'} }, {
183 type => 'primary_key',
184 fields => [ $field_name ],
188 elsif ( $def->{'supertype'} eq 'constraint' ) {
189 push @{ $tables{ $table_name }{'constraints'} }, $def;
192 push @{ $tables{ $table_name }{'indices'} }, $def;
197 disable_constraints : if_exists(?) /alter/i /table/i ident /nocheck/i /constraint/i /all/i END_STATEMENT
199 # this is for the normal case
200 create_constraint : /create/i constraint END_STATEMENT
202 @table_comments = ();
203 push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
206 # and this is for the BEGIN/END case
207 create_constraint : /create/i constraint
209 @table_comments = ();
210 push @{ $tables{ $item[2]{'table'} }{'constraints'} }, $item[2];
214 create_constraint : /alter/i /table/i ident /add/i foreign_key_constraint END_STATEMENT
216 push @{ $tables{ $item[3]{name} }{constraints} }, $item[5];
220 create_index : /create/i index
222 @table_comments = ();
223 push @{ $tables{ $item[2]{'table'} }{'indices'} }, $item[2];
226 create_procedure : /create/i PROCEDURE WORD not_go GO
228 @table_comments = ();
229 my $proc_name = $item[3];
231 my $sql = "$item[1] $item[2] $proc_name $item[4]";
233 $procedures{ $proc_name }{'order'} = ++$proc_order;
234 $procedures{ $proc_name }{'name'} = $proc_name;
235 $procedures{ $proc_name }{'owner'} = $owner;
236 $procedures{ $proc_name }{'sql'} = $sql;
239 create_procedure : /create/i PROCEDURE '[' WORD '].' WORD not_go GO
241 @table_comments = ();
242 my $proc_name = $item[6];
243 my $owner = $item[4];
244 my $sql = "$item[1] $item[2] [$owner].$proc_name $item[7]";
246 $procedures{ $proc_name }{'order'} = ++$proc_order;
247 $procedures{ $proc_name }{'name'} = $proc_name;
248 $procedures{ $proc_name }{'owner'} = $owner;
249 $procedures{ $proc_name }{'sql'} = $sql;
252 PROCEDURE : /procedure/i
255 create_view : /create/i /view/i WORD not_go GO
257 @table_comments = ();
258 my $view_name = $item[3];
259 my $sql = "$item[1] $item[2] $item[3] $item[4]";
261 $views{ $view_name }{'order'} = ++$view_order;
262 $views{ $view_name }{'name'} = $view_name;
263 $views{ $view_name }{'sql'} = $sql;
266 not_go : /((?!\bgo\b).)*/is
268 create_def : constraint
274 field : field_name data_type field_qualifier(s?)
276 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
277 my $nullable = defined $qualifiers{'nullable'}
278 ? $qualifiers{'nullable'} : 1;
280 supertype => 'field',
281 name => $item{'field_name'},
282 data_type => $item{'data_type'}{'type'},
283 size => $item{'data_type'}{'size'},
284 nullable => $nullable,
285 default => $qualifiers{'default_val'},
286 is_auto_inc => $qualifiers{'is_auto_inc'},
287 # is_primary_key => $item{'primary_key'}[0],
291 field_qualifier : nullable
294 nullable => $item{'nullable'},
298 field_qualifier : default_val
301 default_val => $item{'default_val'},
305 field_qualifier : auto_inc
308 is_auto_inc => $item{'auto_inc'},
312 constraint : primary_key_constraint
313 | foreign_key_constraint
317 { $return = $item[1] }
319 { $return = $item[2] }
322 { $return = $item[1] }
324 { $return = $item[2] }
327 { $return = $item[1] }
329 { $return = $item[2] }
331 data_type : WORD field_size(?)
339 lock : /lock/i /datarows/i
343 field_size : '(' num_range ')' { $item{'num_range'} }
345 num_range : DIGITS ',' DIGITS
346 { $return = $item[1].','.$item[3] }
348 { $return = $item[1] }
351 nullable : /not/i /null/i
356 default_val : /default/i /null/i
358 | /default/i /'[^']*'/
359 { $item[2]=~ s/'//g; $return = $item[2] }
361 { $return = $item[2] }
363 auto_inc : /identity/i { 1 }
365 primary_key_constraint : /constraint/i index_name(?) /primary/i /key/i parens_field_list
368 supertype => 'constraint',
370 type => 'primary_key',
375 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(?)
378 supertype => 'constraint',
380 type => 'foreign_key',
382 reference_table => $item[7],
383 reference_fields => $item[8][0],
384 on_delete => $item[9][0],
385 on_update => $item[10][0],
389 unique_constraint : /constraint/i index_name(?) /unique/i parens_field_list
392 supertype => 'constraint',
399 unique_constraint : /unique/i clustered(?) INDEX(?) index_name(?) on_table(?) parens_field_list field_not_null(?)
402 supertype => 'constraint',
404 clustered => $item[2][0],
406 table => $item[5][0],
411 on_delete : /on delete/i reference_option
414 on_update : /on update/i reference_option
417 reference_option: /cascade/i
422 clustered : /clustered/i
429 on_table : /on/i table_name
430 { $return = $item[2] }
432 on_system : /on/i /system/i
435 index : clustered(?) INDEX index_name(?) on_table(?) parens_field_list END_STATEMENT
438 supertype => 'index',
440 clustered => $item[1][0],
442 table => $item[4][0],
447 parens_field_list : '(' field_name(s /,/) ')'
450 ident : QUOTE WORD '.' WORD QUOTE | LQUOTE WORD '.' WORD RQUOTE
451 { $return = { owner => $item[2], name => $item[4] } }
452 | LQUOTE WORD RQUOTE '.' LQUOTE WORD RQUOTE
453 { $return = { owner => $item[2], name => $item[6] } }
455 { $return = { name => $item[2] } }
457 { $return = { owner => $item[1], name => $item[3] } }
459 { $return = { name => $item[1] } }
466 NAME : QUOTE(?) /\w+/ QUOTE(?)
484 my ( $translator, $data ) = @_;
485 my $parser = Parse::RecDescent->new($GRAMMAR);
487 local $::RD_TRACE = $translator->trace ? 1 : undef;
488 local $DEBUG = $translator->debug;
490 unless (defined $parser) {
491 return $translator->error("Error instantiating Parse::RecDescent ".
492 "instance: Bad grammer");
495 my $result = $parser->startrule($data);
496 return $translator->error( "Parse failed." ) unless defined $result;
497 warn Dumper( $result ) if $DEBUG;
499 my $schema = $translator->schema;
501 $result->{tables}->{ $a }->{'order'} <=> $result->{tables}->{ $b }->{'order'}
502 } keys %{ $result->{tables} };
504 for my $table_name ( @tables ) {
505 my $tdata = $result->{tables}->{ $table_name };
506 my $table = $schema->add_table( name => $tdata->{'name'} )
507 or die "Can't create table '$table_name': ", $schema->error;
509 $table->comments( $tdata->{'comments'} );
512 $tdata->{'fields'}->{$a}->{'order'}
514 $tdata->{'fields'}->{$b}->{'order'}
515 } keys %{ $tdata->{'fields'} };
517 for my $fname ( @fields ) {
518 my $fdata = $tdata->{'fields'}{ $fname };
519 my $field = $table->add_field(
520 name => $fdata->{'name'},
521 data_type => $fdata->{'data_type'},
522 size => $fdata->{'size'},
523 default_value => $fdata->{'default'},
524 is_auto_increment => $fdata->{'is_auto_inc'},
525 is_nullable => $fdata->{'nullable'},
526 comments => $fdata->{'comments'},
527 ) or die $table->error;
529 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
531 for my $qual ( qw[ binary unsigned zerofill list ] ) {
532 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
533 next if ref $val eq 'ARRAY' && !@$val;
534 $field->extra( $qual, $val );
538 if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
539 my %extra = $field->extra;
541 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
542 $longest = $len if $len > $longest;
544 $field->size( $longest ) if $longest;
547 for my $cdata ( @{ $fdata->{'constraints'} } ) {
548 next unless $cdata->{'type'} eq 'foreign_key';
549 $cdata->{'fields'} ||= [ $field->name ];
550 push @{ $tdata->{'constraints'} }, $cdata;
554 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
555 my $index = $table->add_index(
556 name => $idata->{'name'},
557 type => uc $idata->{'type'},
558 fields => $idata->{'fields'},
559 ) or die $table->error;
562 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
563 my $constraint = $table->add_constraint(
564 name => $cdata->{'name'},
565 type => $cdata->{'type'},
566 fields => $cdata->{'fields'},
567 reference_table => $cdata->{'reference_table'},
568 reference_fields => $cdata->{'reference_fields'},
569 match_type => $cdata->{'match_type'} || '',
570 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
571 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
572 ) or die $table->error;
576 my @procedures = sort {
577 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
578 } keys %{ $result->{procedures} };
579 for my $proc_name (@procedures) {
580 $schema->add_procedure(
582 owner => $result->{procedures}->{$proc_name}->{owner},
583 sql => $result->{procedures}->{$proc_name}->{sql},
588 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
589 } keys %{ $result->{views} };
590 for my $view_name (keys %{ $result->{views} }) {
593 sql => $result->{views}->{$view_name}->{sql},
602 # -------------------------------------------------------------------
603 # Every hero becomes a bore at last.
604 # Ralph Waldo Emerson
605 # -------------------------------------------------------------------
611 Chris Hilton E<lt>chris@dctank.comE<gt> - Bulk of code from
612 Sybase parser, I just tweaked it for SQLServer. Thanks.
616 SQL::Translator, SQL::Translator::Parser::DBI, L<http://www.midsomer.org/>.