Commit | Line | Data |
75d07914 |
1 | package DBIx::Class::Storage::DBI::MSSQL; |
3885cff6 |
2 | |
75d07914 |
3 | use strict; |
4 | use warnings; |
3885cff6 |
5 | |
48fe9087 |
6 | use base qw/DBIx::Class::Storage::DBI::AmbiguousGlob DBIx::Class::Storage::DBI/; |
2ad62d97 |
7 | use mro 'c3'; |
3885cff6 |
8 | |
5a77aa8b |
9 | use List::Util(); |
10 | |
7b1b2582 |
11 | __PACKAGE__->mk_group_accessors(simple => qw/ |
12 | _identity _identity_method |
13 | /); |
14 | |
ac93965c |
15 | __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks::MSSQL'); |
16 | |
afcfff01 |
17 | sub _set_identity_insert { |
18 | my ($self, $table) = @_; |
64690266 |
19 | |
20 | my $sql = sprintf ( |
afcfff01 |
21 | 'SET IDENTITY_INSERT %s ON', |
64690266 |
22 | $self->sql_maker->_quote ($table), |
afcfff01 |
23 | ); |
64690266 |
24 | |
25 | my $dbh = $self->_get_dbh; |
26 | eval { $dbh->do ($sql) }; |
27 | if ($@) { |
28 | $self->throw_exception (sprintf "Error executing '%s': %s", |
29 | $sql, |
30 | $dbh->errstr, |
31 | ); |
32 | } |
afcfff01 |
33 | } |
34 | |
aac1a358 |
35 | sub _unset_identity_insert { |
36 | my ($self, $table) = @_; |
37 | |
38 | my $sql = sprintf ( |
39 | 'SET IDENTITY_INSERT %s OFF', |
40 | $self->sql_maker->_quote ($table), |
41 | ); |
42 | |
43 | my $dbh = $self->_get_dbh; |
44 | $dbh->do ($sql); |
45 | } |
46 | |
5a77aa8b |
47 | sub insert_bulk { |
48 | my $self = shift; |
49 | my ($source, $cols, $data) = @_; |
50 | |
aac1a358 |
51 | my $is_identity_insert = (List::Util::first |
afcfff01 |
52 | { $source->column_info ($_)->{is_auto_increment} } |
53 | (@{$cols}) |
aac1a358 |
54 | ) |
55 | ? 1 |
56 | : 0; |
57 | |
58 | if ($is_identity_insert) { |
59 | $self->_set_identity_insert ($source->name); |
5a77aa8b |
60 | } |
61 | |
62 | $self->next::method(@_); |
aac1a358 |
63 | |
64 | if ($is_identity_insert) { |
65 | $self->_unset_identity_insert ($source->name); |
66 | } |
5a77aa8b |
67 | } |
68 | |
57ee81d0 |
69 | # support MSSQL GUID column types |
70 | |
ca791b95 |
71 | sub insert { |
72 | my $self = shift; |
73 | my ($source, $to_insert) = @_; |
74 | |
afcfff01 |
75 | my $supplied_col_info = $self->_resolve_column_info($source, [keys %$to_insert] ); |
ca791b95 |
76 | |
77 | my %guid_cols; |
78 | my @pk_cols = $source->primary_columns; |
79 | my %pk_cols; |
80 | @pk_cols{@pk_cols} = (); |
81 | |
82 | my @pk_guids = grep { |
be294d66 |
83 | $source->column_info($_)->{data_type} |
84 | && |
ca791b95 |
85 | $source->column_info($_)->{data_type} =~ /^uniqueidentifier/i |
86 | } @pk_cols; |
87 | |
88 | my @auto_guids = grep { |
be294d66 |
89 | $source->column_info($_)->{data_type} |
90 | && |
ca791b95 |
91 | $source->column_info($_)->{data_type} =~ /^uniqueidentifier/i |
92 | && |
93 | $source->column_info($_)->{auto_nextval} |
94 | } grep { not exists $pk_cols{$_} } $source->columns; |
95 | |
96 | my @get_guids_for = |
97 | grep { not exists $to_insert->{$_} } (@pk_guids, @auto_guids); |
98 | |
afcfff01 |
99 | my $updated_cols = {}; |
100 | |
ca791b95 |
101 | for my $guid_col (@get_guids_for) { |
9ae966b9 |
102 | my ($new_guid) = $self->_get_dbh->selectrow_array('SELECT NEWID()'); |
ca791b95 |
103 | $updated_cols->{$guid_col} = $to_insert->{$guid_col} = $new_guid; |
104 | } |
105 | |
aac1a358 |
106 | my $is_identity_insert = (List::Util::first { $_->{is_auto_increment} } (values %$supplied_col_info) ) |
107 | ? 1 |
108 | : 0; |
109 | |
110 | if ($is_identity_insert) { |
111 | $self->_set_identity_insert ($source->name); |
afcfff01 |
112 | } |
113 | |
ca791b95 |
114 | $updated_cols = { %$updated_cols, %{ $self->next::method(@_) } }; |
115 | |
aac1a358 |
116 | if ($is_identity_insert) { |
117 | $self->_unset_identity_insert ($source->name); |
118 | } |
119 | |
120 | |
ca791b95 |
121 | return $updated_cols; |
122 | } |
123 | |
5a77aa8b |
124 | sub _prep_for_execute { |
125 | my $self = shift; |
126 | my ($op, $extra_bind, $ident, $args) = @_; |
127 | |
128 | # cast MONEY values properly |
129 | if ($op eq 'insert' || $op eq 'update') { |
130 | my $fields = $args->[0]; |
5a77aa8b |
131 | |
132 | for my $col (keys %$fields) { |
1537084d |
133 | # $ident is a result source object with INSERT/UPDATE ops |
be294d66 |
134 | if ($ident->column_info ($col)->{data_type} |
135 | && |
136 | $ident->column_info ($col)->{data_type} =~ /^money\z/i) { |
5a77aa8b |
137 | my $val = $fields->{$col}; |
138 | $fields->{$col} = \['CAST(? AS MONEY)', [ $col => $val ]]; |
139 | } |
140 | } |
141 | } |
142 | |
143 | my ($sql, $bind) = $self->next::method (@_); |
144 | |
145 | if ($op eq 'insert') { |
146 | $sql .= ';SELECT SCOPE_IDENTITY()'; |
147 | |
5a77aa8b |
148 | } |
149 | |
150 | return ($sql, $bind); |
151 | } |
152 | |
153 | sub _execute { |
154 | my $self = shift; |
155 | my ($op) = @_; |
156 | |
157 | my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_); |
1537084d |
158 | |
5a77aa8b |
159 | if ($op eq 'insert') { |
5a77aa8b |
160 | |
1537084d |
161 | # this should bring back the result of SELECT SCOPE_IDENTITY() we tacked |
162 | # on in _prep_for_execute above |
163 | my ($identity) = $sth->fetchrow_array; |
ed8de058 |
164 | |
1537084d |
165 | # SCOPE_IDENTITY failed, but we can do something else |
166 | if ( (! $identity) && $self->_identity_method) { |
167 | ($identity) = $self->_dbh->selectrow_array( |
168 | 'select ' . $self->_identity_method |
169 | ); |
170 | } |
7b1b2582 |
171 | |
1537084d |
172 | $self->_identity($identity); |
173 | $sth->finish; |
7b1b2582 |
174 | } |
175 | |
1537084d |
176 | return wantarray ? ($rv, $sth, @bind) : $rv; |
7b1b2582 |
177 | } |
5a77aa8b |
178 | |
7b1b2582 |
179 | sub last_insert_id { shift->_identity } |
5a77aa8b |
180 | |
4c0f4206 |
181 | # savepoint syntax is the same as in Sybase ASE |
182 | |
183 | sub _svp_begin { |
184 | my ($self, $name) = @_; |
185 | |
9ae966b9 |
186 | $self->_get_dbh->do("SAVE TRANSACTION $name"); |
4c0f4206 |
187 | } |
188 | |
189 | # A new SAVE TRANSACTION with the same name releases the previous one. |
190 | sub _svp_release { 1 } |
191 | |
192 | sub _svp_rollback { |
193 | my ($self, $name) = @_; |
194 | |
9ae966b9 |
195 | $self->_get_dbh->do("ROLLBACK TRANSACTION $name"); |
4c0f4206 |
196 | } |
197 | |
ed8de058 |
198 | sub build_datetime_parser { |
199 | my $self = shift; |
200 | my $type = "DateTime::Format::Strptime"; |
201 | eval "use ${type}"; |
202 | $self->throw_exception("Couldn't load ${type}: $@") if $@; |
eb0323df |
203 | return $type->new( pattern => '%Y-%m-%d %H:%M:%S' ); # %F %T |
204 | } |
205 | |
206 | sub sqlt_type { 'SQLServer' } |
207 | |
208 | sub _sql_maker_opts { |
5a77aa8b |
209 | my ( $self, $opts ) = @_; |
eb0323df |
210 | |
5a77aa8b |
211 | if ( $opts ) { |
212 | $self->{_sql_maker_opts} = { %$opts }; |
213 | } |
eb0323df |
214 | |
5a77aa8b |
215 | return { limit_dialect => 'Top', %{$self->{_sql_maker_opts}||{}} }; |
ed8de058 |
216 | } |
3885cff6 |
217 | |
75d07914 |
218 | 1; |
3885cff6 |
219 | |
75d07914 |
220 | =head1 NAME |
3885cff6 |
221 | |
5a77aa8b |
222 | DBIx::Class::Storage::DBI::MSSQL - Base Class for Microsoft SQL Server support |
223 | in DBIx::Class |
3885cff6 |
224 | |
75d07914 |
225 | =head1 SYNOPSIS |
3885cff6 |
226 | |
5a77aa8b |
227 | This is the base class for Microsoft SQL Server support, used by |
228 | L<DBIx::Class::Storage::DBI::ODBC::Microsoft_SQL_Server> and |
229 | L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>. |
eb0323df |
230 | |
5a77aa8b |
231 | =head1 IMPLEMENTATION NOTES |
eb0323df |
232 | |
fd05d10a |
233 | =head2 IDENTITY information |
234 | |
5a77aa8b |
235 | Microsoft SQL Server supports three methods of retrieving the IDENTITY |
236 | value for inserted row: IDENT_CURRENT, @@IDENTITY, and SCOPE_IDENTITY(). |
237 | SCOPE_IDENTITY is used here because it is the safest. However, it must |
238 | be called is the same execute statement, not just the same connection. |
eb0323df |
239 | |
5a77aa8b |
240 | So, this implementation appends a SELECT SCOPE_IDENTITY() statement |
241 | onto each INSERT to accommodate that requirement. |
eb0323df |
242 | |
7b1b2582 |
243 | C<SELECT @@IDENTITY> can also be used by issuing: |
244 | |
245 | $self->_identity_method('@@identity'); |
246 | |
08cdc412 |
247 | it will only be used if SCOPE_IDENTITY() fails. |
248 | |
249 | This is more dangerous, as inserting into a table with an on insert trigger that |
250 | inserts into another table with an identity will give erroneous results on |
251 | recent versions of SQL Server. |
7b1b2582 |
252 | |
c84189e1 |
253 | =head2 identity insert |
fd05d10a |
254 | |
255 | Be aware that we have tried to make things as simple as possible for our users. |
c84189e1 |
256 | For MSSQL that means that when a user tries to create a row, while supplying an |
257 | explicit value for an autoincrementing column, we will try to issue the |
258 | appropriate database call to make this possible, namely C<SET IDENTITY_INSERT |
259 | $table_name ON>. Unfortunately this operation in MSSQL requires the |
260 | C<db_ddladmin> privilege, which is normally not included in the standard |
261 | write-permissions. |
fd05d10a |
262 | |
5a77aa8b |
263 | =head1 AUTHOR |
3885cff6 |
264 | |
5a77aa8b |
265 | See L<DBIx::Class/CONTRIBUTORS>. |
3885cff6 |
266 | |
75d07914 |
267 | =head1 LICENSE |
3885cff6 |
268 | |
75d07914 |
269 | You may distribute this code under the same terms as Perl itself. |
3885cff6 |
270 | |
75d07914 |
271 | =cut |