Try::Tiny conversion finished
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / Sybase.pm
index 677b9f6..9b1214c 100644 (file)
@@ -2,365 +2,129 @@ package DBIx::Class::Storage::DBI::Sybase;
 
 use strict;
 use warnings;
+use Try::Tiny;
 
-use base qw/
-    DBIx::Class::Storage::DBI::Sybase::Base
-    DBIx::Class::Storage::DBI
-/;
-use mro 'c3';
-use Carp::Clan qw/^DBIx::Class/;
+use base qw/DBIx::Class::Storage::DBI/;
 
 =head1 NAME
 
-DBIx::Class::Storage::DBI::Sybase - Storage::DBI subclass for Sybase
-
-=head1 SYNOPSIS
-
-This subclass supports L<DBD::Sybase> for real Sybase databases.  If you are
-using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
-L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
+DBIx::Class::Storage::DBI::Sybase - Base class for drivers using
+L<DBD::Sybase>
 
 =head1 DESCRIPTION
 
-If your version of Sybase does not support placeholders, then your storage
-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 at least version C<1.09> of L<DBD::Sybase> for placeholder support.
-Otherwise your storage will be automatically reblessed into C<::NoBindVars>.
-
-A recommended L<DBIx::Class::Storage::DBI/connect_info> settings:
-
-  on_connect_call => [['datetime_setup'], [blob_setup => log_on_update => 0]]
+This is the base class/dispatcher for Storage's designed to work with
+L<DBD::Sybase>
 
 =head1 METHODS
 
 =cut
 
