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