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