lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm

   1 package DBIx::Class::Storage::DBI::Sybase::ASE;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base qw/
   7     DBIx::Class::Storage::DBI::Sybase
   8     DBIx::Class::Storage::DBI::AutoCast
   9 /;
  10 use mro 'c3';
  11 use Carp::Clan qw/^DBIx::Class/;
  12 use Scalar::Util 'blessed';
  13 use List::Util 'first';
  14 use Sub::Name();
  15 use Data::Dumper::Concise 'Dumper';
  16 use Try::Tiny;
  17 use namespace::clean;
  18
  19 __PACKAGE__->sql_limit_dialect ('RowCountOrGenericSubQ');
  20 __PACKAGE__->sql_quote_char ([qw/[ ]/]);
  21
  22 __PACKAGE__->mk_group_accessors('simple' =>
  23     qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
  24        _bulk_storage _is_bulk_storage _began_bulk_work
  25        _bulk_disabled_due_to_coderef_connect_info_warned
  26        _identity_method/
  27 );
  28
  29 my @also_proxy_to_extra_storages = qw/
  30   connect_call_set_auto_cast auto_cast connect_call_blob_setup
  31   connect_call_datetime_setup
  32
  33   disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
  34   auto_savepoint unsafe cursor_class debug debugobj schema
  35 /;
  36
  37 =head1 NAME
  38
  39 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
  40 DBIx::Class
  41
  42 =head1 SYNOPSIS
  43
  44 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
  45
  46 =head1 DESCRIPTION
  47
  48 If your version of Sybase does not support placeholders, then your storage will
  49 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
  50 You can also enable that driver explicitly, see the documentation for more
  51 details.
  52
  53 With this driver there is unfortunately no way to get the C<last_insert_id>
  54 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
  55 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
  56
  57 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
  58
  59   on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
  60
  61 =head1 METHODS
  62
  63 =cut
  64
  65 sub _rebless {
  66   my $self = shift;
  67
  68   my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
  69
  70   if ($self->using_freetds) {
  71     carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
  72
  73 You are using FreeTDS with Sybase.
  74
  75 We will do our best to support this configuration, but please consider this
  76 support experimental.
  77
  78 TEXT/IMAGE columns will definitely not work.
  79
  80 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
  81 instead.
  82
  83 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
  84
  85 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
  86 variable.
  87 EOF
  88
  89     if (not $self->_use_typeless_placeholders) {
  90       if ($self->_use_placeholders) {
  91         $self->auto_cast(1);
  92       }
  93       else {
  94         $self->ensure_class_loaded($no_bind_vars);
  95         bless $self, $no_bind_vars;
  96         $self->_rebless;
  97       }
  98     }
  99   }
 100
 101   elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
 102     # not necessarily FreeTDS, but no placeholders nevertheless
 103     $self->ensure_class_loaded($no_bind_vars);
 104     bless $self, $no_bind_vars;
 105     $self->_rebless;
 106   }
 107   # this is highly unlikely, but we check just in case
 108   elsif (not $self->_use_typeless_placeholders) {
 109     $self->auto_cast(1);
 110   }
 111 }
 112
 113 sub _init {
 114   my $self = shift;
 115   $self->_set_max_connect(256);
 116
 117 # create storage for insert/(update blob) transactions,
 118 # unless this is that storage
 119   return if $self->_is_extra_storage;
 120
 121   my $writer_storage = (ref $self)->new;
 122
 123   $writer_storage->_is_extra_storage(1);
 124   $writer_storage->connect_info($self->connect_info);
 125   $writer_storage->auto_cast($self->auto_cast);
 126
 127   $self->_writer_storage($writer_storage);
 128
 129 # create a bulk storage unless connect_info is a coderef
 130   return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
 131
 132   my $bulk_storage = (ref $self)->new;
 133
 134   $bulk_storage->_is_extra_storage(1);
 135   $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
 136   $bulk_storage->connect_info($self->connect_info);
 137
 138 # this is why
 139   $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
 140
 141   $self->_bulk_storage($bulk_storage);
 142 }
 143
 144 for my $method (@also_proxy_to_extra_storages) {
 145   no strict 'refs';
 146   no warnings 'redefine';
 147
 148   my $replaced = __PACKAGE__->can($method);
 149
 150   *{$method} = Sub::Name::subname $method => sub {
 151     my $self = shift;
 152     $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
 153     $self->_bulk_storage->$replaced(@_)   if $self->_bulk_storage;
 154     return $self->$replaced(@_);
 155   };
 156 }
 157
 158 sub disconnect {
 159   my $self = shift;
 160
 161 # Even though we call $sth->finish for uses off the bulk API, there's still an
 162 # "active statement" warning on disconnect, which we throw away here.
 163 # This is due to the bug described in insert_bulk.
 164 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
 165   local $SIG{__WARN__} = sub {
 166     warn $_[0] unless $_[0] =~ /active statement/i;
 167   } if $self->_is_bulk_storage;
 168
 169 # so that next transaction gets a dbh
 170   $self->_began_bulk_work(0) if $self->_is_bulk_storage;
 171
 172   $self->next::method;
 173 }
 174
 175 # Set up session settings for Sybase databases for the connection.
 176 #
 177 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
 178 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
 179 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
 180 # only want when AutoCommit is off.
 181 #
 182 # Also SET TEXTSIZE for FreeTDS because LongReadLen doesn't work.
 183 sub _run_connection_actions {
 184   my $self = shift;
 185
 186   if ($self->_is_bulk_storage) {
 187 # this should be cleared on every reconnect
 188     $self->_began_bulk_work(0);
 189     return;
 190   }
 191
 192   if (not $self->using_freetds) {
 193     $self->_dbh->{syb_chained_txn} = 1;
 194   } else {
 195     # based on LongReadLen in connect_info
 196     $self->set_textsize;
 197
 198     if ($self->_dbh_autocommit) {
 199       $self->_dbh->do('SET CHAINED OFF');
 200     } else {
 201       $self->_dbh->do('SET CHAINED ON');
 202     }
 203   }
 204
 205   $self->next::method(@_);
 206 }
 207
 208 =head2 connect_call_blob_setup
 209
 210 Used as:
 211
 212   on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
 213
 214 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
 215 instead of as a hex string.
 216
 217 Recommended.
 218
 219 Also sets the C<log_on_update> value for blob write operations. The default is
 220 C<1>, but C<0> is better if your database is configured for it.
 221
 222 See
 223 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
 224
 225 =cut
 226
 227 sub connect_call_blob_setup {
 228   my $self = shift;
 229   my %args = @_;
 230   my $dbh = $self->_dbh;
 231   $dbh->{syb_binary_images} = 1;
 232
 233   $self->_blob_log_on_update($args{log_on_update})
 234     if exists $args{log_on_update};
 235 }
 236
 237 sub _is_lob_column {
 238   my ($self, $source, $column) = @_;
 239
 240   return $self->_is_lob_type($source->column_info($column)->{data_type});
 241 }
 242
 243 sub _prep_for_execute {
 244   my $self = shift;
 245   my ($op, $extra_bind, $ident, $args) = @_;
 246
 247   my ($sql, $bind) = $self->next::method (@_);
 248
 249   my $table = blessed $ident ? $ident->from : $ident;
 250
 251   my $bind_info = $self->_resolve_column_info(
 252     $ident, [map $_->[0], @{$bind}]
 253   );
 254   my $bound_identity_col =
 255     first { $bind_info->{$_}{is_auto_increment} }
 256     keys %$bind_info
 257   ;
 258
 259   my $columns_info = blessed $ident && $ident->columns_info;
 260
 261   my $identity_col =
 262     $columns_info &&
 263     first { $columns_info->{$_}{is_auto_increment} }
 264       keys %$columns_info
 265   ;
 266
 267   if (($op eq 'insert' && $bound_identity_col) ||
 268       ($op eq 'update' && exists $args->[0]{$identity_col})) {
 269     $sql = join ("\n",
 270       $self->_set_table_identity_sql($op => $table, 'on'),
 271       $sql,
 272       $self->_set_table_identity_sql($op => $table, 'off'),
 273     );
 274   }
 275
 276   if ($op eq 'insert' && (not $bound_identity_col) && $identity_col &&
 277       (not $self->{insert_bulk})) {
 278     $sql =
 279       "$sql\n" .
 280       $self->_fetch_identity_sql($ident, $identity_col);
 281   }
 282
 283   return ($sql, $bind);
 284 }
 285
 286 sub _set_table_identity_sql {
 287   my ($self, $op, $table, $on_off) = @_;
 288
 289   return sprintf 'SET IDENTITY_%s %s %s',
 290     uc($op), $self->sql_maker->_quote($table), uc($on_off);
 291 }
 292
 293 # Stolen from SQLT, with some modifications. This is a makeshift
 294 # solution before a sane type-mapping library is available, thus
 295 # the 'our' for easy overrides.
 296 our %TYPE_MAPPING  = (
 297     number    => 'numeric',
 298     money     => 'money',
 299     varchar   => 'varchar',
 300     varchar2  => 'varchar',
 301     timestamp => 'datetime',
 302     text      => 'varchar',
 303     real      => 'double precision',
 304     comment   => 'text',
 305     bit       => 'bit',
 306     tinyint   => 'smallint',
 307     float     => 'double precision',
 308     serial    => 'numeric',
 309     bigserial => 'numeric',
 310     boolean   => 'varchar',
 311     long      => 'varchar',
 312 );
 313
 314 sub _native_data_type {
 315   my ($self, $type) = @_;
 316
 317   $type = lc $type;
 318   $type =~ s/\s* identity//x;
 319
 320   return uc($TYPE_MAPPING{$type} || $type);
 321 }
 322
 323 sub _fetch_identity_sql {
 324   my ($self, $source, $col) = @_;
 325
 326   return sprintf ("SELECT MAX(%s) FROM %s",
 327     map { $self->sql_maker->_quote ($_) } ($col, $source->from)
 328   );
 329 }
 330
 331 sub _execute {
 332   my $self = shift;
 333   my ($op) = @_;
 334
 335   my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
 336
 337   if ($op eq 'insert') {
 338     $self->_identity($sth->fetchrow_array);
 339     $sth->finish;
 340   }
 341
 342   return wantarray ? ($rv, $sth, @bind) : $rv;
 343 }
 344
 345 sub last_insert_id { shift->_identity }
 346
 347 # handles TEXT/IMAGE and transaction for last_insert_id
 348 sub insert {
 349   my $self = shift;
 350   my ($source, $to_insert) = @_;
 351
 352   my $columns_info = $source->columns_info;
 353
 354   my $identity_col =
 355     (first { $columns_info->{$_}{is_auto_increment} }
 356       keys %$columns_info )
 357     || '';
 358
 359   # check for empty insert
 360   # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
 361   # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
 362   # and computed columns)
 363   if (not %$to_insert) {
 364     for my $col ($source->columns) {
 365       next if $col eq $identity_col;
 366
 367       my $info = $source->column_info($col);
 368
 369       next if ref $info->{default_value} eq 'SCALAR'
 370         || (exists $info->{data_type} && (not defined $info->{data_type}));
 371
 372       next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
 373
 374       $to_insert->{$col} = \'DEFAULT';
 375     }
 376   }
 377
 378   my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
 379
 380   # do we need the horrific SELECT MAX(COL) hack?
 381   my $dumb_last_insert_id =
 382        $identity_col
 383     && (not exists $to_insert->{$identity_col})
 384     && ($self->_identity_method||'') ne '@@IDENTITY';
 385
 386   my $next = $self->next::can;
 387
 388   # we are already in a transaction, or there are no blobs
 389   # and we don't need the PK - just (try to) do it
 390   if ($self->{transaction_depth}
 391         || (!$blob_cols && !$dumb_last_insert_id)
 392   ) {
 393     return $self->_insert (
 394       $next, $source, $to_insert, $blob_cols, $identity_col
 395     );
 396   }
 397
 398   # otherwise use the _writer_storage to do the insert+transaction on another
 399   # connection
 400   my $guard = $self->_writer_storage->txn_scope_guard;
 401
 402   my $updated_cols = $self->_writer_storage->_insert (
 403     $next, $source, $to_insert, $blob_cols, $identity_col
 404   );
 405
 406   $self->_identity($self->_writer_storage->_identity);
 407
 408   $guard->commit;
 409
 410   return $updated_cols;
 411 }
 412
 413 sub _insert {
 414   my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
 415
 416   my $updated_cols = $self->$next ($source, $to_insert);
 417
 418   my $final_row = {
 419     ($identity_col ?
 420       ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
 421     %$to_insert,
 422     %$updated_cols,
 423   };
 424
 425   $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
 426
 427   return $updated_cols;
 428 }
 429
 430 sub update {
 431   my $self = shift;
 432   my ($source, $fields, $where, @rest) = @_;
 433
 434   my $blob_cols = $self->_remove_blob_cols($source, $fields);
 435
 436   my $table = $source->name;
 437
 438   my $columns_info = $source->columns_info;
 439
 440   my $identity_col =
 441     first { $columns_info->{$_}{is_auto_increment} }
 442       keys %$columns_info;
 443
 444   my $is_identity_update = $identity_col && defined $fields->{$identity_col};
 445
 446   return $self->next::method(@_) unless $blob_cols;
 447
 448 # If there are any blobs in $where, Sybase will return a descriptive error
 449 # message.
 450 # XXX blobs can still be used with a LIKE query, and this should be handled.
 451
 452 # update+blob update(s) done atomically on separate connection
 453   $self = $self->_writer_storage;
 454
 455   my $guard = $self->txn_scope_guard;
 456
 457 # First update the blob columns to be updated to '' (taken from $fields, where
 458 # it is originally put by _remove_blob_cols .)
 459   my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
 460
 461 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
 462
 463   $self->next::method($source, \%blobs_to_empty, $where, @rest);
 464
 465 # Now update the blobs before the other columns in case the update of other
 466 # columns makes the search condition invalid.
 467   $self->_update_blobs($source, $blob_cols, $where);
 468
 469   my @res;
 470   if (%$fields) {
 471     if (wantarray) {
 472       @res    = $self->next::method(@_);
 473     }
 474     elsif (defined wantarray) {
 475       $res[0] = $self->next::method(@_);
 476     }
 477     else {
 478       $self->next::method(@_);
 479     }
 480   }
 481
 482   $guard->commit;
 483
 484   return wantarray ? @res : $res[0];
 485 }
 486
 487 sub insert_bulk {
 488   my $self = shift;
 489   my ($source, $cols, $data) = @_;
 490
 491   my $columns_info = $source->columns_info;
 492
 493   my $identity_col =
 494     first { $columns_info->{$_}{is_auto_increment} }
 495       keys %$columns_info;
 496
 497   my $is_identity_insert = (first { $_ eq $identity_col } @{$cols}) ? 1 : 0;
 498
 499   my @source_columns = $source->columns;
 500
 501   my $use_bulk_api =
 502     $self->_bulk_storage &&
 503     $self->_get_dbh->{syb_has_blk};
 504
 505   if ((not $use_bulk_api)
 506         &&
 507       (ref($self->_dbi_connect_info->[0]) eq 'CODE')
 508         &&
 509       (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
 510     carp <<'EOF';
 511 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
 512 regular array inserts.
 513 EOF
 514     $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
 515   }
 516
 517   if (not $use_bulk_api) {
 518     my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
 519
 520 # _execute_array uses a txn anyway, but it ends too early in case we need to
 521 # select max(col) to get the identity for inserting blobs.
 522     ($self, my $guard) = $self->{transaction_depth} == 0 ?
 523       ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
 524       :
 525       ($self, undef);
 526
 527     local $self->{insert_bulk} = 1;
 528
 529     $self->next::method(@_);
 530
 531     if ($blob_cols) {
 532       if ($is_identity_insert) {
 533         $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
 534       }
 535       else {
 536         my @cols_with_identities = (@$cols, $identity_col);
 537
 538         ## calculate identities
 539         # XXX This assumes identities always increase by 1, which may or may not
 540         # be true.
 541         my ($last_identity) =
 542           $self->_dbh->selectrow_array (
 543             $self->_fetch_identity_sql($source, $identity_col)
 544           );
 545         my @identities = (($last_identity - @$data + 1) .. $last_identity);
 546
 547         my @data_with_identities = map [@$_, shift @identities], @$data;
 548
 549         $self->_insert_blobs_array (
 550           $source, $blob_cols, \@cols_with_identities, \@data_with_identities
 551         );
 552       }
 553     }
 554
 555     $guard->commit if $guard;
 556
 557     return;
 558   }
 559
 560 # otherwise, use the bulk API
 561
 562 # rearrange @$data so that columns are in database order
 563   my %orig_idx;
 564   @orig_idx{@$cols} = 0..$#$cols;
 565
 566   my %new_idx;
 567   @new_idx{@source_columns} = 0..$#source_columns;
 568
 569   my @new_data;
 570   for my $datum (@$data) {
 571     my $new_datum = [];
 572     for my $col (@source_columns) {
 573 # identity data will be 'undef' if not $is_identity_insert
 574 # columns with defaults will also be 'undef'
 575       $new_datum->[ $new_idx{$col} ] =
 576         exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
 577     }
 578     push @new_data, $new_datum;
 579   }
 580
 581 # bcp identity index is 1-based
 582   my $identity_idx = exists $new_idx{$identity_col} ?
 583     $new_idx{$identity_col} + 1 : 0;
 584
 585 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
 586 # This ignores any data conversion errors detected by the client side libs, as
 587 # they are usually harmless.
 588   my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
 589     Sub::Name::subname insert_bulk => sub {
 590       my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
 591
 592       return 1 if $errno == 36;
 593
 594       carp
 595         "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
 596         ($errmsg ? "\n$errmsg" : '') .
 597         ($osmsg  ? "\n$osmsg"  : '')  .
 598         ($blkmsg ? "\n$blkmsg" : '');
 599
 600       return 0;
 601   });
 602
 603   my $exception = '';
 604   try {
 605     my $bulk = $self->_bulk_storage;
 606
 607     my $guard = $bulk->txn_scope_guard;
 608
 609 ## XXX get this to work instead of our own $sth
 610 ## will require SQLA or *Hacks changes for ordered columns
 611 #    $bulk->next::method($source, \@source_columns, \@new_data, {
 612 #      syb_bcp_attribs => {
 613 #        identity_flag   => $is_identity_insert,
 614 #        identity_column => $identity_idx,
 615 #      }
 616 #    });
 617     my $sql = 'INSERT INTO ' .
 618       $bulk->sql_maker->_quote($source->name) . ' (' .
 619 # colname list is ignored for BCP, but does no harm
 620       (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
 621       ' VALUES ('.  (join ', ', ('?') x @source_columns) . ')';
 622
 623 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
 624 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
 625 ## better yet the version above. Should be fixed in DBD::Sybase .
 626     my $sth = $bulk->_get_dbh->prepare($sql,
 627 #      'insert', # op
 628       {
 629         syb_bcp_attribs => {
 630           identity_flag   => $is_identity_insert,
 631           identity_column => $identity_idx,
 632         }
 633       }
 634     );
 635
 636     my @bind = do {
 637       my $idx = 0;
 638       map [ $_, $idx++ ], @source_columns;
 639     };
 640
 641     $self->_execute_array(
 642       $source, $sth, \@bind, \@source_columns, \@new_data, sub {
 643         $guard->commit
 644       }
 645     );
 646
 647     $bulk->_query_end($sql);
 648   } catch {
 649     $exception = shift;
 650   };
 651
 652   DBD::Sybase::set_cslib_cb($orig_cslib_cb);
 653
 654   if ($exception =~ /-Y option/) {
 655     my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
 656           . 'reverting to regular array inserts. Try unsetting the LANG environment variable'
 657     ;
 658     $w .= "\n$exception" if $self->debug;
 659     carp $w;
 660
 661     $self->_bulk_storage(undef);
 662     unshift @_, $self;
 663     goto \&insert_bulk;
 664   }
 665   elsif ($exception) {
 666 # rollback makes the bulkLogin connection unusable
 667     $self->_bulk_storage->disconnect;
 668     $self->throw_exception($exception);
 669   }
 670 }
 671
 672 sub _dbh_execute_array {
 673   my ($self, $sth, $tuple_status, $cb) = @_;
 674
 675   my $rv = $self->next::method($sth, $tuple_status);
 676   $cb->() if $cb;
 677
 678   return $rv;
 679 }
 680
 681 # Make sure blobs are not bound as placeholders, and return any non-empty ones
 682 # as a hash.
 683 sub _remove_blob_cols {
 684   my ($self, $source, $fields) = @_;
 685
 686   my %blob_cols;
 687
 688   for my $col (keys %$fields) {
 689     if ($self->_is_lob_column($source, $col)) {
 690       my $blob_val = delete $fields->{$col};
 691       if (not defined $blob_val) {
 692         $fields->{$col} = \'NULL';
 693       }
 694       else {
 695         $fields->{$col} = \"''";
 696         $blob_cols{$col} = $blob_val unless $blob_val eq '';
 697       }
 698     }
 699   }
 700
 701   return %blob_cols ? \%blob_cols : undef;
 702 }
 703
 704 # same for insert_bulk
 705 sub _remove_blob_cols_array {
 706   my ($self, $source, $cols, $data) = @_;
 707
 708   my @blob_cols;
 709
 710   for my $i (0..$#$cols) {
 711     my $col = $cols->[$i];
 712
 713     if ($self->_is_lob_column($source, $col)) {
 714       for my $j (0..$#$data) {
 715         my $blob_val = delete $data->[$j][$i];
 716         if (not defined $blob_val) {
 717           $data->[$j][$i] = \'NULL';
 718         }
 719         else {
 720           $data->[$j][$i] = \"''";
 721           $blob_cols[$j][$i] = $blob_val
 722             unless $blob_val eq '';
 723         }
 724       }
 725     }
 726   }
 727
 728   return @blob_cols ? \@blob_cols : undef;
 729 }
 730
 731 sub _update_blobs {
 732   my ($self, $source, $blob_cols, $where) = @_;
 733
 734   my @primary_cols = try
 735     { $source->_pri_cols }
 736     catch {
 737       $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
 738     };
 739
 740 # check if we're updating a single row by PK
 741   my $pk_cols_in_where = 0;
 742   for my $col (@primary_cols) {
 743     $pk_cols_in_where++ if defined $where->{$col};
 744   }
 745   my @rows;
 746
 747   if ($pk_cols_in_where == @primary_cols) {
 748     my %row_to_update;
 749     @row_to_update{@primary_cols} = @{$where}{@primary_cols};
 750     @rows = \%row_to_update;
 751   } else {
 752     my $cursor = $self->select ($source, \@primary_cols, $where, {});
 753     @rows = map {
 754       my %row; @row{@primary_cols} = @$_; \%row
 755     } $cursor->all;
 756   }
 757
 758   for my $row (@rows) {
 759     $self->_insert_blobs($source, $blob_cols, $row);
 760   }
 761 }
 762
 763 sub _insert_blobs {
 764   my ($self, $source, $blob_cols, $row) = @_;
 765   my $dbh = $self->_get_dbh;
 766
 767   my $table = $source->name;
 768
 769   my %row = %$row;
 770   my @primary_cols = try
 771     { $source->_pri_cols }
 772     catch {
 773       $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
 774     };
 775
 776   $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
 777     if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
 778
 779   for my $col (keys %$blob_cols) {
 780     my $blob = $blob_cols->{$col};
 781
 782     my %where = map { ($_, $row{$_}) } @primary_cols;
 783
 784     my $cursor = $self->select ($source, [$col], \%where, {});
 785     $cursor->next;
 786     my $sth = $cursor->sth;
 787
 788     if (not $sth) {
 789       $self->throw_exception(
 790           "Could not find row in table '$table' for blob update:\n"
 791         . (Dumper \%where)
 792       );
 793     }
 794
 795     try {
 796       do {
 797         $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
 798       } while $sth->fetch;
 799
 800       $sth->func('ct_prepare_send') or die $sth->errstr;
 801
 802       my $log_on_update = $self->_blob_log_on_update;
 803       $log_on_update    = 1 if not defined $log_on_update;
 804
 805       $sth->func('CS_SET', 1, {
 806         total_txtlen => length($blob),
 807         log_on_update => $log_on_update
 808       }, 'ct_data_info') or die $sth->errstr;
 809
 810       $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
 811
 812       $sth->func('ct_finish_send') or die $sth->errstr;
 813     }
 814     catch {
 815       if ($self->using_freetds) {
 816         $self->throw_exception (
 817           "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
 818         );
 819       }
 820       else {
 821         $self->throw_exception($_);
 822       }
 823     }
 824     finally {
 825       $sth->finish if $sth;
 826     };
 827   }
 828 }
 829
 830 sub _insert_blobs_array {
 831   my ($self, $source, $blob_cols, $cols, $data) = @_;
 832
 833   for my $i (0..$#$data) {
 834     my $datum = $data->[$i];
 835
 836     my %row;
 837     @row{ @$cols } = @$datum;
 838
 839     my %blob_vals;
 840     for my $j (0..$#$cols) {
 841       if (exists $blob_cols->[$i][$j]) {
 842         $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
 843       }
 844     }
 845
 846     $self->_insert_blobs ($source, \%blob_vals, \%row);
 847   }
 848 }
 849
 850 =head2 connect_call_datetime_setup
 851
 852 Used as:
 853
 854   on_connect_call => 'datetime_setup'
 855
 856 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
 857
 858   $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
 859   $dbh->do('set dateformat mdy');   # input fmt:  08/13/1979 18:08:55.080
 860
 861 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
 862 L<DateTime::Format::Sybase>, which you will need to install.
 863
 864 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
 865 C<SMALLDATETIME> columns only have minute precision.
 866
 867 =cut
 868
 869 {
 870   my $old_dbd_warned = 0;
 871
 872   sub connect_call_datetime_setup {
 873     my $self = shift;
 874     my $dbh = $self->_get_dbh;
 875
 876     if ($dbh->can('syb_date_fmt')) {
 877       # amazingly, this works with FreeTDS
 878       $dbh->syb_date_fmt('ISO_strict');
 879     } elsif (not $old_dbd_warned) {
 880       carp "Your DBD::Sybase is too old to support ".
 881       "DBIx::Class::InflateColumn::DateTime, please upgrade!";
 882       $old_dbd_warned = 1;
 883     }
 884
 885     $dbh->do('SET DATEFORMAT mdy');
 886
 887     1;
 888   }
 889 }
 890
 891 sub datetime_parser_type { "DateTime::Format::Sybase" }
 892
 893 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
 894 # let the DBD keep any state it needs to.
 895 #
 896 # If they ever do start working, the extra statements will do no harm (because
 897 # Sybase supports nested transactions.)
 898
 899 sub _dbh_begin_work {
 900   my $self = shift;
 901
 902 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
 903 # TRAN once. However, we need to make sure there's a $dbh.
 904   return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
 905
 906   $self->next::method(@_);
 907
 908   if ($self->using_freetds) {
 909     $self->_get_dbh->do('BEGIN TRAN');
 910   }
 911
 912   $self->_began_bulk_work(1) if $self->_is_bulk_storage;
 913 }
 914
 915 sub _dbh_commit {
 916   my $self = shift;
 917   if ($self->using_freetds) {
 918     $self->_dbh->do('COMMIT');
 919   }
 920   return $self->next::method(@_);
 921 }
 922
 923 sub _dbh_rollback {
 924   my $self = shift;
 925   if ($self->using_freetds) {
 926     $self->_dbh->do('ROLLBACK');
 927   }
 928   return $self->next::method(@_);
 929 }
 930
 931 # savepoint support using ASE syntax
 932
 933 sub _svp_begin {
 934   my ($self, $name) = @_;
 935
 936   $self->_get_dbh->do("SAVE TRANSACTION $name");
 937 }
 938
 939 # A new SAVE TRANSACTION with the same name releases the previous one.
 940 sub _svp_release { 1 }
 941
 942 sub _svp_rollback {
 943   my ($self, $name) = @_;
 944
 945   $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
 946 }
 947
 948 1;
 949
 950 =head1 Schema::Loader Support
 951
 952 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
 953 most (if not all) versions of Sybase ASE.
 954
 955 =head1 FreeTDS
 956
 957 This driver supports L<DBD::Sybase> compiled against FreeTDS
 958 (L<http://www.freetds.org/>) to the best of our ability, however it is
 959 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
 960 libraries. They are a part of the Sybase ASE distribution:
 961
 962 The Open Client FAQ is here:
 963 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
 964
 965 Sybase ASE for Linux (which comes with the Open Client libraries) may be
 966 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
 967
 968 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
 969
 970   perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
 971
 972 Some versions of the libraries involved will not support placeholders, in which
 973 case the storage will be reblessed to
 974 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
 975
 976 In some configurations, placeholders will work but will throw implicit type
 977 conversion errors for anything that's not expecting a string. In such a case,
 978 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
 979 automatically set, which you may enable on connection with
 980 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
 981 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
 982 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
 983 already) using a mapping based on L<SQL::Translator>.
 984
 985 In other configurations, placeholders will work just as they do with the Sybase
 986 Open Client libraries.
 987
 988 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
 989
 990 =head1 INSERTS WITH PLACEHOLDERS
 991
 992 With placeholders enabled, inserts are done in a transaction so that there are
 993 no concurrency issues with getting the inserted identity value using
 994 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
 995 mode.
 996
 997 In addition, they are done on a separate connection so that it's possible to
 998 have active cursors when doing an insert.
 999
1000 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
1001 are disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as
1002 it's a session variable.
1003
1004 =head1 TRANSACTIONS
1005
1006 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both, you cannot
1007 begin a transaction while there are active cursors, nor can you use multiple
1008 active cursors within a transaction. An active cursor is, for example, a
1009 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1010 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1011
1012 For example, this will not work:
1013
1014   $schema->txn_do(sub {
1015     my $rs = $schema->resultset('Book');
1016     while (my $row = $rs->next) {
1017       $schema->resultset('MetaData')->create({
1018         book_id => $row->id,
1019         ...
1020       });
1021     }
1022   });
1023
1024 This won't either:
1025
1026   my $first_row = $large_rs->first;
1027   $schema->txn_do(sub { ... });
1028
1029 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1030 are not affected, as they are done on an extra database handle.
1031
1032 Some workarounds:
1033
1034 =over 4
1035
1036 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1037
1038 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1039
1040 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1041
1042 =back
1043
1044 =head1 MAXIMUM CONNECTIONS
1045
1046 The TDS protocol makes separate connections to the server for active statements
1047 in the background. By default the number of such connections is limited to 25,
1048 on both the client side and the server side.
1049
1050 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1051 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1052 can override it to whatever setting you like in the DSN.
1053
1054 See
1055 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1056 for information on changing the setting on the server side.
1057
1058 =head1 DATES
1059
1060 See L</connect_call_datetime_setup> to setup date formats
1061 for L<DBIx::Class::InflateColumn::DateTime>.
1062
1063 =head1 TEXT/IMAGE COLUMNS
1064
1065 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1066 C<TEXT/IMAGE> columns.
1067
1068 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1069
1070   $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1071
1072 or
1073
1074   $schema->storage->set_textsize($bytes);
1075
1076 instead.
1077
1078 However, the C<LongReadLen> you pass in
1079 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1080 equivalent C<SET TEXTSIZE> command on connection.
1081
1082 See L</connect_call_blob_setup> for a
1083 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1084 with C<IMAGE> columns.
1085
1086 =head1 BULK API
1087
1088 The experimental L<DBD::Sybase> Bulk API support is used for
1089 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1090 on a separate connection.
1091
1092 To use this feature effectively, use a large number of rows for each
1093 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1094
1095   while (my $rows = $data_source->get_100_rows()) {
1096     $rs->populate($rows);
1097   }
1098
1099 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1100 calls in your C<Result> classes B<must> list columns in database order for this
1101 to work. Also, you may have to unset the C<LANG> environment variable before
1102 loading your app, if it doesn't match the character set of your database.
1103
1104 When inserting IMAGE columns using this method, you'll need to use
1105 L</connect_call_blob_setup> as well.
1106
1107 =head1 COMPUTED COLUMNS
1108
1109 If you have columns such as:
1110
1111   created_dtm AS getdate()
1112
1113 represent them in your Result classes as:
1114
1115   created_dtm => {
1116     data_type => undef,
1117     default_value => \'getdate()',
1118     is_nullable => 0,
1119   }
1120
1121 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1122 on tables with such columns.
1123
1124 =head1 TIMESTAMP COLUMNS
1125
1126 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1127 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1128
1129 They should be defined in your Result classes as:
1130
1131   ts => {
1132     data_type => 'timestamp',
1133     is_nullable => 0,
1134     inflate_datetime => 0,
1135   }
1136
1137 The C<<inflate_datetime => 0>> is necessary if you use
1138 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1139 be able to read these values.
1140
1141 The values will come back as hexadecimal.
1142
1143 =head1 TODO
1144
1145 =over
1146
1147 =item *
1148
1149 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1150 any active cursors, using eager cursors.
1151
1152 =item *
1153
1154 Real limits and limited counts using stored procedures deployed on startup.
1155
1156 =item *
1157
1158 Adaptive Server Anywhere (ASA) support
1159
1160 =item *
1161
1162 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1163
1164 =item *
1165
1166 bulk_insert using prepare_cached (see comments.)
1167
1168 =back
1169
1170 =head1 AUTHOR
1171
1172 See L<DBIx::Class/CONTRIBUTORS>.
1173
1174 =head1 LICENSE
1175
1176 You may distribute this code under the same terms as Perl itself.
1177
1178 =cut
1179 # vim:sts=2 sw=2: