X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FDBI%2FSybase.pm;h=43932fac8084722eb55840b2e92a1cc890e3309f;hb=322b7a6b;hp=555f0d5ef8003f2b0dbe529287592677236d4d52;hpb=a3a526ccbf65e59361a29b753f4bdd9495ad6dd5;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/Storage/DBI/Sybase.pm b/lib/DBIx/Class/Storage/DBI/Sybase.pm
index 555f0d5..43932fa 100644
--- a/lib/DBIx/Class/Storage/DBI/Sybase.pm
+++ b/lib/DBIx/Class/Storage/DBI/Sybase.pm
@@ -4,15 +4,15 @@ use strict;
 use warnings;
 
 use base qw/
-    DBIx::Class::Storage::DBI::Sybase::Base
-    DBIx::Class::Storage::DBI
+    DBIx::Class::Storage::DBI::Sybase::Common
+    DBIx::Class::Storage::DBI::AutoCast
 /;
 use mro 'c3';
 use Carp::Clan qw/^DBIx::Class/;
 use List::Util ();
 
 __PACKAGE__->mk_group_accessors('simple' =>
-    qw/_identity _blob_log_on_update _auto_cast _insert_txn/
+    qw/_identity _blob_log_on_update _insert_dbh _identity_method/
 );
 
 =head1 NAME
@@ -32,13 +32,8 @@ will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
 also enable that driver explicitly, see the documentation for more details.
 
 With this driver there is unfortunately no way to get the C<last_insert_id>
