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