Cleanup exception handling
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / ODBC / Microsoft_SQL_Server.pm
index 9757eca..bf01131 100644 (file)
@@ -4,11 +4,12 @@ use warnings;
 
 use base qw/DBIx::Class::Storage::DBI::MSSQL/;
 use mro 'c3';
-use Carp::Clan qw/^DBIx::Class/;
+
 use List::Util();
+use Scalar::Util ();
 
 __PACKAGE__->mk_group_accessors(simple => qw/
-  _identity _using_dynamic_cursors
+  _using_dynamic_cursors
 /);
 
 =head1 NAME
@@ -18,24 +19,12 @@ 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.
+This class implements support specific to Microsoft SQL Server over ODBC.  It is
+loaded automatically by by DBIx::Class::Storage::DBI::ODBC when it detects a
+MSSQL back-end.
 
-So, this implementation appends a C<SELECT SCOPE_IDENTITY()> statement
-onto each C<INSERT> to accommodate that requirement.
-
-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.
+Most of the functionality is provided from the superclass
+L<DBIx::Class::Storage::DBI::MSSQL>.
 
 =head1 MULTIPLE ACTIVE STATEMENTS
 
@@ -54,8 +43,12 @@ 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.
+Alternatively, you can add it yourself and dynamic cursor support will be
+automatically enabled.
+
+If you're using FreeTDS, C<tds_version> must be set to at least C<8.0>.
+
+This will not work with CODE ref connect_info's.
 
 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
@@ -68,29 +61,59 @@ 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';
+    $self->throw_exception ('cannot set DBI attributes on a CODE ref connect_info');
   }
 
   my $dbi_attrs = $self->_dbi_connect_info->[-1];
-  $dbi_attrs ||= {};
+
+  unless (ref($dbi_attrs) && Scalar::Util::reftype($dbi_attrs) eq 'HASH') {
+    $dbi_attrs = {};
+    push @{ $self->_dbi_connect_info }, $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);
+    $dbi_attrs->{odbc_cursortype} = 2;
+    $self->disconnect; # resetting dbi attrs, so have to reconnect
+    $self->ensure_connected;
+    $self->_set_dynamic_cursors;
+  }
+}
+
+sub _set_dynamic_cursors {
+  my $self = shift;
+  my $dbh  = $self->_get_dbh;
+
+  eval {
+    local $dbh->{RaiseError} = 1;
+    local $dbh->{PrintError} = 0;
+    $dbh->do('SELECT @@IDENTITY');
+  };
+  if ($@) {
+    $self->throw_exception (<<'EOF');
+
+Your drivers do not seem to support dynamic cursors (odbc_cursortype => 2),
+if you're using FreeTDS, make sure to set tds_version to 8.0 or greater.
+EOF
   }
+
+  $self->_using_dynamic_cursors(1);
+  $self->_identity_method('@@identity');
 }
 
-sub _rebless {
-  no warnings 'uninitialized';
+sub _init {
   my $self = shift;
 
-  if (ref($self->_dbi_connect_info->[0]) ne 'CODE' &&
-      $self->_dbi_connect_info->[-1]{odbc_cursortype} == 2) {
-    $self->_using_dynamic_cursors(1);
+  no warnings qw/uninitialized/;
+
+  if (
+    ref($self->_dbi_connect_info->[0]) ne 'CODE'
+      &&
+    ref ($self->_dbi_connect_info->[-1]) eq 'HASH'
+      &&
+    $self->_dbi_connect_info->[-1]{odbc_cursortype} == 2
+  ) {
+    $self->_set_dynamic_cursors;
     return;
   }
 
@@ -114,11 +137,18 @@ your database!
 
 =cut
 
-=head2 connect_call_use_mars
+sub connect_call_use_server_cursors {
+  my $self            = shift;
+  my $sql_rowset_size = shift || 2;
+
+  $self->_get_dbh->{odbc_SQL_ROWSET_SIZE} = $sql_rowset_size;
+}
+
+=head2 connect_call_use_MARS
 
 Use as:
 
-  on_connect_call => 'use_mars'
+  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?>
@@ -128,106 +158,23 @@ B<WARNING>: This has implications for the way transactions are handled.
 
 =cut
 
-sub connect_call_use_mars {
+sub connect_call_use_MARS {
   my $self = shift;
 
   my $dsn = $self->_dbi_connect_info->[0];
 
   if (ref($dsn) eq 'CODE') {
-    croak 'cannot change the DBI DSN on a CODE ref connect_info';
+    $self->throw_exception('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;
+    my $was_connected = defined $self->_dbh;
     $self->disconnect;
-    $self->ensure_connected if $connected;
+    $self->ensure_connected if $was_connected;
   }
 }
 
-sub insert_bulk {
-  my $self = shift;
-  my ($source, $cols, $data) = @_;
-
-  my $identity_insert = 0;
-
-  COLUMNS:
-  foreach my $col (@{$cols}) {
-    if ($source->column_info($col)->{is_auto_increment}) {
-      $identity_insert = 1;
-      last COLUMNS;
-    }
-  }
-
-  if ($identity_insert) {
-    my $table = $source->from;
-    $self->_get_dbh->do("SET IDENTITY_INSERT $table ON");
-  }
-
-  $self->next::method(@_);
-
-  if ($identity_insert) {
-    my $table = $source->from;
-    $self->_get_dbh->do("SET IDENTITY_INSERT $table OFF");
-  }
-}
-
-sub _prep_for_execute {
-  my $self = shift;
-  my ($op, $extra_bind, $ident, $args) = @_;
-
-# cast MONEY values properly
-  if ($op eq 'insert' || $op eq 'update') {
-    my $fields = $args->[0];
-    my $col_info = $self->_resolve_column_info($ident, [keys %$fields]);
-
-    for my $col (keys %$fields) {
-      if ($col_info->{$col}{data_type} =~ /^money\z/i) {
-        my $val = $fields->{$col};
-        $fields->{$col} = \['CAST(? AS MONEY)', [ $col => $val ]];
-      }
-    }
-  }
-
-  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) ) {
-
-      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";
-    }
-  }
-
-  return ($sql, $bind);
-}
-
-sub _execute {
-    my $self = shift;
-    my ($op) = @_;
-
-    my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
-    if ($op eq 'insert') {
-      my ($identity) = $sth->fetchrow_array;
-      $sth->finish;
-
-      if ((not defined $identity) && $self->_using_dynamic_cursors) {
-        ($identity) = $self->_dbh->selectrow_array('select @@identity');
-      }
-
-      $self->_identity($identity);
-    }
-
-    return wantarray ? ($rv, $sth, @bind) : $rv;
-}
-
-sub last_insert_id { shift->_identity() }
-
 1;
 
 =head1 AUTHOR
@@ -239,5 +186,4 @@ See L<DBIx::Class/CONTRIBUTORS>.
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-
 # vim: sw=2 sts=2