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/;
12 use Scalar::Util 'blessed';
13 use List::Util 'first';
15 use Data::Dumper::Concise 'Dumper';
19 __PACKAGE__->sql_limit_dialect ('RowCountOrGenericSubQ');
21 __PACKAGE__->mk_group_accessors('simple' =>
22 qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
23 _bulk_storage _is_bulk_storage _began_bulk_work
24 _bulk_disabled_due_to_coderef_connect_info_warned
28 my @also_proxy_to_extra_storages = qw/
29 connect_call_set_auto_cast auto_cast connect_call_blob_setup
30 connect_call_datetime_setup
32 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
33 auto_savepoint unsafe cursor_class debug debugobj schema
38 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
43 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
47 If your version of Sybase does not support placeholders, then your storage will
48 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
49 You can also enable that driver explicitly, see the documentation for more
52 With this driver there is unfortunately no way to get the C<last_insert_id>
53 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
54 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
56 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
58 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
67 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
69 if ($self->using_freetds) {
70 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
72 You are using FreeTDS with Sybase.
74 We will do our best to support this configuration, but please consider this
77 TEXT/IMAGE columns will definitely not work.
79 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
82 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
84 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
88 if (not $self->_use_typeless_placeholders) {
89 if ($self->_use_placeholders) {
93 $self->ensure_class_loaded($no_bind_vars);
94 bless $self, $no_bind_vars;
100 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
101 # not necessarily FreeTDS, but no placeholders nevertheless
102 $self->ensure_class_loaded($no_bind_vars);
103 bless $self, $no_bind_vars;
106 # this is highly unlikely, but we check just in case
107 elsif (not $self->_use_typeless_placeholders) {
114 $self->_set_max_connect(256);
116 # create storage for insert/(update blob) transactions,
117 # unless this is that storage
118 return if $self->_is_extra_storage;
120 my $writer_storage = (ref $self)->new;
122 $writer_storage->_is_extra_storage(1);
123 $writer_storage->connect_info($self->connect_info);
124 $writer_storage->auto_cast($self->auto_cast);
126 $self->_writer_storage($writer_storage);
128 # create a bulk storage unless connect_info is a coderef
129 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
131 my $bulk_storage = (ref $self)->new;
133 $bulk_storage->_is_extra_storage(1);
134 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
135 $bulk_storage->connect_info($self->connect_info);
138 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
140 $self->_bulk_storage($bulk_storage);
143 for my $method (@also_proxy_to_extra_storages) {
145 no warnings 'redefine';
147 my $replaced = __PACKAGE__->can($method);
149 *{$method} = Sub::Name::subname $method => sub {
151 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
152 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
153 return $self->$replaced(@_);
160 # Even though we call $sth->finish for uses off the bulk API, there's still an
161 # "active statement" warning on disconnect, which we throw away here.
162 # This is due to the bug described in insert_bulk.
163 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
164 local $SIG{__WARN__} = sub {
165 warn $_[0] unless $_[0] =~ /active statement/i;
166 } if $self->_is_bulk_storage;
168 # so that next transaction gets a dbh
169 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
174 # Set up session settings for Sybase databases for the connection.
176 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
177 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
178 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
179 # only want when AutoCommit is off.
181 # Also SET TEXTSIZE for FreeTDS because LongReadLen doesn't work.
182 sub _run_connection_actions {
185 if ($self->_is_bulk_storage) {
186 # this should be cleared on every reconnect
187 $self->_began_bulk_work(0);
191 if (not $self->using_freetds) {
192 $self->_dbh->{syb_chained_txn} = 1;
194 # based on LongReadLen in connect_info
197 if ($self->_dbh_autocommit) {
198 $self->_dbh->do('SET CHAINED OFF');
200 $self->_dbh->do('SET CHAINED ON');
204 $self->next::method(@_);
207 =head2 connect_call_blob_setup
211 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
213 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
214 instead of as a hex string.
218 Also sets the C<log_on_update> value for blob write operations. The default is
219 C<1>, but C<0> is better if your database is configured for it.
222 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
226 sub connect_call_blob_setup {
229 my $dbh = $self->_dbh;
230 $dbh->{syb_binary_images} = 1;
232 $self->_blob_log_on_update($args{log_on_update})
233 if exists $args{log_on_update};
237 my ($self, $source, $column) = @_;
239 return $self->_is_lob_type($source->column_info($column)->{data_type});
242 sub _prep_for_execute {
244 my ($op, $extra_bind, $ident, $args) = @_;
246 my ($sql, $bind) = $self->next::method (@_);
248 my $table = blessed $ident ? $ident->from : $ident;
250 my $bind_info = $self->_resolve_column_info(
251 $ident, [map $_->[0], @{$bind}]
253 my $bound_identity_col =
254 first { $bind_info->{$_}{is_auto_increment} }
258 my $columns_info = blessed $ident && $ident->columns_info;
262 first { $columns_info->{$_}{is_auto_increment} }
266 if (($op eq 'insert' && $bound_identity_col) ||
267 ($op eq 'update' && exists $args->[0]{$identity_col})) {
269 $self->_set_table_identity_sql($op => $table, 'on'),
271 $self->_set_table_identity_sql($op => $table, 'off'),
275 if ($op eq 'insert' && (not $bound_identity_col) && $identity_col &&
276 (not $self->{insert_bulk})) {
279 $self->_fetch_identity_sql($ident, $identity_col);
282 return ($sql, $bind);
285 sub _set_table_identity_sql {
286 my ($self, $op, $table, $on_off) = @_;
288 return sprintf 'SET IDENTITY_%s %s %s',
289 uc($op), $self->sql_maker->_quote($table), uc($on_off);
292 # Stolen from SQLT, with some modifications. This is a makeshift
293 # solution before a sane type-mapping library is available, thus
294 # the 'our' for easy overrides.
295 our %TYPE_MAPPING = (
298 varchar => 'varchar',
299 varchar2 => 'varchar',
300 timestamp => 'datetime',
302 real => 'double precision',
305 tinyint => 'smallint',
306 float => 'double precision',
308 bigserial => 'numeric',
309 boolean => 'varchar',
313 sub _native_data_type {
314 my ($self, $type) = @_;
317 $type =~ s/\s* identity//x;
319 return uc($TYPE_MAPPING{$type} || $type);
322 sub _fetch_identity_sql {
323 my ($self, $source, $col) = @_;
325 return sprintf ("SELECT MAX(%s) FROM %s",
326 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
334 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
336 if ($op eq 'insert') {
337 $self->_identity($sth->fetchrow_array);
341 return wantarray ? ($rv, $sth, @bind) : $rv;
344 sub last_insert_id { shift->_identity }
346 # handles TEXT/IMAGE and transaction for last_insert_id
349 my ($source, $to_insert) = @_;
351 my $columns_info = $source->columns_info;
354 (first { $columns_info->{$_}{is_auto_increment} }
355 keys %$columns_info )
358 # check for empty insert
359 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
360 # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
361 # and computed columns)
362 if (not %$to_insert) {
363 for my $col ($source->columns) {
364 next if $col eq $identity_col;
366 my $info = $source->column_info($col);
368 next if ref $info->{default_value} eq 'SCALAR'
369 || (exists $info->{data_type} && (not defined $info->{data_type}));
371 next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
373 $to_insert->{$col} = \'DEFAULT';
377 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
379 # do we need the horrific SELECT MAX(COL) hack?
380 my $dumb_last_insert_id =
382 && (not exists $to_insert->{$identity_col})
383 && ($self->_identity_method||'') ne '@@IDENTITY';
385 my $next = $self->next::can;
387 # we are already in a transaction, or there are no blobs
388 # and we don't need the PK - just (try to) do it
389 if ($self->{transaction_depth}
390 || (!$blob_cols && !$dumb_last_insert_id)
392 return $self->_insert (
393 $next, $source, $to_insert, $blob_cols, $identity_col
397 # otherwise use the _writer_storage to do the insert+transaction on another
399 my $guard = $self->_writer_storage->txn_scope_guard;
401 my $updated_cols = $self->_writer_storage->_insert (
402 $next, $source, $to_insert, $blob_cols, $identity_col
405 $self->_identity($self->_writer_storage->_identity);
409 return $updated_cols;
413 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
415 my $updated_cols = $self->$next ($source, $to_insert);
419 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
424 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
426 return $updated_cols;
431 my ($source, $fields, $where, @rest) = @_;
433 my $blob_cols = $self->_remove_blob_cols($source, $fields);
435 my $table = $source->name;
437 my $columns_info = $source->columns_info;
440 first { $columns_info->{$_}{is_auto_increment} }
443 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
445 return $self->next::method(@_) unless $blob_cols;
447 # If there are any blobs in $where, Sybase will return a descriptive error
449 # XXX blobs can still be used with a LIKE query, and this should be handled.
451 # update+blob update(s) done atomically on separate connection
452 $self = $self->_writer_storage;
454 my $guard = $self->txn_scope_guard;
456 # First update the blob columns to be updated to '' (taken from $fields, where
457 # it is originally put by _remove_blob_cols .)
458 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
460 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
462 $self->next::method($source, \%blobs_to_empty, $where, @rest);
464 # Now update the blobs before the other columns in case the update of other
465 # columns makes the search condition invalid.
466 $self->_update_blobs($source, $blob_cols, $where);
471 @res = $self->next::method(@_);
473 elsif (defined wantarray) {
474 $res[0] = $self->next::method(@_);
477 $self->next::method(@_);
483 return wantarray ? @res : $res[0];
488 my ($source, $cols, $data) = @_;
490 my $columns_info = $source->columns_info;
493 first { $columns_info->{$_}{is_auto_increment} }
496 my $is_identity_insert = (first { $_ eq $identity_col } @{$cols}) ? 1 : 0;
498 my @source_columns = $source->columns;
501 $self->_bulk_storage &&
502 $self->_get_dbh->{syb_has_blk};
504 if ((not $use_bulk_api)
506 (ref($self->_dbi_connect_info->[0]) eq 'CODE')
508 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
510 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
511 regular array inserts.
513 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
516 if (not $use_bulk_api) {
517 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
519 # _execute_array uses a txn anyway, but it ends too early in case we need to
520 # select max(col) to get the identity for inserting blobs.
521 ($self, my $guard) = $self->{transaction_depth} == 0 ?
522 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
526 local $self->{insert_bulk} = 1;
528 $self->next::method(@_);
531 if ($is_identity_insert) {
532 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
535 my @cols_with_identities = (@$cols, $identity_col);
537 ## calculate identities
538 # XXX This assumes identities always increase by 1, which may or may not
540 my ($last_identity) =
541 $self->_dbh->selectrow_array (
542 $self->_fetch_identity_sql($source, $identity_col)
544 my @identities = (($last_identity - @$data + 1) .. $last_identity);
546 my @data_with_identities = map [@$_, shift @identities], @$data;
548 $self->_insert_blobs_array (
549 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
554 $guard->commit if $guard;
559 # otherwise, use the bulk API
561 # rearrange @$data so that columns are in database order
563 @orig_idx{@$cols} = 0..$#$cols;
566 @new_idx{@source_columns} = 0..$#source_columns;
569 for my $datum (@$data) {
571 for my $col (@source_columns) {
572 # identity data will be 'undef' if not $is_identity_insert
573 # columns with defaults will also be 'undef'
574 $new_datum->[ $new_idx{$col} ] =
575 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
577 push @new_data, $new_datum;
580 # bcp identity index is 1-based
581 my $identity_idx = exists $new_idx{$identity_col} ?
582 $new_idx{$identity_col} + 1 : 0;
584 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
585 # This ignores any data conversion errors detected by the client side libs, as
586 # they are usually harmless.
587 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
588 Sub::Name::subname insert_bulk => sub {
589 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
591 return 1 if $errno == 36;
594 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
595 ($errmsg ? "\n$errmsg" : '') .
596 ($osmsg ? "\n$osmsg" : '') .
597 ($blkmsg ? "\n$blkmsg" : '');
604 my $bulk = $self->_bulk_storage;
606 my $guard = $bulk->txn_scope_guard;
608 ## XXX get this to work instead of our own $sth
609 ## will require SQLA or *Hacks changes for ordered columns
610 # $bulk->next::method($source, \@source_columns, \@new_data, {
611 # syb_bcp_attribs => {
612 # identity_flag => $is_identity_insert,
613 # identity_column => $identity_idx,
616 my $sql = 'INSERT INTO ' .
617 $bulk->sql_maker->_quote($source->name) . ' (' .
618 # colname list is ignored for BCP, but does no harm
619 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
620 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
622 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
623 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
624 ## better yet the version above. Should be fixed in DBD::Sybase .
625 my $sth = $bulk->_get_dbh->prepare($sql,
629 identity_flag => $is_identity_insert,
630 identity_column => $identity_idx,
637 map [ $_, $idx++ ], @source_columns;
640 $self->_execute_array(
641 $source, $sth, \@bind, \@source_columns, \@new_data, sub {
646 $bulk->_query_end($sql);
651 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
653 if ($exception =~ /-Y option/) {
654 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
655 . 'reverting to regular array inserts. Try unsetting the LANG environment variable'
657 $w .= "\n$exception" if $self->debug;
660 $self->_bulk_storage(undef);
665 # rollback makes the bulkLogin connection unusable
666 $self->_bulk_storage->disconnect;
667 $self->throw_exception($exception);
671 sub _dbh_execute_array {
672 my ($self, $sth, $tuple_status, $cb) = @_;
674 my $rv = $self->next::method($sth, $tuple_status);
680 # Make sure blobs are not bound as placeholders, and return any non-empty ones
682 sub _remove_blob_cols {
683 my ($self, $source, $fields) = @_;
687 for my $col (keys %$fields) {
688 if ($self->_is_lob_column($source, $col)) {
689 my $blob_val = delete $fields->{$col};
690 if (not defined $blob_val) {
691 $fields->{$col} = \'NULL';
694 $fields->{$col} = \"''";
695 $blob_cols{$col} = $blob_val unless $blob_val eq '';
700 return %blob_cols ? \%blob_cols : undef;
703 # same for insert_bulk
704 sub _remove_blob_cols_array {
705 my ($self, $source, $cols, $data) = @_;
709 for my $i (0..$#$cols) {
710 my $col = $cols->[$i];
712 if ($self->_is_lob_column($source, $col)) {
713 for my $j (0..$#$data) {
714 my $blob_val = delete $data->[$j][$i];
715 if (not defined $blob_val) {
716 $data->[$j][$i] = \'NULL';
719 $data->[$j][$i] = \"''";
720 $blob_cols[$j][$i] = $blob_val
721 unless $blob_val eq '';
727 return @blob_cols ? \@blob_cols : undef;
731 my ($self, $source, $blob_cols, $where) = @_;
733 my @primary_cols = try
734 { $source->_pri_cols }
736 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
739 # check if we're updating a single row by PK
740 my $pk_cols_in_where = 0;
741 for my $col (@primary_cols) {
742 $pk_cols_in_where++ if defined $where->{$col};
746 if ($pk_cols_in_where == @primary_cols) {
748 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
749 @rows = \%row_to_update;
751 my $cursor = $self->select ($source, \@primary_cols, $where, {});
753 my %row; @row{@primary_cols} = @$_; \%row
757 for my $row (@rows) {
758 $self->_insert_blobs($source, $blob_cols, $row);
763 my ($self, $source, $blob_cols, $row) = @_;
764 my $dbh = $self->_get_dbh;
766 my $table = $source->name;
769 my @primary_cols = try
770 { $source->_pri_cols }
772 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
775 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
776 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
778 for my $col (keys %$blob_cols) {
779 my $blob = $blob_cols->{$col};
781 my %where = map { ($_, $row{$_}) } @primary_cols;
783 my $cursor = $self->select ($source, [$col], \%where, {});
785 my $sth = $cursor->sth;
788 $self->throw_exception(
789 "Could not find row in table '$table' for blob update:\n"
796 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
799 $sth->func('ct_prepare_send') or die $sth->errstr;
801 my $log_on_update = $self->_blob_log_on_update;
802 $log_on_update = 1 if not defined $log_on_update;
804 $sth->func('CS_SET', 1, {
805 total_txtlen => length($blob),
806 log_on_update => $log_on_update
807 }, 'ct_data_info') or die $sth->errstr;
809 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
811 $sth->func('ct_finish_send') or die $sth->errstr;
814 if ($self->using_freetds) {
815 $self->throw_exception (
816 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
820 $self->throw_exception($_);
824 $sth->finish if $sth;
829 sub _insert_blobs_array {
830 my ($self, $source, $blob_cols, $cols, $data) = @_;
832 for my $i (0..$#$data) {
833 my $datum = $data->[$i];
836 @row{ @$cols } = @$datum;
839 for my $j (0..$#$cols) {
840 if (exists $blob_cols->[$i][$j]) {
841 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
845 $self->_insert_blobs ($source, \%blob_vals, \%row);
849 =head2 connect_call_datetime_setup
853 on_connect_call => 'datetime_setup'
855 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
857 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
858 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
860 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
861 L<DateTime::Format::Sybase>, which you will need to install.
863 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
864 C<SMALLDATETIME> columns only have minute precision.
869 my $old_dbd_warned = 0;
871 sub connect_call_datetime_setup {
873 my $dbh = $self->_get_dbh;
875 if ($dbh->can('syb_date_fmt')) {
876 # amazingly, this works with FreeTDS
877 $dbh->syb_date_fmt('ISO_strict');
878 } elsif (not $old_dbd_warned) {
879 carp "Your DBD::Sybase is too old to support ".
880 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
884 $dbh->do('SET DATEFORMAT mdy');
890 sub datetime_parser_type { "DateTime::Format::Sybase" }
892 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
893 # let the DBD keep any state it needs to.
895 # If they ever do start working, the extra statements will do no harm (because
896 # Sybase supports nested transactions.)
898 sub _dbh_begin_work {
901 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
902 # TRAN once. However, we need to make sure there's a $dbh.
903 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
905 $self->next::method(@_);
907 if ($self->using_freetds) {
908 $self->_get_dbh->do('BEGIN TRAN');
911 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
916 if ($self->using_freetds) {
917 $self->_dbh->do('COMMIT');
919 return $self->next::method(@_);
924 if ($self->using_freetds) {
925 $self->_dbh->do('ROLLBACK');
927 return $self->next::method(@_);
930 # savepoint support using ASE syntax
933 my ($self, $name) = @_;
935 $self->_get_dbh->do("SAVE TRANSACTION $name");
938 # A new SAVE TRANSACTION with the same name releases the previous one.
939 sub _svp_release { 1 }
942 my ($self, $name) = @_;
944 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
949 =head1 Schema::Loader Support
951 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
952 most (if not all) versions of Sybase ASE.
956 This driver supports L<DBD::Sybase> compiled against FreeTDS
957 (L<http://www.freetds.org/>) to the best of our ability, however it is
958 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
959 libraries. They are a part of the Sybase ASE distribution:
961 The Open Client FAQ is here:
962 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
964 Sybase ASE for Linux (which comes with the Open Client libraries) may be
965 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
967 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
969 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
971 Some versions of the libraries involved will not support placeholders, in which
972 case the storage will be reblessed to
973 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
975 In some configurations, placeholders will work but will throw implicit type
976 conversion errors for anything that's not expecting a string. In such a case,
977 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
978 automatically set, which you may enable on connection with
979 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
980 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
981 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
982 already) using a mapping based on L<SQL::Translator>.
984 In other configurations, placeholders will work just as they do with the Sybase
985 Open Client libraries.
987 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
989 =head1 INSERTS WITH PLACEHOLDERS
991 With placeholders enabled, inserts are done in a transaction so that there are
992 no concurrency issues with getting the inserted identity value using
993 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
996 In addition, they are done on a separate connection so that it's possible to
997 have active cursors when doing an insert.
999 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
1000 are disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as
1001 it's a session variable.
1005 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both, you cannot
1006 begin a transaction while there are active cursors, nor can you use multiple
1007 active cursors within a transaction. An active cursor is, for example, a
1008 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1009 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1011 For example, this will not work:
1013 $schema->txn_do(sub {
1014 my $rs = $schema->resultset('Book');
1015 while (my $row = $rs->next) {
1016 $schema->resultset('MetaData')->create({
1017 book_id => $row->id,
1025 my $first_row = $large_rs->first;
1026 $schema->txn_do(sub { ... });
1028 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1029 are not affected, as they are done on an extra database handle.
1035 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1037 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1039 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1043 =head1 MAXIMUM CONNECTIONS
1045 The TDS protocol makes separate connections to the server for active statements
1046 in the background. By default the number of such connections is limited to 25,
1047 on both the client side and the server side.
1049 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1050 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1051 can override it to whatever setting you like in the DSN.
1054 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1055 for information on changing the setting on the server side.
1059 See L</connect_call_datetime_setup> to setup date formats
1060 for L<DBIx::Class::InflateColumn::DateTime>.
1062 =head1 TEXT/IMAGE COLUMNS
1064 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1065 C<TEXT/IMAGE> columns.
1067 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1069 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1073 $schema->storage->set_textsize($bytes);
1077 However, the C<LongReadLen> you pass in
1078 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1079 equivalent C<SET TEXTSIZE> command on connection.
1081 See L</connect_call_blob_setup> for a
1082 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1083 with C<IMAGE> columns.
1087 The experimental L<DBD::Sybase> Bulk API support is used for
1088 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1089 on a separate connection.
1091 To use this feature effectively, use a large number of rows for each
1092 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1094 while (my $rows = $data_source->get_100_rows()) {
1095 $rs->populate($rows);
1098 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1099 calls in your C<Result> classes B<must> list columns in database order for this
1100 to work. Also, you may have to unset the C<LANG> environment variable before
1101 loading your app, if it doesn't match the character set of your database.
1103 When inserting IMAGE columns using this method, you'll need to use
1104 L</connect_call_blob_setup> as well.
1106 =head1 COMPUTED COLUMNS
1108 If you have columns such as:
1110 created_dtm AS getdate()
1112 represent them in your Result classes as:
1116 default_value => \'getdate()',
1120 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1121 on tables with such columns.
1123 =head1 TIMESTAMP COLUMNS
1125 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1126 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1128 They should be defined in your Result classes as:
1131 data_type => 'timestamp',
1133 inflate_datetime => 0,
1136 The C<<inflate_datetime => 0>> is necessary if you use
1137 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1138 be able to read these values.
1140 The values will come back as hexadecimal.
1148 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1149 any active cursors, using eager cursors.
1153 Real limits and limited counts using stored procedures deployed on startup.
1157 Adaptive Server Anywhere (ASA) support
1161 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1165 bulk_insert using prepare_cached (see comments.)
1171 See L<DBIx::Class/CONTRIBUTORS>.
1175 You may distribute this code under the same terms as Perl itself.