lib/DBIx/Class/Storage/DBI/MSSQL.pm

   1 package DBIx::Class::Storage::DBI::MSSQL;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base qw/DBIx::Class::Storage::DBI::AmbiguousGlob DBIx::Class::Storage::DBI/;
   7 use mro 'c3';
   8
   9 use List::Util();
  10
  11 __PACKAGE__->mk_group_accessors(simple => qw/
  12   _identity _identity_method
  13 /);
  14
  15 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks::MSSQL');
  16
  17 sub _set_identity_insert {
  18   my ($self, $table) = @_;
  19
  20   my $sql = sprintf (
  21     'SET IDENTITY_INSERT %s ON',
  22     $self->sql_maker->_quote ($table),
  23   );
  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   }
  33 }
  34
  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
  47 sub insert_bulk {
  48   my $self = shift;
  49   my ($source, $cols, $data) = @_;
  50
  51   my $is_identity_insert = (List::Util::first
  52       { $source->column_info ($_)->{is_auto_increment} }
  53       (@{$cols})
  54   )
  55      ? 1
  56      : 0;
  57
  58   if ($is_identity_insert) {
  59      $self->_set_identity_insert ($source->name);
  60   }
  61
  62   $self->next::method(@_);
  63
  64   if ($is_identity_insert) {
  65      $self->_unset_identity_insert ($source->name);
  66   }
  67 }
  68
  69 # support MSSQL GUID column types
  70
  71 sub insert {
  72   my $self = shift;
  73   my ($source, $to_insert) = @_;
  74
  75   my $supplied_col_info = $self->_resolve_column_info($source, [keys %$to_insert] );
  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 {
  83     $source->column_info($_)->{data_type}
  84     &&
  85     $source->column_info($_)->{data_type} =~ /^uniqueidentifier/i
  86   } @pk_cols;
  87
  88   my @auto_guids = grep {
  89     $source->column_info($_)->{data_type}
  90     &&
  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
  99   my $updated_cols = {};
 100
 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;
 104   }
 105
 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);
 112   }
 113
 114   $updated_cols = { %$updated_cols, %{ $self->next::method(@_) } };
 115
 116   if ($is_identity_insert) {
 117      $self->_unset_identity_insert ($source->name);
 118   }
 119
 120
 121   return $updated_cols;
 122 }
 123
 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];
 131
 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}
 135          &&
 136          $ident->column_info ($col)->{data_type} =~ /^money\z/i) {
 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
 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'), @_);
 158
 159   if ($op eq 'insert') {
 160
 161     # this should bring back the result of SELECT SCOPE_IDENTITY() we tacked
 162     # on in _prep_for_execute above
 163     my ($identity) = eval { $sth->fetchrow_array };
 164
 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     }
 171
 172     $self->_identity($identity);
 173     $sth->finish;
 174   }
 175
 176   return wantarray ? ($rv, $sth, @bind) : $rv;
 177 }
 178
 179 sub last_insert_id { shift->_identity }
 180
 181 #
 182 # MSSQL is retarded wrt ordered subselects. One needs to add a TOP 100%
 183 # to *all* subqueries, do it here.
 184 #
 185 sub _select_args_to_query {
 186   my $self = shift;
 187
 188   my ($sql, $prep_bind, @rest) = $self->next::method (@_);
 189
 190   # see if this is an ordered subquery
 191   my $attrs = $_[3];
 192   if ( scalar $self->sql_maker->_order_by_chunks ($attrs->{order_by}) ) {
 193     $sql =~ s/^ \s* SELECT \s/SELECT TOP 100 PERCENT /xi;
 194   }
 195
 196   return wantarray
 197     ? ($sql, $prep_bind, @rest)
 198     : \[ "($sql)", @$prep_bind ]
 199   ;
 200 }
 201
 202
 203 # savepoint syntax is the same as in Sybase ASE
 204
 205 sub _svp_begin {
 206   my ($self, $name) = @_;
 207
 208   $self->_get_dbh->do("SAVE TRANSACTION $name");
 209 }
 210
 211 # A new SAVE TRANSACTION with the same name releases the previous one.
 212 sub _svp_release { 1 }
 213
 214 sub _svp_rollback {
 215   my ($self, $name) = @_;
 216
 217   $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
 218 }
 219
 220 sub build_datetime_parser {
 221   my $self = shift;
 222   my $type = "DateTime::Format::Strptime";
 223   eval "use ${type}";
 224   $self->throw_exception("Couldn't load ${type}: $@") if $@;
 225   return $type->new( pattern => '%Y-%m-%d %H:%M:%S' );  # %F %T
 226 }
 227
 228 sub sqlt_type { 'SQLServer' }
 229
 230 sub _get_mssql_version {
 231   my $self = shift;
 232
 233   my $data = $self->_get_dbh->selectrow_hashref('xp_msver ProductVersion');
 234
 235   if ($data->{Character_Value} =~ /^(\d+)\./) {
 236     return $1;
 237   } else {
 238     $self->throw_exception(q{Your ProductVersion's Character_Value is missing or malformed!});
 239   }
 240 }
 241
 242 sub sql_maker {
 243   my $self = shift;
 244
 245   unless ($self->_sql_maker) {
 246     unless ($self->{_sql_maker_opts}{limit_dialect}) {
 247       my $version = eval { $self->_get_mssql_version; } || 0;
 248
 249       $self->{_sql_maker_opts} = {
 250         limit_dialect => ($version >= 9 ? 'RowNumberOver' : 'Top'),
 251         %{$self->{_sql_maker_opts}||{}}
 252       };
 253     }
 254
 255     my $maker = $self->next::method (@_);
 256   }
 257
 258   return $self->_sql_maker;
 259 }
 260
 261 1;
 262
 263 =head1 NAME
 264
 265 DBIx::Class::Storage::DBI::MSSQL - Base Class for Microsoft SQL Server support
 266 in DBIx::Class
 267
 268 =head1 SYNOPSIS
 269
 270 This is the base class for Microsoft SQL Server support, used by
 271 L<DBIx::Class::Storage::DBI::ODBC::Microsoft_SQL_Server> and
 272 L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
 273
 274 =head1 IMPLEMENTATION NOTES
 275
 276 =head2 IDENTITY information
 277
 278 Microsoft SQL Server supports three methods of retrieving the IDENTITY
 279 value for inserted row: IDENT_CURRENT, @@IDENTITY, and SCOPE_IDENTITY().
 280 SCOPE_IDENTITY is used here because it is the safest.  However, it must
 281 be called is the same execute statement, not just the same connection.
 282
 283 So, this implementation appends a SELECT SCOPE_IDENTITY() statement
 284 onto each INSERT to accommodate that requirement.
 285
 286 C<SELECT @@IDENTITY> can also be used by issuing:
 287
 288   $self->_identity_method('@@identity');
 289
 290 it will only be used if SCOPE_IDENTITY() fails.
 291
 292 This is more dangerous, as inserting into a table with an on insert trigger that
 293 inserts into another table with an identity will give erroneous results on
 294 recent versions of SQL Server.
 295
 296 =head2 identity insert
 297
 298 Be aware that we have tried to make things as simple as possible for our users.
 299 For MSSQL that means that when a user tries to create a row, while supplying an
 300 explicit value for an autoincrementing column, we will try to issue the
 301 appropriate database call to make this possible, namely C<SET IDENTITY_INSERT
 302 $table_name ON>. Unfortunately this operation in MSSQL requires the
 303 C<db_ddladmin> privilege, which is normally not included in the standard
 304 write-permissions.
 305
 306 =head1 AUTHOR
 307
 308 See L<DBIx::Class/CONTRIBUTORS>.
 309
 310 =head1 LICENSE
 311
 312 You may distribute this code under the same terms as Perl itself.
 313
 314 =cut