start of hardcore refactoring
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / SQLServer.pm
CommitLineData
7a0ceaa1 1package SQL::Translator::Producer::SQLServer;
2
7a0ceaa1 3=head1 NAME
4
5SQL::Translator::Producer::SQLServer - MS SQLServer producer for SQL::Translator
6
7=head1 SYNOPSIS
8
9 use SQL::Translator;
10
11 my $t = SQL::Translator->new( parser => '...', producer => 'SQLServer' );
12 $t->translate;
13
14=head1 DESCRIPTION
15
16B<WARNING>B This is still fairly early code, basically a hacked version of the
17Sybase Producer (thanks Sam, Paul and Ken for doing the real work ;-)
18
19=head1 Extra Attributes
20
21=over 4
22
23=item field.list
24
25List of values for an enum field.
26
27=back
28
29=head1 TODO
30
31 * !! Write some tests !!
32 * Reserved words list needs updating to SQLServer.
e2fb9ad3 33 * Triggers, Procedures and Views DO NOT WORK
7a0ceaa1 34
35=cut
36
37use strict;
f27f9229 38use warnings;
0c04c5a2 39our ( $DEBUG, $WARN );
40our $VERSION = '1.59';
7a0ceaa1 41$DEBUG = 1 unless defined $DEBUG;
42
43use Data::Dumper;
44use SQL::Translator::Schema::Constants;
45use SQL::Translator::Utils qw(debug header_comment);
fd9f0e09 46use SQL::Translator::Generator::Utils;
0a6e5a56 47
fd9f0e09 48my $util = SQL::Translator::Generator::Utils->new( quote_chars => ['[', ']'] );
7a0ceaa1 49
50my %translate = (
51 date => 'datetime',
52 'time' => 'datetime',
53 # Sybase types
54 #integer => 'numeric',
55 #int => 'numeric',
56 #number => 'numeric',
57 #money => 'money',
58 #varchar => 'varchar',
59 #varchar2 => 'varchar',
60 #timestamp => 'datetime',
61 #text => 'varchar',
62 #real => 'double precision',
63 #comment => 'text',
64 #bit => 'bit',
65 #tinyint => 'smallint',
66 #float => 'double precision',
028386aa 67 #serial => 'numeric',
7a0ceaa1 68 #boolean => 'varchar',
69 #char => 'char',
70 #long => 'varchar',
71);
72
7a0ceaa1 73# If these datatypes have size appended the sql fails.
3e0bcbfd 74my @no_size = qw/tinyint smallint int integer bigint text bit image datetime/;
7a0ceaa1 75
3e0bcbfd 76my $max_id_length = 128;
7a0ceaa1 77my %global_names;
7a0ceaa1 78
79=pod
80
81=head1 SQLServer Create Table Syntax
82
83TODO
84
85=cut
86
7a0ceaa1 87sub produce {
88 my $translator = shift;
89 $DEBUG = $translator->debug;
90 $WARN = $translator->show_warnings;
91 my $no_comments = $translator->no_comments;
92 my $add_drop_table = $translator->add_drop_table;
93 my $schema = $translator->schema;
94
e2fb9ad3 95 %global_names = (); #reset
e2fb9ad3 96
7a0ceaa1 97 my $output;
98 $output .= header_comment."\n" unless ($no_comments);
99
d02c3cd2 100 # Generate the DROP statements.
7a0ceaa1 101 if ($add_drop_table) {
d02c3cd2 102 my @tables = sort { $b->order <=> $a->order } $schema->get_tables;
103 $output .= "--\n-- Turn off constraints\n--\n\n" unless $no_comments;
104 foreach my $table (@tables) {
105 my $name = $table->name;
106 my $q_name = unreserve($name);
107 $output .= "IF EXISTS (SELECT name FROM sysobjects WHERE name = '$name' AND type = 'U') ALTER TABLE $q_name NOCHECK CONSTRAINT all;\n"
108 }
109 $output .= "\n";
7a0ceaa1 110 $output .= "--\n-- Drop tables\n--\n\n" unless $no_comments;
d02c3cd2 111 foreach my $table (@tables) {
0a6e5a56 112 my $name = $table->name;
113 my $q_name = unreserve($name);
d02c3cd2 114 $output .= "IF EXISTS (SELECT name FROM sysobjects WHERE name = '$name' AND type = 'U') DROP TABLE $q_name;\n"
7a0ceaa1 115 }
116 }
117
118 # Generate the CREATE sql
f9a5ee79 119
120 my @foreign_constraints = (); # these need to be added separately, as tables may not exist yet
121
7a0ceaa1 122 for my $table ( $schema->get_tables ) {
123 my $table_name = $table->name or next;
7a0ceaa1 124 my $table_name_ur = unreserve($table_name) || '';
125
126 my ( @comments, @field_defs, @index_defs, @constraint_defs );
127
128 push @comments, "\n\n--\n-- Table: $table_name_ur\n--"
129 unless $no_comments;
130
131 push @comments, map { "-- $_" } $table->comments;
132
133 #
134 # Fields
135 #
136 my %field_name_scope;
137 for my $field ( $table->get_fields ) {
e2fb9ad3 138 my $field_name = $field->name;
0a6e5a56 139 my $field_name_ur = unreserve( $field_name );
7a0ceaa1 140 my $field_def = qq["$field_name_ur"];
141 $field_def =~ s/\"//g;
142 if ( $field_def =~ /identity/ ){
143 $field_def =~ s/identity/pidentity/;
144 }
145
146 #
147 # Datatype
148 #
149 my $data_type = lc $field->data_type;
150 my $orig_data_type = $data_type;
151 my %extra = $field->extra;
152 my $list = $extra{'list'} || [];
153 # \todo deal with embedded quotes
154 my $commalist = join( ', ', map { qq['$_'] } @$list );
7a0ceaa1 155
156 if ( $data_type eq 'enum' ) {
e2fb9ad3 157 my $check_name = mk_name( $field_name . '_chk' );
7a0ceaa1 158 push @constraint_defs,
e2fb9ad3 159 "CONSTRAINT $check_name CHECK ($field_name IN ($commalist))";
7a0ceaa1 160 $data_type .= 'character varying';
161 }
162 elsif ( $data_type eq 'set' ) {
163 $data_type .= 'character varying';
164 }
f9a5ee79 165 elsif ( grep { $data_type eq $_ } qw/bytea blob clob/ ) {
166 $data_type = 'varbinary';
167 }
7a0ceaa1 168 else {
169 if ( defined $translate{ $data_type } ) {
170 $data_type = $translate{ $data_type };
171 }
172 else {
173 warn "Unknown datatype: $data_type ",
174 "($table_name.$field_name)\n" if $WARN;
175 }
176 }
177
178 my $size = $field->size;
179 if ( grep $_ eq $data_type, @no_size) {
180 # SQLServer doesn't seem to like sizes on some datatypes
181 $size = undef;
182 }
183 elsif ( !$size ) {
184 if ( $data_type =~ /numeric/ ) {
185 $size = '9,0';
186 }
187 elsif ( $orig_data_type eq 'text' ) {
188 #interpret text fields as long varchars
189 $size = '255';
190 }
191 elsif (
192 $data_type eq 'varchar' &&
193 $orig_data_type eq 'boolean'
194 ) {
195 $size = '6';
196 }
197 elsif ( $data_type eq 'varchar' ) {
198 $size = '255';
199 }
200 }
201
202 $field_def .= " $data_type";
203 $field_def .= "($size)" if $size;
204
205 $field_def .= ' IDENTITY' if $field->is_auto_increment;
206
207 #
1426be03 208 # Not null constraint
209 #
210 unless ( $field->is_nullable ) {
211 $field_def .= ' NOT NULL';
212 }
213 else {
214 $field_def .= ' NULL' if $data_type ne 'bit';
215 }
1426be03 216
217 #
7a0ceaa1 218 # Default value
219 #
06baeb21 220 SQL::Translator::Producer->_apply_default_value(
221 $field,
222 \$field_def,
223 [
224 'NULL' => \'NULL',
225 ],
226 );
bc8e2aa1 227
028386aa 228 push @field_defs, $field_def;
7a0ceaa1 229 }
230
231 #
232 # Constraint Declarations
233 #
234 my @constraint_decs = ();
7a0ceaa1 235 for my $constraint ( $table->get_constraints ) {
236 my $name = $constraint->name || '';
0a6e5a56 237 my $name_ur = unreserve($name);
7a0ceaa1 238 # Make sure we get a unique name
7a0ceaa1 239 my $type = $constraint->type || NORMAL;
0a6e5a56 240 my @fields = map { unreserve( $_ ) }
7a0ceaa1 241 $constraint->fields;
0a6e5a56 242 my @rfields = map { unreserve( $_ ) }
7a0ceaa1 243 $constraint->reference_fields;
244 next unless @fields;
245
5bac76bc 246 my $c_def;
f9a5ee79 247 if ( $type eq FOREIGN_KEY ) {
e2fb9ad3 248 $name ||= mk_name( $table_name . '_fk' );
5bac76bc 249 my $on_delete = uc ($constraint->on_delete || '');
250 my $on_update = uc ($constraint->on_update || '');
251
252 # The default implicit constraint action in MSSQL is RESTRICT
253 # but you can not specify it explicitly. Go figure :)
254 for ($on_delete, $on_update) {
255 undef $_ if $_ eq 'RESTRICT'
256 }
257
028386aa 258 $c_def =
0a6e5a56 259 "ALTER TABLE $table_name_ur ADD CONSTRAINT $name_ur FOREIGN KEY".
7a0ceaa1 260 ' (' . join( ', ', @fields ) . ') REFERENCES '.
0a6e5a56 261 unreserve($constraint->reference_table).
f9a5ee79 262 ' (' . join( ', ', @rfields ) . ')'
263 ;
264
5bac76bc 265 if ( $on_delete && $on_delete ne "NO ACTION") {
266 $c_def .= " ON DELETE $on_delete";
267 }
268 if ( $on_update && $on_update ne "NO ACTION") {
269 $c_def .= " ON UPDATE $on_update";
270 }
f9a5ee79 271
272 $c_def .= ";";
273
274 push @foreign_constraints, $c_def;
275 next;
276 }
277
278
279 if ( $type eq PRIMARY_KEY ) {
028386aa 280 $name = ($name ? unreserve($name) : mk_name( $table_name . '_pk' ));
281 $c_def =
f9a5ee79 282 "CONSTRAINT $name PRIMARY KEY ".
283 '(' . join( ', ', @fields ) . ')';
7a0ceaa1 284 }
285 elsif ( $type eq UNIQUE ) {
0a6e5a56 286 $name = $name_ur || mk_name( $table_name . '_uc' );
66444b41 287 my @nullable = grep { $_->is_nullable } $constraint->fields;
288 if (!@nullable) {
289 $c_def =
290 "CONSTRAINT $name UNIQUE " .
291 '(' . join( ', ', @fields ) . ')';
292 } else {
293 push @index_defs,
294 "CREATE UNIQUE NONCLUSTERED INDEX $name_ur ON $table_name_ur (" .
295 join( ', ', @fields ) . ')' .
296 ' WHERE ' . join( ' AND ', map unreserve($_->name) . ' IS NOT NULL', @nullable ) . ';';
297 next;
298 }
7a0ceaa1 299 }
04a180d6 300 push @constraint_defs, $c_def;
7a0ceaa1 301 }
302
303 #
304 # Indices
305 #
306 for my $index ( $table->get_indices ) {
e2fb9ad3 307 my $idx_name = $index->name || mk_name($table_name . '_idx');
0a6e5a56 308 my $idx_name_ur = unreserve($idx_name);
7a0ceaa1 309 push @index_defs,
0a6e5a56 310 "CREATE INDEX $idx_name_ur ON $table_name_ur (".
311 join( ', ', map unreserve($_), $index->fields ) . ");";
7a0ceaa1 312 }
313
314 my $create_statement = "";
315 $create_statement .= qq[CREATE TABLE $table_name_ur (\n].
028386aa 316 join( ",\n",
7a0ceaa1 317 map { " $_" } @field_defs, @constraint_defs
318 ).
319 "\n);"
320 ;
321
322 $output .= join( "\n\n",
323 @comments,
324 $create_statement,
325 @index_defs,
7a0ceaa1 326 );
327 }
328
f9a5ee79 329# Add FK constraints
330 $output .= join ("\n", '', @foreign_constraints) if @foreign_constraints;
331
e2fb9ad3 332# create view/procedure are NOT prepended to the input $sql, needs
333# to be filled in with the proper syntax
334
6fac033a 335=pod
e2fb9ad3 336
7a0ceaa1 337 # Text of view is already a 'create view' statement so no need to
338 # be fancy
339 foreach ( $schema->get_views ) {
340 my $name = $_->name();
341 $output .= "\n\n";
5c5997ef 342 $output .= "--\n-- View: $name\n--\n\n" unless $no_comments;
3e0bcbfd 343 my $text = $_->sql();
e2fb9ad3 344 $text =~ s/\r//g;
5bb0a4ee 345 $output .= "$text\nGO\n";
7a0ceaa1 346 }
347
348 # Text of procedure already has the 'create procedure' stuff
349 # so there is no need to do anything fancy. However, we should
350 # think about doing fancy stuff with granting permissions and
351 # so on.
352 foreach ( $schema->get_procedures ) {
353 my $name = $_->name();
354 $output .= "\n\n";
5c5997ef 355 $output .= "--\n-- Procedure: $name\n--\n\n" unless $no_comments;
3e0bcbfd 356 my $text = $_->sql();
028386aa 357 $text =~ s/\r//g;
5bb0a4ee 358 $output .= "$text\nGO\n";
7a0ceaa1 359 }
e2fb9ad3 360=cut
7a0ceaa1 361
362 return $output;
363}
364
7a0ceaa1 365sub mk_name {
e2fb9ad3 366 my ($name, $scope, $critical) = @_;
7a0ceaa1 367
368 $scope ||= \%global_names;
369 if ( my $prev = $scope->{ $name } ) {
370 my $name_orig = $name;
371 $name .= sprintf( "%02d", ++$prev );
028386aa 372 substr($name, $max_id_length - 3) = "00"
7a0ceaa1 373 if length( $name ) > $max_id_length;
374
375 warn "The name '$name_orig' has been changed to ",
376 "'$name' to make it unique.\n" if $WARN;
377
378 $scope->{ $name_orig }++;
379 }
028386aa 380 $name = substr( $name, 0, $max_id_length )
7a0ceaa1 381 if ((length( $name ) > $max_id_length) && $critical);
382 $scope->{ $name }++;
0a6e5a56 383 return unreserve($name);
7a0ceaa1 384}
385
f3fccb75 386sub unreserve { $util->quote($_[0]) }
7a0ceaa1 387
3881;
389
7a0ceaa1 390=pod
391
392=head1 SEE ALSO
393
394SQL::Translator.
395
396=head1 AUTHORS
397
398Mark Addison E<lt>grommit@users.sourceforge.netE<gt> - Bulk of code from
399Sybase producer, I just tweaked it for SQLServer. Thanks.
400
401=cut