1 package DBIx::Class::Storage::DBI::MSSQL;
6 use base qw/DBIx::Class::Storage::DBI::AmbiguousGlob DBIx::Class::Storage::DBI/;
11 __PACKAGE__->mk_group_accessors(simple => qw/
12 _identity _identity_method
15 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks::MSSQL');
17 sub _set_identity_insert {
18 my ($self, $table) = @_;
21 'SET IDENTITY_INSERT %s ON',
22 $self->sql_maker->_quote ($table),
25 my $dbh = $self->_get_dbh;
26 eval { $dbh->do ($sql) };
28 $self->throw_exception (sprintf "Error executing '%s': %s",
35 sub _unset_identity_insert {
36 my ($self, $table) = @_;
39 'SET IDENTITY_INSERT %s OFF',
40 $self->sql_maker->_quote ($table),
43 my $dbh = $self->_get_dbh;
49 my ($source, $cols, $data) = @_;
51 my $is_identity_insert = (List::Util::first
52 { $source->column_info ($_)->{is_auto_increment} }
58 if ($is_identity_insert) {
59 $self->_set_identity_insert ($source->name);
62 $self->next::method(@_);
64 if ($is_identity_insert) {
65 $self->_unset_identity_insert ($source->name);
69 # support MSSQL GUID column types
73 my ($source, $to_insert) = @_;
75 my $supplied_col_info = $self->_resolve_column_info($source, [keys %$to_insert] );
78 my @pk_cols = $source->primary_columns;
80 @pk_cols{@pk_cols} = ();
83 $source->column_info($_)->{data_type}
85 $source->column_info($_)->{data_type} =~ /^uniqueidentifier/i
88 my @auto_guids = grep {
89 $source->column_info($_)->{data_type}
91 $source->column_info($_)->{data_type} =~ /^uniqueidentifier/i
93 $source->column_info($_)->{auto_nextval}
94 } grep { not exists $pk_cols{$_} } $source->columns;
97 grep { not exists $to_insert->{$_} } (@pk_guids, @auto_guids);
99 my $updated_cols = {};
101 for my $guid_col (@get_guids_for) {
102 my ($new_guid) = $self->_get_dbh->selectrow_array('SELECT NEWID()');
103 $updated_cols->{$guid_col} = $to_insert->{$guid_col} = $new_guid;
106 my $is_identity_insert = (List::Util::first { $_->{is_auto_increment} } (values %$supplied_col_info) )
110 if ($is_identity_insert) {
111 $self->_set_identity_insert ($source->name);
114 $updated_cols = { %$updated_cols, %{ $self->next::method(@_) } };
116 if ($is_identity_insert) {
117 $self->_unset_identity_insert ($source->name);
121 return $updated_cols;
124 sub _prep_for_execute {
126 my ($op, $extra_bind, $ident, $args) = @_;
128 # cast MONEY values properly
129 if ($op eq 'insert' || $op eq 'update') {
130 my $fields = $args->[0];
132 for my $col (keys %$fields) {
133 # $ident is a result source object with INSERT/UPDATE ops
134 if ($ident->column_info ($col)->{data_type}
136 $ident->column_info ($col)->{data_type} =~ /^money\z/i) {
137 my $val = $fields->{$col};
138 $fields->{$col} = \['CAST(? AS MONEY)', [ $col => $val ]];
143 my ($sql, $bind) = $self->next::method (@_);
145 if ($op eq 'insert') {
146 $sql .= ';SELECT SCOPE_IDENTITY()';
150 return ($sql, $bind);
157 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
159 if ($op eq 'insert') {
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;
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
172 $self->_identity($identity);
176 return wantarray ? ($rv, $sth, @bind) : $rv;
179 sub last_insert_id { shift->_identity }
181 # savepoint syntax is the same as in Sybase ASE
184 my ($self, $name) = @_;
186 $self->_get_dbh->do("SAVE TRANSACTION $name");
189 # A new SAVE TRANSACTION with the same name releases the previous one.
190 sub _svp_release { 1 }
193 my ($self, $name) = @_;
195 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
198 sub build_datetime_parser {
200 my $type = "DateTime::Format::Strptime";
202 $self->throw_exception("Couldn't load ${type}: $@") if $@;
203 return $type->new( pattern => '%Y-%m-%d %H:%M:%S' ); # %F %T
206 sub sqlt_type { 'SQLServer' }
208 sub _sql_maker_opts {
209 my ( $self, $opts ) = @_;
212 $self->{_sql_maker_opts} = { %$opts };
215 return { limit_dialect => 'Top', %{$self->{_sql_maker_opts}||{}} };
222 DBIx::Class::Storage::DBI::MSSQL - Base Class for Microsoft SQL Server support
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>.
231 =head1 IMPLEMENTATION NOTES
233 =head2 IDENTITY information
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.
240 So, this implementation appends a SELECT SCOPE_IDENTITY() statement
241 onto each INSERT to accommodate that requirement.
243 C<SELECT @@IDENTITY> can also be used by issuing:
245 $self->_identity_method('@@identity');
247 it will only be used if SCOPE_IDENTITY() fails.
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.
253 =head2 identity insert
255 Be aware that we have tried to make things as simple as possible for our users.
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
265 See L<DBIx::Class/CONTRIBUTORS>.
269 You may distribute this code under the same terms as Perl itself.