-without doing a C<SELECT MAX(col)>.
-
-But your queries will be cached.
-
-You need a version of L<DBD::Sybase> compiled with the Sybase OpenClient
-libraries, B<NOT> FreeTDS, for placeholder support. Otherwise your storage will
-be automatically reblessed into C<::NoBindVars>.
+without doing a C<SELECT MAX(col)>. This is done safely in a transaction
+(locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
 
 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
 
@@ -53,7 +48,7 @@ sub _rebless {
 
   if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
     my $dbtype = eval {
-      @{$self->dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
+      @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
     } || '';
 
     my $exception = $@;
@@ -66,11 +61,7 @@ sub _rebless {
     } else { # real Sybase
       my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
 
-# This is reset to 0 in ::NoBindVars, only necessary because we use max(col) to
-# get the identity.
-      $self->_insert_txn(1);
-
-      if ($self->_using_freetds) {
+      if ($self->using_freetds) {
         carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
 
 You are using FreeTDS with Sybase.
@@ -80,7 +71,7 @@ support experimental.
 
 TEXT/IMAGE columns will definitely not work.
 
-You are encouraged to recompile DBD::Sybase with the Sybase OpenClient libraries
+You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
 instead.
 
 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
@@ -88,23 +79,29 @@ See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
 variable.
 EOF
-        if (not $self->_placeholders_with_type_conversion_supported) {
+        if (not $self->_typeless_placeholders_supported) {
           if ($self->_placeholders_supported) {
-            $self->_auto_cast(1);
+            $self->auto_cast(1);
           } else {
             $self->ensure_class_loaded($no_bind_vars);
             bless $self, $no_bind_vars;
             $self->_rebless;
           }
         }
-      }
 
-      if (not $self->dbh->{syb_dynamic_supported}) {
+        $self->set_textsize; # based on LongReadLen in connect_info
+
+      }
+      elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
+        # not necessarily FreeTDS, but no placeholders nevertheless
         $self->ensure_class_loaded($no_bind_vars);
         bless $self, $no_bind_vars;
         $self->_rebless;
+      } elsif (not $self->_typeless_placeholders_supported) {
+# this is highly unlikely, but we check just in case
+        $self->auto_cast(1);
       }
- 
+
       $self->_set_max_connect(256);
     }
   }
@@ -119,7 +116,7 @@ sub _populate_dbh {
 
   $self->next::method(@_);
 
-  if (not $self->_using_freetds) {
+  if (not $self->using_freetds) {
     $self->_dbh->{syb_chained_txn} = 1;
   } else {
     if ($self->_dbh_autocommit) {
@@ -165,55 +162,35 @@ sub _is_lob_type {
   $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
 }
 
-# The select-piggybacking-on-insert trick stolen from odbc/mssql
 sub _prep_for_execute {
   my $self = shift;
   my ($op, $extra_bind, $ident, $args) = @_;
 
   my ($sql, $bind) = $self->next::method (@_);
 
-# Some combinations of FreeTDS and Sybase throw implicit conversion errors for
-# all placeeholders, so we convert them into CASTs here.
-# Based on code in ::DBI::NoBindVars .
-#
-# If we're using ::NoBindVars, there are no binds by this point so this code
-# gets skippeed.
-  if ($self->_auto_cast && @$bind) {
-    my $new_sql;
-    my @sql_part = split /\?/, $sql;
-    my $col_info = $self->_resolve_column_info($ident,[ map $_->[0], @$bind ]);
-
-    foreach my $bound (@$bind) {
-      my $col = $bound->[0];
-      my $syb_type = $self->_syb_base_type($col_info->{$col}{data_type});
-
-      foreach my $data (@{$bound}[1..$#$bound]) {
-        $new_sql .= shift(@sql_part) .
-          ($syb_type ? "CAST(? AS $syb_type)" : '?');
-      }
-    }
-    $new_sql .= join '', @sql_part;
-    $sql = $new_sql;
-  }
-
   if ($op eq 'insert') {
     my $table = $ident->from;
 
     my $bind_info = $self->_resolve_column_info(
       $ident, [map $_->[0], @{$bind}]
     );
-    my $identity_col =
-List::Util::first { $bind_info->{$_}{is_auto_increment} } (keys %$bind_info);
+    my $identity_col = List::Util::first
+      { $bind_info->{$_}{is_auto_increment} }
+      (keys %$bind_info)
+    ;
 
     if ($identity_col) {
-      $sql =
-"SET IDENTITY_INSERT $table ON\n" .
-"$sql\n" .
-"SET IDENTITY_INSERT $table OFF"
-    } else {
-      $identity_col = List::Util::first {
-        $ident->column_info($_)->{is_auto_increment}
-      } $ident->columns;
+      $sql = join ("\n",
+        "SET IDENTITY_INSERT $table ON",
+        $sql,
+        "SET IDENTITY_INSERT $table OFF",
+      );
+    }
+    else {
+      $identity_col = List::Util::first
+        { $ident->column_info($_)->{is_auto_increment} }
+        $ident->columns
+      ;
     }
 
     if ($identity_col) {
@@ -226,9 +203,10 @@ List::Util::first { $bind_info->{$_}{is_auto_increment} } (keys %$bind_info);
   return ($sql, $bind);
 }
 
-# Stolen from SQLT, with some modifications. This will likely change when the
-# SQLT Sybase stuff is redone/fixed-up.
-my %TYPE_MAPPING  = (
+# Stolen from SQLT, with some modifications. This is a makeshift
+# solution before a sane type-mapping library is available, thus
+# the 'our' for easy overrides.
+our %TYPE_MAPPING  = (
     number    => 'numeric',
     money     => 'money',
     varchar   => 'varchar',
@@ -246,11 +224,11 @@ my %TYPE_MAPPING  = (
     long      => 'varchar',
 );
 
-sub _syb_base_type {
+sub _native_data_type {
   my ($self, $type) = @_;
 
   $type = lc $type;
-  $type =~ s/ identity//;
+  $type =~ s/\s* identity//x;
 
   return uc($TYPE_MAPPING{$type} || $type);
 }
@@ -277,47 +255,97 @@ sub _execute {
 
 sub last_insert_id { shift->_identity }
 
-# override to handle TEXT/IMAGE and to do a transaction if necessary
+# handles TEXT/IMAGE and transaction for last_insert_id
 sub insert {
-  my ($self, $source, $to_insert) = splice @_, 0, 3;
-  my $dbh = $self->_dbh;
+  my $self = shift;
+  my ($source, $to_insert) = @_;
 
   my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
 
-# We have to do the insert in a transaction to avoid race conditions with the
-# SELECT MAX(COL) identity method used when placeholders are enabled.
+# insert+blob insert done atomically, on _insert_dbh
+  (my ($guard), local ($self->{_dbh})) = do {
+    $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info }))
+      unless $self->_insert_dbh;
+
+    my $new_guard = $self->txn_scope_guard;
+
+# _dbh_begin_work may reconnect, if so we need to update _insert_dbh
+    $self->_insert_dbh($self->_dbh);
+
+    ($new_guard, $self->_insert_dbh)
+  } if $blob_cols;
+
+  my $need_last_insert_id = 0;
+
+  my ($identity_col) =
+    map $_->[0],
+    grep $_->[1]{is_auto_increment},
+    map [ $_, $source->column_info($_) ],
+    $source->columns;
+
+  $need_last_insert_id = 1
+    if $identity_col && (not exists $to_insert->{$identity_col});
+
+  # We have to do the insert in a transaction to avoid race conditions with the
+  # SELECT MAX(COL) identity method used when placeholders are enabled.
   my $updated_cols = do {
-    if ($self->_insert_txn && (not $self->{transaction_depth})) {
-      my $args = \@_;
-      my $method = $self->next::can;
-      $self->txn_do(
-        sub { $self->$method($source, $to_insert, @$args) }
-      );
-    } else {
-      $self->next::method($source, $to_insert, @_);
+    no warnings 'uninitialized';
+    if (
+      $need_last_insert_id &&
+      $self->_identity_method ne '@@IDENTITY' &&
+      !$self->{transaction_depth}
+    ) {
+      $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info }))
+        unless $self->_insert_dbh;
+      local $self->{_dbh} = $self->_insert_dbh;
+
+      my $guard = $self->txn_scope_guard;
+
+# _dbh_begin_work may reconnect, if so we need to update _insert_dbh
+      $self->_insert_dbh($self->_dbh);
+
+      my $upd_cols = $self->next::method (@_);
+      $guard->commit;
+
+      $upd_cols;
+    }
+    else {
+      $self->next::method(@_);
     }
   };
 
-  $self->_insert_blobs($source, $blob_cols, $to_insert) if %$blob_cols;
+  $self->_insert_blobs($source, $blob_cols, $to_insert) if $blob_cols;
+
+  $guard->commit if $guard;
 
   return $updated_cols;
 }
 
 sub update {
-  my ($self, $source)  = splice @_, 0, 2;
-  my ($fields, $where) = @_;
-  my $wantarray        = wantarray;
+  my $self = shift;
+  my ($source, $fields, $where) = @_;
+
+  my $wantarray = wantarray;
 
   my $blob_cols = $self->_remove_blob_cols($source, $fields);
 
+# update+blob update(s) done atomically
+  my $guard = $self->txn_scope_guard if $blob_cols;
+
   my @res;
   if ($wantarray) {
-    @res    = $self->next::method($source, @_);
-  } else {
-    $res[0] = $self->next::method($source, @_);
+    @res    = $self->next::method(@_);
+  }
+  elsif (defined $wantarray) {
+    $res[0] = $self->next::method(@_);
+  }
+  else {
+    $self->next::method(@_);
   }
 
-  $self->_update_blobs($source, $blob_cols, $where) if %$blob_cols;
+  $self->_update_blobs($source, $blob_cols, $where) if $blob_cols;
+
+  $guard->commit if $guard;
 
   return $wantarray ? @res : $res[0];
 }
@@ -334,7 +362,7 @@ sub _remove_blob_cols {
     }
   }
 
-  return \%blob_cols;
+  return keys %blob_cols ? \%blob_cols : undef;
 }
 
 sub _update_blobs {
@@ -374,7 +402,7 @@ sub _update_blobs {
 
 sub _insert_blobs {
   my ($self, $source, $blob_cols, $row) = @_;
-  my $dbh = $self->dbh;
+  my $dbh = $self->_get_dbh;
 
   my $table = $source->from;
 
@@ -395,14 +423,13 @@ sub _insert_blobs {
 
   for my $col (keys %$blob_cols) {
     my $blob = $blob_cols->{$col};
-    my $sth;
 
     my %where = map { ($_, $row{$_}) } @primary_cols;
     my $cursor = $source->resultset->search(\%where, {
       select => [$col]
     })->cursor;
     $cursor->next;
-    $sth = $cursor->sth;
+    my $sth = $cursor->sth;
 
     eval {
       do {
@@ -426,10 +453,11 @@ sub _insert_blobs {
     my $exception = $@;
     $sth->finish if $sth;
     if ($exception) {
-      if ($self->_using_freetds) {
-        croak
-"TEXT/IMAGE operation failed, probably because you're using FreeTDS: " .
-$exception;
+      if ($self->using_freetds) {
+        croak (
+          'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
+          . $exception
+        );
       } else {
         croak $exception;
       }
@@ -464,6 +492,7 @@ C<SMALLDATETIME> columns only have minute precision.
     my $dbh = $self->_dbh;
 
     if ($dbh->can('syb_date_fmt')) {
+      # amazingly, this works with FreeTDS
       $dbh->syb_date_fmt('ISO_strict');
     } elsif (not $old_dbd_warned) {
       carp "Your DBD::Sybase is too old to support ".
@@ -471,7 +500,7 @@ C<SMALLDATETIME> columns only have minute precision.
       $old_dbd_warned = 1;
     }
 
-    $dbh->do('set dateformat mdy');
+    $dbh->do('SET DATEFORMAT mdy');
 
     1;
   }
@@ -479,33 +508,34 @@ C<SMALLDATETIME> columns only have minute precision.
 
 sub datetime_parser_type { "DateTime::Format::Sybase" }
 
-# ->begin_work and such have no effect with FreeTDS
+# ->begin_work and such have no effect with FreeTDS but we run them anyway to
+# let the DBD keep any state it needs to.
+#
+# If they ever do start working, the extra statements will do no harm (because
+# Sybase supports nested transactions.)
 
 sub _dbh_begin_work {
   my $self = shift;
-  if (not $self->_using_freetds) {
-    return $self->next::method(@_);
-  } else {
-    $self->dbh->do('BEGIN TRAN');
+  $self->next::method(@_);
+  if ($self->using_freetds) {
+    $self->_get_dbh->do('BEGIN TRAN');
   }
 }
 
 sub _dbh_commit {
   my $self = shift;
-  if (not $self->_using_freetds) {
-    return $self->next::method(@_);
-  } else {
+  if ($self->using_freetds) {
     $self->_dbh->do('COMMIT');
   }
+  return $self->next::method(@_);
 }
 
 sub _dbh_rollback {
   my $self = shift;
-  if (not $self->_using_freetds) {
-    return $self->next::method(@_);
-  } else {
+  if ($self->using_freetds) {
     $self->_dbh->do('ROLLBACK');
   }
+  return $self->next::method(@_);
 }
 
 # savepoint support using ASE syntax
@@ -513,7 +543,7 @@ sub _dbh_rollback {
 sub _svp_begin {
   my ($self, $name) = @_;
 
-  $self->dbh->do("SAVE TRANSACTION $name");
+  $self->_get_dbh->do("SAVE TRANSACTION $name");
 }
 
 # A new SAVE TRANSACTION with the same name releases the previous one.
@@ -522,20 +552,110 @@ sub _svp_release { 1 }
 sub _svp_rollback {
   my ($self, $name) = @_;
 
-  $self->dbh->do("ROLLBACK TRANSACTION $name");
+  $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
 }
 
 1;
 
+=head1 Schema::Loader Support
+
+There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
+allow you to dump a schema from most (if not all) versions of Sybase.
+
+It is available via subversion from:
+
+  http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
+
+=head1 FreeTDS
+
+This driver supports L<DBD::Sybase> compiled against FreeTDS
+(L<http://www.freetds.org/>) to the best of our ability, however it is
+recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
+libraries. They are a part of the Sybase ASE distribution:
+
+The Open Client FAQ is here:
+L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
+
+Sybase ASE for Linux (which comes with the Open Client libraries) may be
+downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
+
+To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
+
+  perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
+
+Some versions of the libraries involved will not support placeholders, in which
+case the storage will be reblessed to
+L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
+
+In some configurations, placeholders will work but will throw implicit type
+conversion errors for anything that's not expecting a string. In such a case,
+the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
+automatically set, which you may enable on connection with
+L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
+for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
+definitions in your Result classes, and are mapped to a Sybase type (if it isn't
+already) using a mapping based on L<SQL::Translator>.
+
+In other configurations, placeholers will work just as they do with the Sybase
+Open Client libraries.
+
+Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
+
+=head1 INSERTS WITH PLACEHOLDERS
+
+With placeholders enabled, inserts are done in a transaction so that there are
+no concurrency issues with getting the inserted identity value using
+C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
+mode.
+
+When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
+disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
+session variable.
+
+=head1 TRANSACTIONS
+
+Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
+begin a transaction while there are active cursors. An active cursor is, for
+example, a L<ResultSet|DBIx::Class::ResultSet> that has been executed using
+C<next> or C<first> but has not been exhausted or
+L<reset|DBIx::Class::ResultSet/reset>.
+
+For example, this will not work:
+
+  $schema->txn_do(sub {
+    my $rs = $schema->resultset('Book');
+    while (my $row = $rs->next) {
+      $schema->resultset('MetaData')->create({
+        book_id => $row->id,
+        ...
+      });
+    }
+  });
+
+Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
+are not affected, as they use an extra database handle to do the insert.
+
+Some workarounds:
+
+=over 4
+
+=item * use L<DBIx::Class::Storage::DBI::Replicated>
+
+=item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
+
+=item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
+
+=back
+
 =head1 MAXIMUM CONNECTIONS
 
-L<DBD::Sybase> makes separate connections to the server for active statements in
-the background. By default the number of such connections is limited to 25, on
-both the client side and the server side.
+The TDS protocol makes separate connections to the server for active statements
+in the background. By default the number of such connections is limited to 25,
+on both the client side and the server side.
 
-This is a bit too low, so on connection the clientside setting is set to C<256>
-(see L<DBD::Sybase/maxConnect>.) You can override it to whatever setting you
-like in the DSN.
+This is a bit too low for a complex L<DBIx::Class> application, so on connection
+the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
+can override it to whatever setting you like in the DSN.
 
 See
 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
@@ -546,21 +666,29 @@ for information on changing the setting on the server side.
 See L</connect_call_datetime_setup> to setup date formats
 for L<DBIx::Class::InflateColumn::DateTime>.
 
-=head1 IMAGE AND TEXT COLUMNS
+=head1 TEXT/IMAGE COLUMNS
 
 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
 C<TEXT/IMAGE> columns.
 
-C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use:
+Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
+
+  $schema->storage->dbh->do("SET TEXTSIZE $bytes");
 
-  $schema->storage->dbh->do("SET TEXTSIZE <bytes>")
+or
+
+  $schema->storage->set_textsize($bytes);
 
 instead.
 
+However, the C<LongReadLen> you pass in
+L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
+C<SET TEXTSIZE> command on connection.
+
 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
 setting you need to work with C<IMAGE> columns.
 
-=head1 AUTHORS
+=head1 AUTHOR
 
 See L<DBIx::Class/CONTRIBUTORS>.