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