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

   1 package DBIx::Class::Storage::DBI::IdentityInsert;
   2
   3 use strict;
   4 use warnings;
   5 use base 'DBIx::Class::Storage::DBI';
   6 use mro 'c3';
   7
   8 =head1 NAME
   9
  10 DBIx::Class::Storage::DBI::IdentityInsert - Storage Component for Sybase ASE and
  11 MSSQL for Identity Inserts / Updates
  12
  13 =head1 DESCRIPTION
  14
  15 This is a storage component for Sybase ASE
  16 (L<DBIx::Class::Storage::DBI::Sybase::ASE>) and Microsoft SQL Server
  17 (L<DBIx::Class::Storage::DBI::MSSQL>) to support identity inserts, that is
  18 inserts of explicit values into C<IDENTITY> columns.
  19
  20 This is done by wrapping C<INSERT> operations in a pair of table identity
  21 toggles like:
  22
  23   SET IDENTITY_INSERT $table ON
  24   $sql
  25   SET IDENTITY_INSERT $table OFF
  26
  27 =cut
  28
  29 # SET IDENTITY_X only works as part of a statement scope. We can not
  30 # $dbh->do the $sql and the wrapping set()s individually. Hence the
  31 # sql mangling. The newlines are important.
  32 sub _prep_for_execute {
  33   my $self = shift;
  34
  35   return $self->next::method(@_) unless $self->_autoinc_supplied_for_op;
  36
  37   my ($op, $ident) = @_;
  38
  39   my $table = $self->sql_maker->_quote($ident->name);
  40   $op = uc $op;
  41
  42   DBIx::Class::Exception->throw(
  43     "Unexpected _autoinc_supplied_for_op flag in callstack - please file a bug including the stacktrace ( @{[ DBIx::Class::_ENV_::HELP_URL() ]} ):\n\n STACKTRACE STARTS",
  44     'stacktrace'
  45   ) if $op ne 'INSERT' and $op ne 'UPDATE';
  46
  47   my ($sql, $bind) = $self->next::method(@_);
  48
  49   return (<<EOS, $bind);
  50 SET IDENTITY_$op $table ON
  51 $sql
  52 SET IDENTITY_$op $table OFF
  53 EOS
  54
  55 }
  56
  57 =head1 FURTHER QUESTIONS?
  58
  59 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
  60
  61 =head1 COPYRIGHT AND LICENSE
  62
  63 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
  64 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
  65 redistribute it and/or modify it under the same terms as the
  66 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
  67
  68 =cut
  69
  70 1;