rename _scope_identity to _identity for odbc/mssql
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / ODBC / Microsoft_SQL_Server.pm
index 1b0c5d8..f263fb3 100644 (file)
@@ -2,95 +2,229 @@ package DBIx::Class::Storage::DBI::ODBC::Microsoft_SQL_Server;
 use strict;
 use warnings;
 
-use base qw/DBIx::Class::Storage::DBI/;
+use base qw/DBIx::Class::Storage::DBI::MSSQL/;
+use mro 'c3';
+use Carp::Clan qw/^DBIx::Class/;
+use List::Util();
 
-sub _prep_for_execute {
-    my $self = shift;
-    my ($op, $extra_bind, $ident, $args) = @_;
+__PACKAGE__->mk_group_accessors(simple => qw/
+  _identity _using_dynamic_cursors
+/);
+
+=head1 NAME
+
+DBIx::Class::Storage::DBI::ODBC::Microsoft_SQL_Server - Support specific
+to Microsoft SQL Server over ODBC
+
+=head1 DESCRIPTION
+
+This class implements support specific to Microsoft SQL Server over ODBC,
+including auto-increment primary keys and SQL::Abstract::Limit dialect.  It
+is loaded automatically by by DBIx::Class::Storage::DBI::ODBC when it
+detects a MSSQL back-end.
+
+=head1 IMPLEMENTATION NOTES
+
+Microsoft SQL Server supports three methods of retrieving the C<IDENTITY>
+value for inserted row: C<IDENT_CURRENT>, C<@@IDENTITY>, and C<SCOPE_IDENTITY()>.
+C<SCOPE_IDENTITY()> is used here because it is the safest.  However, it must
+be called is the same execute statement, not just the same connection.
+
+So, this implementation appends a C<SELECT SCOPE_IDENTITY()> statement
+onto each C<INSERT> to accommodate that requirement.
 
-    my ($sql, $bind) = $self->SUPER::_prep_for_execute(@_);
-    $sql .= ';SELECT SCOPE_IDENTITY()' if $op eq 'insert';
+If you use dynamic cursors with C<< odbc_cursortype => 2 >> or
+L</on_connect_call_use_dynamic_cursors> then the less accurate
+C<SELECT @@IDENTITY> is used instead.
 
-    return ($sql, $bind);
+=head1 MULTIPLE ACTIVE STATEMENTS
+
+The following options are alternative ways to enable concurrent executing
+statement support. Each has its own advantages and drawbacks.
+
+=head2 connect_call_use_dynamic_cursors
+
+Use as:
+
+  on_connect_call => 'use_dynamic_cursors'
+
+in your L<DBIx::Class::Storage::DBI/connect_info> as one way to enable multiple
+concurrent statements.
+
+Will add C<< odbc_cursortype => 2 >> to your DBI connection attributes. See
+L<DBD::ODBC/odbc_cursortype> for more information.
+
+This will not work with CODE ref connect_info's and will do nothing if you set
+C<odbc_cursortype> yourself.
+
+B<WARNING:> this will break C<SCOPE_IDENTITY()>, and C<SELECT @@IDENTITY> will
+be used instead, which on SQL Server 2005 and later will return erroneous
+results on tables which have an on insert trigger that inserts into another
+table with an C<IDENTITY> column.
+
+=cut
+
+sub connect_call_use_dynamic_cursors {
+  my $self = shift;
+
+  if (ref($self->_dbi_connect_info->[0]) eq 'CODE') {
+    croak 'cannot set DBI attributes on a CODE ref connect_info';
+  }
+
+  my $dbi_attrs = $self->_dbi_connect_info->[-1];
+  $dbi_attrs ||= {};
+
+  if (not exists $dbi_attrs->{odbc_cursortype}) {
+    # turn on support for multiple concurrent statements, unless overridden
+    $self->_dbi_connect_info->[-1] = { %$dbi_attrs, odbc_cursortype => 2 };
+    my $connected = defined $self->_dbh;
+    $self->disconnect;
+    $self->ensure_connected if $connected;
+    $self->_using_dynamic_cursors(1);
+  }
 }
 
-sub insert {
-    my ($self, $source, $to_insert) = @_;
+sub _rebless {
+  no warnings 'uninitialized';
+  my $self = shift;
 
-    my $bind_attributes = $self->source_bind_attributes($source);
-    my (undef, $sth) = $self->_execute( 'insert' => [], $source, $bind_attributes, $to_insert);
-    $self->{_scope_identity} = $sth->fetchrow_array;
+  if (ref($self->_dbi_connect_info->[0]) ne 'CODE' &&
+      $self->_dbi_connect_info->[-1]{odbc_cursortype} == 2) {
+    $self->_using_dynamic_cursors(1);
+    return;
+  }
 
-    return $to_insert;
+  $self->_using_dynamic_cursors(0);
 }
 
-sub last_insert_id { shift->{_scope_identity} }
+=head2 connect_call_use_server_cursors
 
-sub sqlt_type { 'SQLServer' }
+Use as:
 
-sub _sql_maker_opts {
-    my ( $self, $opts ) = @_;
+  on_connect_call => 'use_server_cursors'
 
-    if ( $opts ) {
-        $self->{_sql_maker_opts} = { %$opts };
-    }
+May allow multiple active select statements. See
+L<DBD::ODBC/odbc_SQL_ROWSET_SIZE> for more information.
 
-    return { limit_dialect => 'Top', %{$self->{_sql_maker_opts}||{}} };
-}
+Takes an optional parameter for the value to set the attribute to, default is
+C<2>.
+
+B<WARNING>: this does not work on all versions of SQL Server, and may lock up
+your database!
+
+=cut
 
-sub build_datetime_parser {
+=head2 connect_call_use_mars
+
+Use as:
+
+  on_connect_call => 'use_mars'
+
+Use to enable a feature of SQL Server 2005 and later, "Multiple Active Result
+Sets". See L<DBD::ODBC::FAQ/Does DBD::ODBC support Multiple Active Statements?>
+for more information.
+
+B<WARNING>: This has implications for the way transactions are handled.
+
+=cut
+
+sub connect_call_use_mars {
   my $self = shift;
-  my $type = "DateTime::Format::Strptime";
-  eval "use ${type}";
-  $self->throw_exception("Couldn't load ${type}: $@") if $@;
-  return $type->new( pattern => '%F %T' );
+
+  my $dsn = $self->_dbi_connect_info->[0];
+
+  if (ref($dsn) eq 'CODE') {
+    croak 'cannot change the DBI DSN on a CODE ref connect_info';
+  }
+
+  if ($dsn !~ /MARS_Connection=/) {
+    $self->_dbi_connect_info->[0] = "$dsn;MARS_Connection=Yes";
+    my $connected = defined $self->_dbh;
+    $self->disconnect;
+    $self->ensure_connected if $connected;
+  }
 }
 
-1;
+sub insert_bulk {
+  my $self = shift;
+  my ($source, $cols, $data) = @_;
 
-__END__
+  my $identity_insert = 0;
 
-=head1 NAME
+  COLUMNS:
+  foreach my $col (@{$cols}) {
+    if ($source->column_info($col)->{is_auto_increment}) {
+      $identity_insert = 1;
+      last COLUMNS;
+    }
+  }
 
-DBIx::Class::Storage::DBI::ODBC::Microsoft_SQL_Server - Support specific
-to Microsoft SQL Server over ODBC
+  if ($identity_insert) {
+    my $table = $source->from;
+    $self->_get_dbh->do("SET IDENTITY_INSERT $table ON");
+  }
 
-=head1 DESCRIPTION
+  $self->next::method(@_);
 
-This class implements support specific to Microsoft SQL Server over ODBC,
-including auto-increment primary keys and SQL::Abstract::Limit dialect.  It
-is loaded automatically by by DBIx::Class::Storage::DBI::ODBC when it
-detects a MSSQL back-end.
+  if ($identity_insert) {
+    my $table = $source->from;
+    $self->_get_dbh->do("SET IDENTITY_INSERT $table OFF");
+  }
+}
 
-=head1 IMPLEMENTATION NOTES
+sub _prep_for_execute {
+  my $self = shift;
+  my ($op, $extra_bind, $ident, $args) = @_;
 
-Microsoft SQL Server supports three methods of retrieving the IDENTITY
-value for inserted row: IDENT_CURRENT, @@IDENTITY, and SCOPE_IDENTITY().
-SCOPE_IDENTITY is used here because it is the safest.  However, it must
-be called is the same execute statement, not just the same connection.
+  my ($sql, $bind) = $self->next::method (@_);
+
+  if ($op eq 'insert') {
+    $sql .= ';SELECT SCOPE_IDENTITY()';
+
+    my $col_info = $self->_resolve_column_info($ident, [map $_->[0], @{$bind}]);
+    if (List::Util::first { $_->{is_auto_increment} } (values %$col_info) ) {
 
-So, this implementation appends a SELECT SCOPE_IDENTITY() statement
-onto each INSERT to accommodate that requirement.
+      my $table = $ident->from;
+      my $identity_insert_on = "SET IDENTITY_INSERT $table ON";
+      my $identity_insert_off = "SET IDENTITY_INSERT $table OFF";
+      $sql = "$identity_insert_on; $sql; $identity_insert_off";
+    }
+  }
 
-=head1 METHODS
+  return ($sql, $bind);
+}
 
-=head2 insert
+sub _execute {
+    my $self = shift;
+    my ($op) = @_;
 
-=head2 last_insert_id
+    my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
+    if ($op eq 'insert') {
+      my ($identity) = $sth->fetchrow_array;
+      $sth->finish;
 
-=head2 sqlt_type
+      if ((not defined $identity) && $self->_using_dynamic_cursors) {
+        ($identity) = $self->_dbh->selectrow_array('select @@identity');
+      }
 
-=head2 build_datetime_parser
+      $self->_identity($identity);
+    }
 
-The resulting parser handles the MSSQL C<DATETIME> type, but is almost
-certainly not sufficient for the other MSSQL 2008 date/time types.
+    return wantarray ? ($rv, $sth, @bind) : $rv;
+}
 
-=head1 AUTHORS
+sub last_insert_id { shift->_identity() }
 
-Marc Mims C<< <marc@questright.com> >>
+1;
+
+=head1 AUTHOR
+
+See L<DBIx::Class/CONTRIBUTORS>.
 
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
 
 =cut
+
+# vim: sw=2 sts=2