Commit | Line | Data |
75d07914 |
1 | package DBIx::Class::Storage::DBI::MSSQL; |
3885cff6 |
2 | |
75d07914 |
3 | use strict; |
4 | use warnings; |
3885cff6 |
5 | |
548d1627 |
6 | use base qw/DBIx::Class::Storage::DBI::UniqueIdentifier/; |
2ad62d97 |
7 | use mro 'c3'; |
ed7ab0f4 |
8 | use Try::Tiny; |
6298a324 |
9 | use List::Util 'first'; |
fd323bf1 |
10 | use namespace::clean; |
3885cff6 |
11 | |
7b1b2582 |
12 | __PACKAGE__->mk_group_accessors(simple => qw/ |
384b8bce |
13 | _identity _identity_method _pre_insert_sql _post_insert_sql |
7b1b2582 |
14 | /); |
15 | |
d5dedbd6 |
16 | __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker::MSSQL'); |
ac93965c |
17 | |
2b8cc2f2 |
18 | __PACKAGE__->sql_quote_char([qw/[ ]/]); |
19 | |
40d8d018 |
20 | __PACKAGE__->new_guid('NEWID()'); |
21 | |
afcfff01 |
22 | sub _set_identity_insert { |
23 | my ($self, $table) = @_; |
64690266 |
24 | |
384b8bce |
25 | my $stmt = 'SET IDENTITY_INSERT %s %s'; |
26 | $table = $self->sql_maker->_quote($table); |
aac1a358 |
27 | |
384b8bce |
28 | $self->_pre_insert_sql (sprintf $stmt, $table, 'ON'); |
29 | $self->_post_insert_sql(sprintf $stmt, $table, 'OFF'); |
aac1a358 |
30 | } |
31 | |
5a77aa8b |
32 | sub insert_bulk { |
33 | my $self = shift; |
34 | my ($source, $cols, $data) = @_; |
35 | |
6298a324 |
36 | my $is_identity_insert = |
52416317 |
37 | (first { $_->{is_auto_increment} } values %{ $source->columns_info($cols) } ) |
38 | ? 1 |
39 | : 0 |
40 | ; |
5a77aa8b |
41 | |
aac1a358 |
42 | if ($is_identity_insert) { |
43 | $self->_set_identity_insert ($source->name); |
5a77aa8b |
44 | } |
45 | |
46 | $self->next::method(@_); |
5a77aa8b |
47 | } |
48 | |
ca791b95 |
49 | sub insert { |
50 | my $self = shift; |
51 | my ($source, $to_insert) = @_; |
52 | |
afcfff01 |
53 | my $supplied_col_info = $self->_resolve_column_info($source, [keys %$to_insert] ); |
ca791b95 |
54 | |
6298a324 |
55 | my $is_identity_insert = |
56 | (first { $_->{is_auto_increment} } values %$supplied_col_info) ? 1 : 0; |
aac1a358 |
57 | |
58 | if ($is_identity_insert) { |
59 | $self->_set_identity_insert ($source->name); |
afcfff01 |
60 | } |
61 | |
548d1627 |
62 | my $updated_cols = $self->next::method(@_); |
ca791b95 |
63 | |
64 | return $updated_cols; |
65 | } |
66 | |
5a77aa8b |
67 | sub _prep_for_execute { |
68 | my $self = shift; |
69 | my ($op, $extra_bind, $ident, $args) = @_; |
70 | |
71 | # cast MONEY values properly |
72 | if ($op eq 'insert' || $op eq 'update') { |
73 | my $fields = $args->[0]; |
5a77aa8b |
74 | |
52416317 |
75 | my $colinfo = $ident->columns_info([keys %$fields]); |
76 | |
5a77aa8b |
77 | for my $col (keys %$fields) { |
1537084d |
78 | # $ident is a result source object with INSERT/UPDATE ops |
52416317 |
79 | if ( |
80 | $colinfo->{$col}{data_type} |
81 | && |
82 | $colinfo->{$col}{data_type} =~ /^money\z/i |
83 | ) { |
5a77aa8b |
84 | my $val = $fields->{$col}; |
85 | $fields->{$col} = \['CAST(? AS MONEY)', [ $col => $val ]]; |
86 | } |
87 | } |
88 | } |
89 | |
90 | my ($sql, $bind) = $self->next::method (@_); |
91 | |
92 | if ($op eq 'insert') { |
384b8bce |
93 | if (my $prepend = $self->_pre_insert_sql) { |
94 | $sql = "${prepend}\n${sql}"; |
95 | $self->_pre_insert_sql(undef); |
96 | } |
97 | if (my $append = $self->_post_insert_sql) { |
98 | $sql = "${sql}\n${append}"; |
99 | $self->_post_insert_sql(undef); |
100 | } |
101 | $sql .= "\nSELECT SCOPE_IDENTITY()"; |
5a77aa8b |
102 | } |
103 | |
104 | return ($sql, $bind); |
105 | } |
106 | |
107 | sub _execute { |
108 | my $self = shift; |
109 | my ($op) = @_; |
110 | |
111 | my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_); |
1537084d |
112 | |
5a77aa8b |
113 | if ($op eq 'insert') { |
5a77aa8b |
114 | |
1537084d |
115 | # this should bring back the result of SELECT SCOPE_IDENTITY() we tacked |
116 | # on in _prep_for_execute above |
9780718f |
117 | my ($identity) = try { $sth->fetchrow_array }; |
ed8de058 |
118 | |
1537084d |
119 | # SCOPE_IDENTITY failed, but we can do something else |
120 | if ( (! $identity) && $self->_identity_method) { |
121 | ($identity) = $self->_dbh->selectrow_array( |
122 | 'select ' . $self->_identity_method |
123 | ); |
124 | } |
7b1b2582 |
125 | |
1537084d |
126 | $self->_identity($identity); |
127 | $sth->finish; |
7b1b2582 |
128 | } |
129 | |
1537084d |
130 | return wantarray ? ($rv, $sth, @bind) : $rv; |
7b1b2582 |
131 | } |
5a77aa8b |
132 | |
7b1b2582 |
133 | sub last_insert_id { shift->_identity } |
5a77aa8b |
134 | |
f0bd60fc |
135 | # |
e74c68ce |
136 | # MSSQL is retarded wrt ordered subselects. One needs to add a TOP |
6a247f33 |
137 | # to *all* subqueries, but one also *can't* use TOP 100 PERCENT |
e74c68ce |
138 | # http://sqladvice.com/forums/permalink/18496/22931/ShowThread.aspx#22931 |
f0bd60fc |
139 | # |
140 | sub _select_args_to_query { |
141 | my $self = shift; |
142 | |
b8d88d9b |
143 | my ($sql, $prep_bind, @rest) = $self->next::method (@_); |
f0bd60fc |
144 | |
b8d88d9b |
145 | # see if this is an ordered subquery |
146 | my $attrs = $_[3]; |
aca481d8 |
147 | if ( |
148 | $sql !~ /^ \s* SELECT \s+ TOP \s+ \d+ \s+ /xi |
149 | && |
bac358c9 |
150 | scalar $self->_extract_order_criteria ($attrs->{order_by}) |
aca481d8 |
151 | ) { |
6de07ea3 |
152 | $self->throw_exception( |
d74f2da9 |
153 | 'An ordered subselect encountered - this is not safe! Please see "Ordered Subselects" in DBIx::Class::Storage::DBI::MSSQL |
69a8b315 |
154 | ') unless $attrs->{unsafe_subselect_ok}; |
e9657379 |
155 | my $max = $self->sql_maker->__max_int; |
e74c68ce |
156 | $sql =~ s/^ \s* SELECT \s/SELECT TOP $max /xi; |
f0bd60fc |
157 | } |
158 | |
f0bd60fc |
159 | return wantarray |
17555a0c |
160 | ? ($sql, $prep_bind, @rest) |
161 | : \[ "($sql)", @$prep_bind ] |
f0bd60fc |
162 | ; |
163 | } |
164 | |
165 | |
4c0f4206 |
166 | # savepoint syntax is the same as in Sybase ASE |
167 | |
168 | sub _svp_begin { |
169 | my ($self, $name) = @_; |
170 | |
9ae966b9 |
171 | $self->_get_dbh->do("SAVE TRANSACTION $name"); |
4c0f4206 |
172 | } |
173 | |
174 | # A new SAVE TRANSACTION with the same name releases the previous one. |
175 | sub _svp_release { 1 } |
176 | |
177 | sub _svp_rollback { |
178 | my ($self, $name) = @_; |
179 | |
9ae966b9 |
180 | $self->_get_dbh->do("ROLLBACK TRANSACTION $name"); |
4c0f4206 |
181 | } |
182 | |
fb95dc4d |
183 | sub datetime_parser_type { |
184 | 'DBIx::Class::Storage::DBI::MSSQL::DateTime::Format' |
fd323bf1 |
185 | } |
eb0323df |
186 | |
187 | sub sqlt_type { 'SQLServer' } |
188 | |
6a247f33 |
189 | sub sql_limit_dialect { |
50772633 |
190 | my $self = shift; |
eb0323df |
191 | |
6a247f33 |
192 | my $supports_rno = 0; |
ff153e24 |
193 | |
6a247f33 |
194 | if (exists $self->_server_info->{normalized_dbms_version}) { |
195 | $supports_rno = 1 if $self->_server_info->{normalized_dbms_version} >= 9; |
196 | } |
197 | else { |
198 | # User is connecting via DBD::Sybase and has no permission to run |
199 | # stored procedures like xp_msver, or version detection failed for some |
200 | # other reason. |
201 | # So, we use a query to check if RNO is implemented. |
202 | try { |
203 | $self->_get_dbh->selectrow_array('SELECT row_number() OVER (ORDER BY rand())'); |
204 | $supports_rno = 1; |
205 | }; |
50772633 |
206 | } |
e76e7b5c |
207 | |
6a247f33 |
208 | return $supports_rno ? 'RowNumberOver' : 'Top'; |
ed8de058 |
209 | } |
3885cff6 |
210 | |
ecdf1ac8 |
211 | sub _ping { |
212 | my $self = shift; |
213 | |
214 | my $dbh = $self->_dbh or return 0; |
215 | |
216 | local $dbh->{RaiseError} = 1; |
217 | local $dbh->{PrintError} = 0; |
218 | |
52b420dd |
219 | return try { |
ecdf1ac8 |
220 | $dbh->do('select 1'); |
52b420dd |
221 | 1; |
ed7ab0f4 |
222 | } catch { |
52b420dd |
223 | 0; |
ecdf1ac8 |
224 | }; |
ecdf1ac8 |
225 | } |
226 | |
fb95dc4d |
227 | package # hide from PAUSE |
228 | DBIx::Class::Storage::DBI::MSSQL::DateTime::Format; |
229 | |
fd323bf1 |
230 | my $datetime_format = '%Y-%m-%d %H:%M:%S.%3N'; # %F %T |
fb95dc4d |
231 | my $smalldatetime_format = '%Y-%m-%d %H:%M:%S'; |
232 | |
233 | my ($datetime_parser, $smalldatetime_parser); |
234 | |
235 | sub parse_datetime { |
236 | shift; |
237 | require DateTime::Format::Strptime; |
238 | $datetime_parser ||= DateTime::Format::Strptime->new( |
239 | pattern => $datetime_format, |
240 | on_error => 'croak', |
241 | ); |
242 | return $datetime_parser->parse_datetime(shift); |
243 | } |
244 | |
245 | sub format_datetime { |
246 | shift; |
247 | require DateTime::Format::Strptime; |
248 | $datetime_parser ||= DateTime::Format::Strptime->new( |
249 | pattern => $datetime_format, |
250 | on_error => 'croak', |
251 | ); |
252 | return $datetime_parser->format_datetime(shift); |
253 | } |
254 | |
255 | sub parse_smalldatetime { |
256 | shift; |
257 | require DateTime::Format::Strptime; |
258 | $smalldatetime_parser ||= DateTime::Format::Strptime->new( |
259 | pattern => $smalldatetime_format, |
260 | on_error => 'croak', |
261 | ); |
262 | return $smalldatetime_parser->parse_datetime(shift); |
263 | } |
264 | |
265 | sub format_smalldatetime { |
266 | shift; |
267 | require DateTime::Format::Strptime; |
268 | $smalldatetime_parser ||= DateTime::Format::Strptime->new( |
269 | pattern => $smalldatetime_format, |
270 | on_error => 'croak', |
271 | ); |
272 | return $smalldatetime_parser->format_datetime(shift); |
273 | } |
274 | |
75d07914 |
275 | 1; |
3885cff6 |
276 | |
75d07914 |
277 | =head1 NAME |
3885cff6 |
278 | |
5a77aa8b |
279 | DBIx::Class::Storage::DBI::MSSQL - Base Class for Microsoft SQL Server support |
280 | in DBIx::Class |
3885cff6 |
281 | |
75d07914 |
282 | =head1 SYNOPSIS |
3885cff6 |
283 | |
5a77aa8b |
284 | This is the base class for Microsoft SQL Server support, used by |
285 | L<DBIx::Class::Storage::DBI::ODBC::Microsoft_SQL_Server> and |
286 | L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>. |
eb0323df |
287 | |
5a77aa8b |
288 | =head1 IMPLEMENTATION NOTES |
eb0323df |
289 | |
fd05d10a |
290 | =head2 IDENTITY information |
291 | |
5a77aa8b |
292 | Microsoft SQL Server supports three methods of retrieving the IDENTITY |
293 | value for inserted row: IDENT_CURRENT, @@IDENTITY, and SCOPE_IDENTITY(). |
294 | SCOPE_IDENTITY is used here because it is the safest. However, it must |
295 | be called is the same execute statement, not just the same connection. |
eb0323df |
296 | |
5a77aa8b |
297 | So, this implementation appends a SELECT SCOPE_IDENTITY() statement |
298 | onto each INSERT to accommodate that requirement. |
eb0323df |
299 | |
7b1b2582 |
300 | C<SELECT @@IDENTITY> can also be used by issuing: |
301 | |
302 | $self->_identity_method('@@identity'); |
303 | |
08cdc412 |
304 | it will only be used if SCOPE_IDENTITY() fails. |
305 | |
306 | This is more dangerous, as inserting into a table with an on insert trigger that |
307 | inserts into another table with an identity will give erroneous results on |
308 | recent versions of SQL Server. |
7b1b2582 |
309 | |
c84189e1 |
310 | =head2 identity insert |
fd05d10a |
311 | |
312 | Be aware that we have tried to make things as simple as possible for our users. |
c84189e1 |
313 | For MSSQL that means that when a user tries to create a row, while supplying an |
314 | explicit value for an autoincrementing column, we will try to issue the |
315 | appropriate database call to make this possible, namely C<SET IDENTITY_INSERT |
316 | $table_name ON>. Unfortunately this operation in MSSQL requires the |
317 | C<db_ddladmin> privilege, which is normally not included in the standard |
318 | write-permissions. |
fd05d10a |
319 | |
d74f2da9 |
320 | =head2 Ordered Subselects |
6de07ea3 |
321 | |
d74f2da9 |
322 | If you attempted the following query (among many others) in Microsoft SQL |
323 | Server |
6de07ea3 |
324 | |
6de07ea3 |
325 | $rs->search ({}, { |
6de07ea3 |
326 | prefetch => 'relation', |
327 | rows => 2, |
328 | offset => 3, |
329 | }); |
330 | |
d74f2da9 |
331 | You may be surprised to receive an exception. The reason for this is a quirk |
332 | in the MSSQL engine itself, and sadly doesn't have a sensible workaround due |
333 | to the way DBIC is built. DBIC can do truly wonderful things with the aid of |
334 | subselects, and does so automatically when necessary. The list of situations |
335 | when a subselect is necessary is long and still changes often, so it can not |
336 | be exhaustively enumerated here. The general rule of thumb is a joined |
337 | L<has_many|DBIx::Class::Relationship/has_many> relationship with limit/group |
338 | applied to the left part of the join. |
339 | |
340 | In its "pursuit of standards" Microsft SQL Server goes to great lengths to |
341 | forbid the use of ordered subselects. This breaks a very useful group of |
342 | searches like "Give me things number 4 to 6 (ordered by name), and prefetch |
343 | all their relations, no matter how many". While there is a hack which fools |
344 | the syntax checker, the optimizer may B<still elect to break the subselect>. |
345 | Testing has determined that while such breakage does occur (the test suite |
346 | contains an explicit test which demonstrates the problem), it is relative |
347 | rare. The benefits of ordered subselects are on the other hand too great to be |
348 | outright disabled for MSSQL. |
6de07ea3 |
349 | |
350 | Thus compromise between usability and perfection is the MSSQL-specific |
69a8b315 |
351 | L<resultset attribute|DBIx::Class::ResultSet/ATTRIBUTES> C<unsafe_subselect_ok>. |
6de07ea3 |
352 | It is deliberately not possible to set this on the Storage level, as the user |
48580715 |
353 | should inspect (and preferably regression-test) the return of every such |
d74f2da9 |
354 | ResultSet individually. The example above would work if written like: |
355 | |
356 | $rs->search ({}, { |
69a8b315 |
357 | unsafe_subselect_ok => 1, |
d74f2da9 |
358 | prefetch => 'relation', |
359 | rows => 2, |
360 | offset => 3, |
361 | }); |
6de07ea3 |
362 | |
363 | If it is possible to rewrite the search() in a way that will avoid the need |
364 | for this flag - you are urged to do so. If DBIC internals insist that an |
d74f2da9 |
365 | ordered subselect is necessary for an operation, and you believe there is a |
48580715 |
366 | different/better way to get the same result - please file a bugreport. |
6de07ea3 |
367 | |
5a77aa8b |
368 | =head1 AUTHOR |
3885cff6 |
369 | |
548d1627 |
370 | See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>. |
3885cff6 |
371 | |
75d07914 |
372 | =head1 LICENSE |
3885cff6 |
373 | |
75d07914 |
374 | You may distribute this code under the same terms as Perl itself. |
3885cff6 |
375 | |
75d07914 |
376 | =cut |