X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FDBI%2FODBC%2FMicrosoft_SQL_Server.pm;h=88627d364ae497a1e321638bb28df07649ea9b94;hb=584ea6e4;hp=6676bfb5e1828556a2ee8e93862adbf347e337db;hpb=7b1b2582a2f787fcacd238f1635fbce4cb9e0985;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/Storage/DBI/ODBC/Microsoft_SQL_Server.pm b/lib/DBIx/Class/Storage/DBI/ODBC/Microsoft_SQL_Server.pm
index 6676bfb..88627d3 100644
--- a/lib/DBIx/Class/Storage/DBI/ODBC/Microsoft_SQL_Server.pm
+++ b/lib/DBIx/Class/Storage/DBI/ODBC/Microsoft_SQL_Server.pm
@@ -4,10 +4,10 @@ use warnings;
 
 use base qw/DBIx::Class::Storage::DBI::MSSQL/;
 use mro 'c3';
-
+use Scalar::Util 'reftype';
+use Try::Tiny;
 use Carp::Clan qw/^DBIx::Class/;
-use List::Util();
-use Scalar::Util ();
+use namespace::clean;
 
 __PACKAGE__->mk_group_accessors(simple => qw/
   _using_dynamic_cursors
@@ -27,77 +27,217 @@ MSSQL back-end.
 Most of the functionality is provided from the superclass
 L<DBIx::Class::Storage::DBI::MSSQL>.
 
+=head1 USAGE NOTES
+
+=head2 Basic Linux Setup (Debian)
+
+  sudo aptitude install tdsodbc libdbd-odbc-perl unixodbc
+
+In case it is not already there put the following in C</etc/odbcinst.ini>:
+
+  [FreeTDS]
+  Description = FreeTDS
+  Driver      = /usr/lib/odbc/libtdsodbc.so
+  Setup       = /usr/lib/odbc/libtdsS.so
+  UsageCount  = 1
+
+Set your C<$dsn> in L<connect_info|DBIx::Class::Storage::DBI/connect_info> as follows:
+
+  dbi:ODBC:server=<my.host.name>;port=1433;driver=FreeTDS;tds_version=8.0
+
+If you use the EasySoft driver (L<http://www.easysoft.com>):
+
+  dbi:ODBC:server=<my.host.name>;port=1433;driver=Easysoft ODBC-SQL Server
+
+=head2 Basic Windows Setup
+
+Use the following C<$dsn> for the Microsoft ODBC driver:
+
+  dbi:ODBC:driver={SQL Server};server=SERVER\SQL_SERVER_INSTANCE_NAME
+
+And for the Native Client:
+
+  dbi:ODBC:driver={SQL Server Native Client 10.0};server=SERVER\SQL_SERVER_INSTANCE_NAME
+
+Go into Control Panel -> System and Security -> Administrative Tools -> Data
+Sources (ODBC) to check driver names and to set up data sources.
+
+Use System DSNs, not User DSNs if you want to use DSNs.
+
+If you set up a DSN, use the following C<$dsn> for
+L<connect_info|DBIx::Class::Storage::DBI/connect_info>:
+
+  dbi:ODBC:dsn=MY_DSN
+
 =head1 MULTIPLE ACTIVE STATEMENTS
 
 The following options are alternative ways to enable concurrent executing
-statement support. Each has its own advantages and drawbacks.
+statement support. Each has its own advantages and drawbacks and works on
+different platforms. Read each section carefully.
 
-=head2 connect_call_use_dynamic_cursors
+In order of preference, they are:
 
-Use as:
+=over 8
 
-  on_connect_call => 'use_dynamic_cursors'
+=item * L<mars|/connect_call_use_mars>
 
-in your L<DBIx::Class::Storage::DBI/connect_info> as one way to enable multiple
-concurrent statements.
+=item * L<dynamic_cursors|/connect_call_use_dynamic_cursors>
 
-Will add C<< odbc_cursortype => 2 >> to your DBI connection attributes. See
-L<DBD::ODBC/odbc_cursortype> for more information.
+=item * L<server_cursors|/connect_call_use_server_cursors>
 
-Alternatively, you can add it yourself and dynamic cursor will be automatically
-enabled.
+=back
 
-This will not work with CODE ref connect_info's and will do nothing if you set
-C<odbc_cursortype> yourself.
+=head1 METHODS
 
-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.
+=head2 connect_call_use_mars
+
+Use as:
+
+  on_connect_call => 'use_mars'
+
+in your connection info, or alternatively specify it directly:
+
+  Your::Schema->connect (
+    $original_dsn . '; MARS_Connection=Yes',
+    $user,
+    $pass,
+    \%attrs,
+  )
+
+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.
+
+This does not work on FreeTDS drivers at the time of this writing, and only
+works with the Native Client, later versions of the Windows MS ODBC driver, and
+the Easysoft driver.
 
 =cut
 
-sub connect_call_use_dynamic_cursors {
+sub connect_call_use_mars {
   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];
+  my $dsn = $self->_dbi_connect_info->[0];
 
-  unless (ref($dbi_attrs) && Scalar::Util::reftype($dbi_attrs) eq 'HASH') {
-    $dbi_attrs = {};
-    push @{ $self->_dbi_connect_info }, $dbi_attrs;
+  if (ref($dsn) eq 'CODE') {
+    $self->throw_exception('cannot change the DBI DSN on a CODE ref connect_info');
   }
 
-  if (not exists $dbi_attrs->{odbc_cursortype}) {
-    # turn on support for multiple concurrent statements, unless overridden
-    $dbi_attrs->{odbc_cursortype} = 2;
-    my $connected = defined $self->_dbh;
+  if ($dsn !~ /MARS_Connection=/) {
+    if ($self->using_freetds) {
+      $self->throw_exception('FreeTDS does not support MARS at the time of '
+                            .'writing.');
+    }
+
+    if (exists $self->_server_info->{normalized_dbms_version} &&
+               $self->_server_info->{normalized_dbms_version} < 9) {
+      $self->throw_exception('SQL Server 2005 or later required to use MARS.');
+    }
+
+    if (my ($data_source) = $dsn =~ /^dbi:ODBC:([\w-]+)\z/i) { # prefix with DSN
+      warn "Bare DSN in ODBC connect string, rewriting as 'dsn=$data_source'"
+          ." for MARS\n";
+      $dsn = "dbi:ODBC:dsn=$data_source";
+    }
+
+    $self->_dbi_connect_info->[0] = "$dsn;MARS_Connection=Yes";
     $self->disconnect;
-    $self->ensure_connected if $connected;
-    $self->_set_dynamic_cursors;
+    $self->ensure_connected;
   }
 }
 
-sub _set_dynamic_cursors {
+sub connect_call_use_MARS {
+  carp "'connect_call_use_MARS' has been deprecated, use "
+      ."'connect_call_use_mars' instead.";
+  shift->connect_call_use_mars(@_)
+}
+
+=head2 connect_call_use_dynamic_cursors
+
+Use as:
+
+  on_connect_call => 'use_dynamic_cursors'
+
+Which will add C<< odbc_cursortype => 2 >> to your DBI connection
+attributes, or alternatively specify the necessary flag directly:
+
+  Your::Schema->connect (@dsn, { ... odbc_cursortype => 2 })
+
+See L<DBD::ODBC/odbc_cursortype> for more information.
+
+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:> on FreeTDS (and maybe some other drivers) 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;
-  $self->_using_dynamic_cursors(1);
-  $self->_identity_method('@@identity');
+
+  my $conn_info = $self->_dbi_connect_info;
+
+  if (ref($conn_info->[0]) eq 'CODE') {
+    $self->throw_exception ('Cannot set DBI attributes on a CODE ref connect_info');
+  }
+
+  if (
+    ref($conn_info->[-1]) ne 'HASH'
+      or
+    ($conn_info->[-1]{odbc_cursortype}||0) < 2
+  ) {
+    # reenter connection information with the attribute re-set
+    $self->connect_info(
+      @{$conn_info}[0,1,2],
+      { %{$self->_dbix_connect_attributes}, odbc_cursortype => 2 },
+    );
+    $self->disconnect; # resetting dbi attrs, so have to reconnect
+    $self->ensure_connected;
+  }
 }
 
-sub _rebless {
-  no warnings 'uninitialized';
+sub _run_connection_actions {
   my $self = shift;
 
-  if (ref($self->_dbi_connect_info->[0]) ne 'CODE' &&
-      eval { $self->_dbi_connect_info->[-1]{odbc_cursortype} } == 2) {
-    $self->_set_dynamic_cursors;
-    return;
+  # keep the dynamic_cursors_support and driver-state in sync
+  # on every reconnect
+  my $use_dyncursors = ($self->_dbic_connect_attributes->{odbc_cursortype} || 0) > 1;
+  if (
+    $use_dyncursors
+      xor
+    !!$self->_using_dynamic_cursors
+  ) {
+    if ($use_dyncursors) {
+      try {
+        my $dbh = $self->_dbh;
+        local $dbh->{RaiseError} = 1;
+        local $dbh->{PrintError} = 0;
+        $dbh->do('SELECT @@IDENTITY');
+      } catch {
+        $self->throw_exception (
+          'Your drivers do not seem to support dynamic cursors (odbc_cursortype => 2).'
+         . (
+          $self->using_freetds
+            ? ' If you are using FreeTDS, make sure to set tds_version to 8.0 or greater.'
+            : ''
+          )
+        );
+      };
+
+      $self->_using_dynamic_cursors(1);
+      $self->_identity_method('@@identity');
+    }
+    else {
+      $self->_using_dynamic_cursors(0);
+      $self->_identity_method(undef);
+    }
   }
 
-  $self->_using_dynamic_cursors(0);
+  $self->next::method (@_);
 }
 
 =head2 connect_call_use_server_cursors
@@ -115,44 +255,41 @@ C<2>.
 B<WARNING>: this does not work on all versions of SQL Server, and may lock up
 your database!
 
+At the time of writing, this option only works on Microsoft's Windows drivers,
+later versions of the ODBC driver and the Native Client driver.
+
 =cut
 
 sub connect_call_use_server_cursors {
   my $self            = shift;
   my $sql_rowset_size = shift || 2;
 
-  $self->_dbh->{odbc_SQL_ROWSET_SIZE} = $sql_rowset_size;
+  if ($^O !~ /win32|cygwin/i) {
+    $self->throw_exception('Server cursors only work on Windows platforms at '
+                          .'the time of writing.');
+  }
+
+  $self->_get_dbh->{odbc_SQL_ROWSET_SIZE} = $sql_rowset_size;
 }
 
-=head2 connect_call_use_mars
+=head2 using_freetds
 
-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.
+Tries to determine, to the best of our ability, whether or not you are using the
+FreeTDS driver with L<DBD::ODBC>.
 
 =cut
 
-sub connect_call_use_mars {
+sub using_freetds {
   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';
-  }
+  $dsn = '' if ref $dsn eq 'CODE';
 
-  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;
-  }
+  return 1 if $dsn =~ /driver=FreeTDS/i
+              || ($self->_dbh_get_info(6)||'') =~ /tdsodbc/i;
+
+  return 0;
 }
 
 1;