1 package DBIx::Class::Storage::DBI::Sybase::ASE;
7 DBIx::Class::Storage::DBI::Sybase
8 DBIx::Class::Storage::DBI::AutoCast
11 use Carp::Clan qw/^DBIx::Class/;
15 use Data::Dumper::Concise();
17 __PACKAGE__->mk_group_accessors('simple' =>
18 qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
19 _bulk_storage _is_bulk_storage _began_bulk_work
20 _bulk_disabled_due_to_coderef_connect_info_warned
24 my @also_proxy_to_extra_storages = qw/
25 connect_call_set_auto_cast auto_cast connect_call_blob_setup
26 connect_call_datetime_setup
28 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
29 auto_savepoint unsafe cursor_class debug debugobj schema
34 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
39 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
43 If your version of Sybase does not support placeholders, then your storage will
44 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
45 You can also enable that driver explicitly, see the documentation for more
48 With this driver there is unfortunately no way to get the C<last_insert_id>
49 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
50 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
52 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
54 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
63 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
65 if ($self->using_freetds) {
66 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
68 You are using FreeTDS with Sybase.
70 We will do our best to support this configuration, but please consider this
73 TEXT/IMAGE columns will definitely not work.
75 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
78 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
80 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
84 if (not $self->_typeless_placeholders_supported) {
85 if ($self->_placeholders_supported) {
89 $self->ensure_class_loaded($no_bind_vars);
90 bless $self, $no_bind_vars;
96 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
97 # not necessarily FreeTDS, but no placeholders nevertheless
98 $self->ensure_class_loaded($no_bind_vars);
99 bless $self, $no_bind_vars;
102 # this is highly unlikely, but we check just in case
103 elsif (not $self->_typeless_placeholders_supported) {
110 $self->_set_max_connect(256);
112 # create storage for insert/(update blob) transactions,
113 # unless this is that storage
114 return if $self->_is_extra_storage;
116 my $writer_storage = (ref $self)->new;
118 $writer_storage->_is_extra_storage(1);
119 $writer_storage->connect_info($self->connect_info);
120 $writer_storage->auto_cast($self->auto_cast);
122 $self->_writer_storage($writer_storage);
124 # create a bulk storage unless connect_info is a coderef
125 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
127 my $bulk_storage = (ref $self)->new;
129 $bulk_storage->_is_extra_storage(1);
130 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
131 $bulk_storage->connect_info($self->connect_info);
134 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
136 $self->_bulk_storage($bulk_storage);
139 for my $method (@also_proxy_to_extra_storages) {
141 no warnings 'redefine';
143 my $replaced = __PACKAGE__->can($method);
145 *{$method} = Sub::Name::subname $method => sub {
147 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
148 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
149 return $self->$replaced(@_);
156 # Even though we call $sth->finish for uses off the bulk API, there's still an
157 # "active statement" warning on disconnect, which we throw away here.
158 # This is due to the bug described in insert_bulk.
159 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
160 local $SIG{__WARN__} = sub {
161 warn $_[0] unless $_[0] =~ /active statement/i;
162 } if $self->_is_bulk_storage;
164 # so that next transaction gets a dbh
165 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
170 # Set up session settings for Sybase databases for the connection.
172 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
173 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
174 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
175 # only want when AutoCommit is off.
177 # Also SET TEXTSIZE for FreeTDS because LongReadLen doesn't work.
178 sub _run_connection_actions {
181 if ($self->_is_bulk_storage) {
182 # this should be cleared on every reconnect
183 $self->_began_bulk_work(0);
187 if (not $self->using_freetds) {
188 $self->_dbh->{syb_chained_txn} = 1;
190 # based on LongReadLen in connect_info
193 if ($self->_dbh_autocommit) {
194 $self->_dbh->do('SET CHAINED OFF');
196 $self->_dbh->do('SET CHAINED ON');
200 $self->next::method(@_);
203 =head2 connect_call_blob_setup
207 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
209 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
210 instead of as a hex string.
214 Also sets the C<log_on_update> value for blob write operations. The default is
215 C<1>, but C<0> is better if your database is configured for it.
218 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
222 sub connect_call_blob_setup {
225 my $dbh = $self->_dbh;
226 $dbh->{syb_binary_images} = 1;
228 $self->_blob_log_on_update($args{log_on_update})
229 if exists $args{log_on_update};
235 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
239 my ($self, $source, $column) = @_;
241 return $self->_is_lob_type($source->column_info($column)->{data_type});
244 sub _prep_for_execute {
246 my ($op, $extra_bind, $ident, $args) = @_;
248 my ($sql, $bind) = $self->next::method (@_);
250 my $table = Scalar::Util::blessed($ident) ? $ident->from : $ident;
252 my $bind_info = $self->_resolve_column_info(
253 $ident, [map $_->[0], @{$bind}]
255 my $bound_identity_col = List::Util::first
256 { $bind_info->{$_}{is_auto_increment} }
259 my $identity_col = Scalar::Util::blessed($ident) &&
261 { $ident->column_info($_)->{is_auto_increment} }
265 if (($op eq 'insert' && $bound_identity_col) ||
266 ($op eq 'update' && exists $args->[0]{$identity_col})) {
268 $self->_set_table_identity_sql($op => $table, 'on'),
270 $self->_set_table_identity_sql($op => $table, 'off'),
274 if ($op eq 'insert' && (not $bound_identity_col) && $identity_col &&
275 (not $self->{insert_bulk})) {
278 $self->_fetch_identity_sql($ident, $identity_col);
281 return ($sql, $bind);
284 sub _set_table_identity_sql {
285 my ($self, $op, $table, $on_off) = @_;
287 return sprintf 'SET IDENTITY_%s %s %s',
288 uc($op), $self->sql_maker->_quote($table), uc($on_off);
291 # Stolen from SQLT, with some modifications. This is a makeshift
292 # solution before a sane type-mapping library is available, thus
293 # the 'our' for easy overrides.
294 our %TYPE_MAPPING = (
297 varchar => 'varchar',
298 varchar2 => 'varchar',
299 timestamp => 'datetime',
301 real => 'double precision',
304 tinyint => 'smallint',
305 float => 'double precision',
307 bigserial => 'numeric',
308 boolean => 'varchar',
312 sub _native_data_type {
313 my ($self, $type) = @_;
316 $type =~ s/\s* identity//x;
318 return uc($TYPE_MAPPING{$type} || $type);
321 sub _fetch_identity_sql {
322 my ($self, $source, $col) = @_;
324 return sprintf ("SELECT MAX(%s) FROM %s",
325 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
333 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
335 if ($op eq 'insert') {
336 $self->_identity($sth->fetchrow_array);
340 return wantarray ? ($rv, $sth, @bind) : $rv;
343 sub last_insert_id { shift->_identity }
345 # handles TEXT/IMAGE and transaction for last_insert_id
348 my ($source, $to_insert) = @_;
350 my $identity_col = (List::Util::first
351 { $source->column_info($_)->{is_auto_increment} }
352 $source->columns) || '';
354 # check for empty insert
355 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
356 # try to insert explicit 'DEFAULT's instead (except for identity)
357 if (not %$to_insert) {
358 for my $col ($source->columns) {
359 next if $col eq $identity_col;
360 $to_insert->{$col} = \'DEFAULT';
364 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
366 # do we need the horrific SELECT MAX(COL) hack?
367 my $dumb_last_insert_id =
369 && (not exists $to_insert->{$identity_col})
370 && ($self->_identity_method||'') ne '@@IDENTITY';
372 my $next = $self->next::can;
374 # we are already in a transaction, or there are no blobs
375 # and we don't need the PK - just (try to) do it
376 if ($self->{transaction_depth}
377 || (!$blob_cols && !$dumb_last_insert_id)
379 return $self->_insert (
380 $next, $source, $to_insert, $blob_cols, $identity_col
384 # otherwise use the _writer_storage to do the insert+transaction on another
386 my $guard = $self->_writer_storage->txn_scope_guard;
388 my $updated_cols = $self->_writer_storage->_insert (
389 $next, $source, $to_insert, $blob_cols, $identity_col
392 $self->_identity($self->_writer_storage->_identity);
396 return $updated_cols;
400 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
402 my $updated_cols = $self->$next ($source, $to_insert);
406 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
411 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
413 return $updated_cols;
418 my ($source, $fields, $where, @rest) = @_;
420 my $wantarray = wantarray;
422 my $blob_cols = $self->_remove_blob_cols($source, $fields);
424 my $table = $source->name;
426 my $identity_col = List::Util::first
427 { $source->column_info($_)->{is_auto_increment} }
430 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
432 return $self->next::method(@_) unless $blob_cols;
434 # If there are any blobs in $where, Sybase will return a descriptive error
436 # XXX blobs can still be used with a LIKE query, and this should be handled.
438 # update+blob update(s) done atomically on separate connection
439 $self = $self->_writer_storage;
441 my $guard = $self->txn_scope_guard;
443 # First update the blob columns to be updated to '' (taken from $fields, where
444 # it is originally put by _remove_blob_cols .)
445 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
447 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
449 $self->next::method($source, \%blobs_to_empty, $where, @rest);
451 # Now update the blobs before the other columns in case the update of other
452 # columns makes the search condition invalid.
453 $self->_update_blobs($source, $blob_cols, $where);
458 @res = $self->next::method(@_);
460 elsif (defined $wantarray) {
461 $res[0] = $self->next::method(@_);
464 $self->next::method(@_);
470 return $wantarray ? @res : $res[0];
475 my ($source, $cols, $data) = @_;
477 my $identity_col = List::Util::first
478 { $source->column_info($_)->{is_auto_increment} }
481 my $is_identity_insert = (List::Util::first
482 { $_ eq $identity_col }
486 my @source_columns = $source->columns;
489 $self->_bulk_storage &&
490 $self->_get_dbh->{syb_has_blk};
492 if ((not $use_bulk_api)
494 (ref($self->_dbi_connect_info->[0]) eq 'CODE')
496 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
498 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
499 regular array inserts.
501 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
504 if (not $use_bulk_api) {
505 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
507 # _execute_array uses a txn anyway, but it ends too early in case we need to
508 # select max(col) to get the identity for inserting blobs.
509 ($self, my $guard) = $self->{transaction_depth} == 0 ?
510 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
514 local $self->{insert_bulk} = 1;
516 $self->next::method(@_);
519 if ($is_identity_insert) {
520 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
523 my @cols_with_identities = (@$cols, $identity_col);
525 ## calculate identities
526 # XXX This assumes identities always increase by 1, which may or may not
528 my ($last_identity) =
529 $self->_dbh->selectrow_array (
530 $self->_fetch_identity_sql($source, $identity_col)
532 my @identities = (($last_identity - @$data + 1) .. $last_identity);
534 my @data_with_identities = map [@$_, shift @identities], @$data;
536 $self->_insert_blobs_array (
537 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
542 $guard->commit if $guard;
547 # otherwise, use the bulk API
549 # rearrange @$data so that columns are in database order
551 @orig_idx{@$cols} = 0..$#$cols;
554 @new_idx{@source_columns} = 0..$#source_columns;
557 for my $datum (@$data) {
559 for my $col (@source_columns) {
560 # identity data will be 'undef' if not $is_identity_insert
561 # columns with defaults will also be 'undef'
562 $new_datum->[ $new_idx{$col} ] =
563 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
565 push @new_data, $new_datum;
568 # bcp identity index is 1-based
569 my $identity_idx = exists $new_idx{$identity_col} ?
570 $new_idx{$identity_col} + 1 : 0;
572 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
573 # This ignores any data conversion errors detected by the client side libs, as
574 # they are usually harmless.
575 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
576 Sub::Name::subname insert_bulk => sub {
577 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
579 return 1 if $errno == 36;
582 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
583 ($errmsg ? "\n$errmsg" : '') .
584 ($osmsg ? "\n$osmsg" : '') .
585 ($blkmsg ? "\n$blkmsg" : '');
591 my $bulk = $self->_bulk_storage;
593 my $guard = $bulk->txn_scope_guard;
595 ## XXX get this to work instead of our own $sth
596 ## will require SQLA or *Hacks changes for ordered columns
597 # $bulk->next::method($source, \@source_columns, \@new_data, {
598 # syb_bcp_attribs => {
599 # identity_flag => $is_identity_insert,
600 # identity_column => $identity_idx,
603 my $sql = 'INSERT INTO ' .
604 $bulk->sql_maker->_quote($source->name) . ' (' .
605 # colname list is ignored for BCP, but does no harm
606 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
607 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
609 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
610 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
611 ## better yet the version above. Should be fixed in DBD::Sybase .
612 my $sth = $bulk->_get_dbh->prepare($sql,
616 identity_flag => $is_identity_insert,
617 identity_column => $identity_idx,
624 map [ $_, $idx++ ], @source_columns;
627 $self->_execute_array(
628 $source, $sth, \@bind, \@source_columns, \@new_data, sub {
633 $bulk->_query_end($sql);
637 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
639 if ($exception =~ /-Y option/) {
642 Sybase bulk API operation failed due to character set incompatibility, reverting
643 to regular array inserts:
645 *** Try unsetting the LANG environment variable.
649 $self->_bulk_storage(undef);
654 # rollback makes the bulkLogin connection unusable
655 $self->_bulk_storage->disconnect;
656 $self->throw_exception($exception);
660 sub _dbh_execute_array {
661 my ($self, $sth, $tuple_status, $cb) = @_;
663 my $rv = $self->next::method($sth, $tuple_status);
669 # Make sure blobs are not bound as placeholders, and return any non-empty ones
671 sub _remove_blob_cols {
672 my ($self, $source, $fields) = @_;
676 for my $col (keys %$fields) {
677 if ($self->_is_lob_column($source, $col)) {
678 my $blob_val = delete $fields->{$col};
679 if (not defined $blob_val) {
680 $fields->{$col} = \'NULL';
683 $fields->{$col} = \"''";
684 $blob_cols{$col} = $blob_val unless $blob_val eq '';
689 return %blob_cols ? \%blob_cols : undef;
692 # same for insert_bulk
693 sub _remove_blob_cols_array {
694 my ($self, $source, $cols, $data) = @_;
698 for my $i (0..$#$cols) {
699 my $col = $cols->[$i];
701 if ($self->_is_lob_column($source, $col)) {
702 for my $j (0..$#$data) {
703 my $blob_val = delete $data->[$j][$i];
704 if (not defined $blob_val) {
705 $data->[$j][$i] = \'NULL';
708 $data->[$j][$i] = \"''";
709 $blob_cols[$j][$i] = $blob_val
710 unless $blob_val eq '';
716 return @blob_cols ? \@blob_cols : undef;
720 my ($self, $source, $blob_cols, $where) = @_;
722 my (@primary_cols) = $source->primary_columns;
724 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
725 unless @primary_cols;
727 # check if we're updating a single row by PK
728 my $pk_cols_in_where = 0;
729 for my $col (@primary_cols) {
730 $pk_cols_in_where++ if defined $where->{$col};
734 if ($pk_cols_in_where == @primary_cols) {
736 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
737 @rows = \%row_to_update;
739 my $cursor = $self->select ($source, \@primary_cols, $where, {});
741 my %row; @row{@primary_cols} = @$_; \%row
745 for my $row (@rows) {
746 $self->_insert_blobs($source, $blob_cols, $row);
751 my ($self, $source, $blob_cols, $row) = @_;
752 my $dbh = $self->_get_dbh;
754 my $table = $source->name;
757 my (@primary_cols) = $source->primary_columns;
759 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
760 unless @primary_cols;
762 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
763 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
765 for my $col (keys %$blob_cols) {
766 my $blob = $blob_cols->{$col};
768 my %where = map { ($_, $row{$_}) } @primary_cols;
770 my $cursor = $self->select ($source, [$col], \%where, {});
772 my $sth = $cursor->sth;
776 $self->throw_exception(
777 "Could not find row in table '$table' for blob update:\n"
778 . Data::Dumper::Concise::Dumper (\%where)
784 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
787 $sth->func('ct_prepare_send') or die $sth->errstr;
789 my $log_on_update = $self->_blob_log_on_update;
790 $log_on_update = 1 if not defined $log_on_update;
792 $sth->func('CS_SET', 1, {
793 total_txtlen => length($blob),
794 log_on_update => $log_on_update
795 }, 'ct_data_info') or die $sth->errstr;
797 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
799 $sth->func('ct_finish_send') or die $sth->errstr;
802 $sth->finish if $sth;
804 if ($self->using_freetds) {
805 $self->throw_exception (
806 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
810 $self->throw_exception($exception);
816 sub _insert_blobs_array {
817 my ($self, $source, $blob_cols, $cols, $data) = @_;
819 for my $i (0..$#$data) {
820 my $datum = $data->[$i];
823 @row{ @$cols } = @$datum;
826 for my $j (0..$#$cols) {
827 if (exists $blob_cols->[$i][$j]) {
828 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
832 $self->_insert_blobs ($source, \%blob_vals, \%row);
836 =head2 connect_call_datetime_setup
840 on_connect_call => 'datetime_setup'
842 In L<DBIx::Class::Storage::DBI/connect_info> to set:
844 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
845 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
847 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
848 L<DateTime::Format::Sybase>, which you will need to install.
850 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
851 C<SMALLDATETIME> columns only have minute precision.
856 my $old_dbd_warned = 0;
858 sub connect_call_datetime_setup {
860 my $dbh = $self->_get_dbh;
862 if ($dbh->can('syb_date_fmt')) {
863 # amazingly, this works with FreeTDS
864 $dbh->syb_date_fmt('ISO_strict');
865 } elsif (not $old_dbd_warned) {
866 carp "Your DBD::Sybase is too old to support ".
867 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
871 $dbh->do('SET DATEFORMAT mdy');
877 sub datetime_parser_type { "DateTime::Format::Sybase" }
879 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
880 # let the DBD keep any state it needs to.
882 # If they ever do start working, the extra statements will do no harm (because
883 # Sybase supports nested transactions.)
885 sub _dbh_begin_work {
888 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
889 # TRAN once. However, we need to make sure there's a $dbh.
890 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
892 $self->next::method(@_);
894 if ($self->using_freetds) {
895 $self->_get_dbh->do('BEGIN TRAN');
898 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
903 if ($self->using_freetds) {
904 $self->_dbh->do('COMMIT');
906 return $self->next::method(@_);
911 if ($self->using_freetds) {
912 $self->_dbh->do('ROLLBACK');
914 return $self->next::method(@_);
917 # savepoint support using ASE syntax
920 my ($self, $name) = @_;
922 $self->_get_dbh->do("SAVE TRANSACTION $name");
925 # A new SAVE TRANSACTION with the same name releases the previous one.
926 sub _svp_release { 1 }
929 my ($self, $name) = @_;
931 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
936 =head1 Schema::Loader Support
938 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
939 allow you to dump a schema from most (if not all) versions of Sybase.
941 It is available via subversion from:
943 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
947 This driver supports L<DBD::Sybase> compiled against FreeTDS
948 (L<http://www.freetds.org/>) to the best of our ability, however it is
949 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
950 libraries. They are a part of the Sybase ASE distribution:
952 The Open Client FAQ is here:
953 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
955 Sybase ASE for Linux (which comes with the Open Client libraries) may be
956 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
958 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
960 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
962 Some versions of the libraries involved will not support placeholders, in which
963 case the storage will be reblessed to
964 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
966 In some configurations, placeholders will work but will throw implicit type
967 conversion errors for anything that's not expecting a string. In such a case,
968 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
969 automatically set, which you may enable on connection with
970 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
971 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
972 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
973 already) using a mapping based on L<SQL::Translator>.
975 In other configurations, placeholers will work just as they do with the Sybase
976 Open Client libraries.
978 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
980 =head1 INSERTS WITH PLACEHOLDERS
982 With placeholders enabled, inserts are done in a transaction so that there are
983 no concurrency issues with getting the inserted identity value using
984 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
987 In addition, they are done on a separate connection so that it's possible to
988 have active cursors when doing an insert.
990 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
991 are disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as
992 it's a session variable.
996 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
997 begin a transaction while there are active cursors; nor can you use multiple
998 active cursors within a transaction. An active cursor is, for example, a
999 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1000 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1002 For example, this will not work:
1004 $schema->txn_do(sub {
1005 my $rs = $schema->resultset('Book');
1006 while (my $row = $rs->next) {
1007 $schema->resultset('MetaData')->create({
1008 book_id => $row->id,
1016 my $first_row = $large_rs->first;
1017 $schema->txn_do(sub { ... });
1019 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1020 are not affected, as they are done on an extra database handle.
1026 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1028 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1030 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1034 =head1 MAXIMUM CONNECTIONS
1036 The TDS protocol makes separate connections to the server for active statements
1037 in the background. By default the number of such connections is limited to 25,
1038 on both the client side and the server side.
1040 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1041 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1042 can override it to whatever setting you like in the DSN.
1045 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1046 for information on changing the setting on the server side.
1050 See L</connect_call_datetime_setup> to setup date formats
1051 for L<DBIx::Class::InflateColumn::DateTime>.
1053 =head1 TEXT/IMAGE COLUMNS
1055 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1056 C<TEXT/IMAGE> columns.
1058 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1060 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1064 $schema->storage->set_textsize($bytes);
1068 However, the C<LongReadLen> you pass in
1069 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
1070 C<SET TEXTSIZE> command on connection.
1072 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
1073 setting you need to work with C<IMAGE> columns.
1077 The experimental L<DBD::Sybase> Bulk API support is used for
1078 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1079 on a separate connection.
1081 To use this feature effectively, use a large number of rows for each
1082 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1084 while (my $rows = $data_source->get_100_rows()) {
1085 $rs->populate($rows);
1088 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1089 calls in your C<Result> classes B<must> list columns in database order for this
1090 to work. Also, you may have to unset the C<LANG> environment variable before
1091 loading your app, if it doesn't match the character set of your database.
1093 When inserting IMAGE columns using this method, you'll need to use
1094 L</connect_call_blob_setup> as well.
1102 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1103 any active cursors, using eager cursors.
1107 Real limits and limited counts using stored procedures deployed on startup.
1111 Adaptive Server Anywhere (ASA) support, with possible SQLA::Limit support.
1115 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1119 bulk_insert using prepare_cached (see comments.)
1125 See L<DBIx::Class/CONTRIBUTORS>.
1129 You may distribute this code under the same terms as Perl itself.