-__PACKAGE__->mk_group_accessors('simple' =>
-    qw/_blob_log_on_update/
-);
-
 sub _rebless {
   my $self = shift;
 
-  if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
-    my $dbtype = eval {
-      @{$self->dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
-    } || '';
+  my $dbtype;
+  try {
+    $dbtype = @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
+  } catch {
+    $self->throw_exception("Unable to estable connection to determine database type: $_")
+  };
 
-    my $exception = $@;
+  if ($dbtype) {
     $dbtype =~ s/\W/_/gi;
-    my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
 
-    if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
+    # saner class name
+    $dbtype = 'ASE' if $dbtype eq 'SQL_Server';
+
+    my $subclass = __PACKAGE__ . "::$dbtype";
+    if ($self->load_optional_class($subclass)) {
       bless $self, $subclass;
       $self->_rebless;
-    } else { # real Sybase
-      my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
-
-      if (not $self->dbh->{syb_dynamic_supported}) {
-        $self->ensure_class_loaded($no_bind_vars);
-        bless $self, $no_bind_vars;
-        $self->_rebless;
-      }
-      
-      if ($DBD::Sybase::VERSION < 1.09) {
-        carp <<'EOF';
-
-Your version of Sybase potentially supports placeholders and query caching,
-however your version of DBD::Sybase is too old to do this properly. Please
-upgrade to at least version 1.09 if you want this feature.
-
-TEXT/IMAGE column support will also not work in older versions of DBD::Sybase.
-
-See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
-EOF
-        $self->ensure_class_loaded($no_bind_vars);
-        bless $self, $no_bind_vars;
-        $self->_rebless;
-      }
-      $self->_set_maxConnect;
     }
   }
 }
 
-sub _set_maxConnect {
+sub _ping {
   my $self = shift;
 
+  my $dbh = $self->_dbh or return 0;
+
+  local $dbh->{RaiseError} = 1;
+  local $dbh->{PrintError} = 0;
+
+  if ($dbh->{syb_no_child_con}) {
+# if extra connections are not allowed, then ->ping is reliable
+    return try { $dbh->ping } catch { 0; };
+  }
+
+  return try {
+# XXX if the main connection goes stale, does opening another for this statement
+# really determine anything?
+    $dbh->do('select 1');
+    1;
+  } catch {
+    0;
+  };
+}
+
+sub _set_max_connect {
+  my $self = shift;
+  my $val  = shift || 256;
+
   my $dsn = $self->_dbi_connect_info->[0];
 
   return if ref($dsn) eq 'CODE';
 
   if ($dsn !~ /maxConnect=/) {
-    $self->_dbi_connect_info->[0] = "$dsn;maxConnect=256";
+    $self->_dbi_connect_info->[0] = "$dsn;maxConnect=$val";
     my $connected = defined $self->_dbh;
     $self->disconnect;
     $self->ensure_connected if $connected;
   }
 }
 
-=head2 connect_call_blob_setup
-
-Used as:
+=head2 using_freetds
 
-  on_connect_call => [ [ blob_setup => log_on_update => 0 ] ]
-
-Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
-instead of as a hex string.
-
-Recommended.
-
-Also sets the C<log_on_update> value for blob write operations. The default is
-C<1>, but C<0> is better if your database is configured for it.
-
-See
-L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
+Whether or not L<DBD::Sybase> was compiled against FreeTDS. If false, it means
+the Sybase OpenClient libraries were used.
 
 =cut
 
-sub connect_call_blob_setup {
+sub using_freetds {
   my $self = shift;
-  my %args = @_;
-  my $dbh = $self->_dbh;
-  $dbh->{syb_binary_images} = 1;
-
-  $self->_blob_log_on_update($args{log_on_update})
-    if exists $args{log_on_update};
-}
 
-sub _is_lob_type {
-  my $self = shift;
-  my $type = shift;
-  $type && $type =~ /(?:text|image|lob|bytea|binary)/i;
+  return $self->_get_dbh->{syb_oc_version} =~ /freetds/i;
 }
 
-## This will be useful if we ever implement BLOB filehandle inflation and will
-## need to use the API, but for now it isn't.
-#
-#sub order_columns_for_select {
-#  my ($self, $source) = @_;
-#
-#  my (@non_blobs, @blobs);
-#
-#  for my $col ($source->columns) {
-#    if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
-#      push @blobs, $col;
-#    } else {
-#      push @non_blobs, $col;
-#    }
-#  }
-#
-#  croak "cannot select more than a one TEXT/IMAGE column at a time"
-#    if @blobs > 1;
-#
-#  return (@non_blobs, @blobs);
-#}
-
-# override to handle TEXT/IMAGE
-sub insert {
-  my ($self, $source, $to_insert) = splice @_, 0, 3;
-
-  my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
-
-  my $updated_cols = $self->next::method($source, $to_insert, @_);
-
-  $self->_update_blobs($source, $blob_cols, $to_insert) if %$blob_cols;
-
-  return $updated_cols;
-}
+=head2 set_textsize
 
-#sub update {
-#  my ($self, $source) = splice @_, 0, 2;
-#  my ($fields)        = @_;
-#
-#  my $blob_cols = $self->_remove_blob_cols($source, $fields);
-#
-#  my @res = 1;
-#
-#  if (%$fields) {
-#    if (wantarray) {
-#      @res    = $self->next::method($source, @_);
-#    } else {
-#      $res[0] = $self->next::method($source, @_);
-#    }
-#  }
-#
-#  $self->_update_blobs($source, $blob_cols, $fields) if %$blob_cols;
-#
-#  return wantarray ? @res : $res[0];
-#}
-
-sub _remove_blob_cols {
-  my ($self, $source, $fields) = @_;
-
-  my %blob_cols;
-
-  for my $col (keys %$fields) {
-    if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
-      $blob_cols{$col} = delete $fields->{$col};
-      $fields->{$col} = \"''";
-    }
-  }
-
-  return \%blob_cols;
-}
-
-sub _update_blobs {
-  my ($self, $source, $blob_cols, $inserted) = @_;
-  my $dbh = $self->dbh;
-
-  my $table = $source->from;
-
-  my %inserted = %$inserted;
-  my (@primary_cols) = $source->primary_columns;
-
-  croak "Cannot update TEXT/IMAGE column(s) without a primary key"
-    unless @primary_cols;
-
-  if ((grep { defined $inserted{$_} } @primary_cols) != @primary_cols) {
-    if (@primary_cols == 1) {
-      my $col = $primary_cols[0];
-      $inserted{$col} = $self->last_insert_id($source, $col);
-    } else {
-      croak "Cannot update TEXT/IMAGE column(s) without primary key values";
-    }
-  }
+When using FreeTDS and/or MSSQL, C<< $dbh->{LongReadLen} >> is not available,
+use this function instead. It does:
 
-  for my $col (keys %$blob_cols) {
-    my $blob = $blob_cols->{$col};
-    my $sth;
+  $dbh->do("SET TEXTSIZE $bytes");
 
-    if (not $self->isa('DBIx::Class::Storage::DBI::NoBindVars')) {
-      my $search_cond = join ',' => map "$_ = ?", @primary_cols;
-
-      $sth = $self->sth(
-        "select $col from $table where $search_cond"
-      );
-      $sth->execute(map $inserted{$_}, @primary_cols);
-    } else {
-      my $search_cond = join ',' => map "$_ = $inserted{$_}", @primary_cols;
-
-      $sth = $dbh->prepare(
-        "select $col from $table where $search_cond"
-      );
-      $sth->execute;
-    }
-
-    eval {
-      while ($sth->fetch) {
-        $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
-      }
-      $sth->func('ct_prepare_send') or die $sth->errstr;
-
-      my $log_on_update = $self->_blob_log_on_update;
-      $log_on_update    = 1 if not defined $log_on_update;
-
-      $sth->func('CS_SET', 1, {
-        total_txtlen => length($blob),
-        log_on_update => $log_on_update
-      }, 'ct_data_info') or die $sth->errstr;
-
-      $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
-
-      $sth->func('ct_finish_send') or die $sth->errstr;
-    };
-    my $exception = $@;
-    $sth->finish;
-    croak $exception if $exception;
-  }
-}
-
-=head2 connect_call_datetime_setup
-
-Used as:
-
-  on_connect_call => 'datetime_setup'
-
-In L<DBIx::Class::Storage::DBI/connect_info> to set:
-
-  $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
-  $dbh->do('set dateformat mdy');   # input fmt:  08/13/1979 18:08:55.080
-
-On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
-L<DateTime::Format::Sybase>, which you will need to install.
-
-This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
-C<SMALLDATETIME> columns only have minute precision.
+Takes the number of bytes, or uses the C<LongReadLen> value from your
+L<connect_info|DBIx::Class::Storage::DBI/connect_info> if omitted, lastly falls
+back to the C<32768> which is the L<DBD::Sybase> default.
 
 =cut
 
-{
-  my $old_dbd_warned = 0;
-
-  sub connect_call_datetime_setup {
-    my $self = shift;
-    my $dbh = $self->_dbh;
-
-    if ($dbh->can('syb_date_fmt')) {
-      $dbh->syb_date_fmt('ISO_strict');
-    } elsif (not $old_dbd_warned) {
-      carp "Your DBD::Sybase is too old to support ".
-      "DBIx::Class::InflateColumn::DateTime, please upgrade!";
-      $old_dbd_warned = 1;
-    }
-
-    $dbh->do('set dateformat mdy');
-
-    1;
-  }
-}
-
-sub datetime_parser_type { "DateTime::Format::Sybase" }
+sub set_textsize {
+  my $self = shift;
+  my $text_size =
+    shift
+      ||
+    try { $self->_dbi_connect_info->[-1]->{LongReadLen} }
+      ||
+    32768; # the DBD::Sybase default
 
-sub _dbh_last_insert_id {
-  my ($self, $dbh, $source, $col) = @_;
+  return unless defined $text_size;
 
-  # sorry, there's no other way!
-  my $sth = $dbh->prepare_cached("select max($col) from ".$source->from);
-  return ($dbh->selectrow_array($sth))[0];
+  $self->_dbh->do("SET TEXTSIZE $text_size");
 }
 
 1;
 
-=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.
-
-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.
-
-See
-L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
-for information on changing the setting on the server side.
-
-=head1 DATES
-
-See L</connect_call_datetime_setup> to setup date formats
-for L<DBIx::Class::InflateColumn::DateTime>.
-
-=head1 IMAGE AND TEXT COLUMNS
-
-You need at least version C<1.09> of L<DBD::Sybase> for C<TEXT/IMAGE> column
-support.
-
-See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
-setting you need to work with C<IMAGE> columns.
-
-Due to limitations in L<DBD::Sybase> and this driver, it is only possible to
-select one C<TEXT> or C<IMAGE> column at a time. This is handled automatically
-for tables with only one such column, if you have more than one, supply a
-C<< select => [qw/col list .../] >> key to your C<< ->search >> calls, with the
-single desired C<TEXT/IMAGE> column at the end of the list.
-
 =head1 AUTHORS
 
 See L<DBIx::Class/CONTRIBUTORS>.
@@ -370,4 +134,3 @@ See L<DBIx::Class/CONTRIBUTORS>.
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-# vim:sts=2 sw=2: