1 package DBIx::Class::Storage::DBI::Sybase;
7 DBIx::Class::Storage::DBI::Sybase::Common
8 DBIx::Class::Storage::DBI::AutoCast
11 use Carp::Clan qw/^DBIx::Class/;
15 __PACKAGE__->mk_group_accessors('simple' =>
16 qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
17 _bulk_storage _is_bulk_storage _began_bulk_work
18 _bulk_disabled_due_to_coderef_connect_info_warned
22 my @also_proxy_to_extra_storages = qw/
23 connect_call_set_auto_cast auto_cast connect_call_blob_setup
24 connect_call_datetime_setup
26 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
27 auto_savepoint unsafe cursor_class debug debugobj schema
32 DBIx::Class::Storage::DBI::Sybase - Sybase support for DBIx::Class
36 This subclass supports L<DBD::Sybase> for real Sybase databases. If you are
37 using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
38 L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
42 If your version of Sybase does not support placeholders, then your storage
43 will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
44 also enable that driver explicitly, see the documentation for more details.
46 With this driver there is unfortunately no way to get the C<last_insert_id>
47 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
48 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
50 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
52 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
61 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
63 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
68 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
70 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
71 bless $self, $subclass;
73 } else { # real Sybase
74 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
76 if ($self->using_freetds) {
77 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
79 You are using FreeTDS with Sybase.
81 We will do our best to support this configuration, but please consider this
84 TEXT/IMAGE columns will definitely not work.
86 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
89 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
91 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
94 if (not $self->_typeless_placeholders_supported) {
95 if ($self->_placeholders_supported) {
98 $self->ensure_class_loaded($no_bind_vars);
99 bless $self, $no_bind_vars;
104 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
105 # not necessarily FreeTDS, but no placeholders nevertheless
106 $self->ensure_class_loaded($no_bind_vars);
107 bless $self, $no_bind_vars;
109 } elsif (not $self->_typeless_placeholders_supported) {
110 # this is highly unlikely, but we check just in case
119 $self->_set_max_connect(256);
121 # based on LongReadLen in connect_info
122 $self->set_textsize if $self->using_freetds;
124 # create storage for insert/(update blob) transactions,
125 # unless this is that storage
126 return if $self->_is_extra_storage;
128 my $writer_storage = (ref $self)->new;
130 $writer_storage->_is_extra_storage(1);
131 $writer_storage->connect_info($self->connect_info);
132 $writer_storage->auto_cast($self->auto_cast);
134 $self->_writer_storage($writer_storage);
136 # create a bulk storage unless connect_info is a coderef
138 if (Scalar::Util::reftype($self->_dbi_connect_info->[0])||'') eq 'CODE';
140 my $bulk_storage = (ref $self)->new;
142 $bulk_storage->_is_extra_storage(1);
143 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
144 $bulk_storage->connect_info($self->connect_info);
147 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
149 $self->_bulk_storage($bulk_storage);
152 for my $method (@also_proxy_to_extra_storages) {
154 no warnings 'redefine';
156 my $replaced = __PACKAGE__->can($method);
158 *{$method} = Sub::Name::subname $method => sub {
160 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
161 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
162 return $self->$replaced(@_);
169 # Even though we call $sth->finish for uses off the bulk API, there's still an
170 # "active statement" warning on disconnect, which we throw away here.
171 # This is due to the bug described in insert_bulk.
172 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
173 local $SIG{__WARN__} = sub {
174 warn $_[0] unless $_[0] =~ /active statement/i;
175 } if $self->_is_bulk_storage;
177 # so that next transaction gets a dbh
178 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
183 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
184 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
185 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
186 # only want when AutoCommit is off.
190 $self->next::method(@_);
192 if ($self->_is_bulk_storage) {
193 # this should be cleared on every reconnect
194 $self->_began_bulk_work(0);
198 if (not $self->using_freetds) {
199 $self->_dbh->{syb_chained_txn} = 1;
201 if ($self->_dbh_autocommit) {
202 $self->_dbh->do('SET CHAINED OFF');
204 $self->_dbh->do('SET CHAINED ON');
209 =head2 connect_call_blob_setup
213 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
215 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
216 instead of as a hex string.
220 Also sets the C<log_on_update> value for blob write operations. The default is
221 C<1>, but C<0> is better if your database is configured for it.
224 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
228 sub connect_call_blob_setup {
231 my $dbh = $self->_dbh;
232 $dbh->{syb_binary_images} = 1;
234 $self->_blob_log_on_update($args{log_on_update})
235 if exists $args{log_on_update};
241 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
245 my ($self, $source, $column) = @_;
247 return $self->_is_lob_type($source->column_info($column)->{data_type});
250 sub _prep_for_execute {
252 my ($op, $extra_bind, $ident, $args) = @_;
254 my ($sql, $bind) = $self->next::method (@_);
256 if ($op eq 'insert') {
257 my $table = $ident->from;
259 my $bind_info = $self->_resolve_column_info(
260 $ident, [map $_->[0], @{$bind}]
262 my $identity_col = List::Util::first
263 { $bind_info->{$_}{is_auto_increment} }
269 "SET IDENTITY_INSERT $table ON",
271 "SET IDENTITY_INSERT $table OFF",
275 $identity_col = List::Util::first
276 { $ident->column_info($_)->{is_auto_increment} }
284 $self->_fetch_identity_sql($ident, $identity_col);
288 return ($sql, $bind);
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 $blob_cols = $self->_remove_blob_cols($source, $to_insert);
352 my $identity_col = List::Util::first
353 { $source->column_info($_)->{is_auto_increment} }
356 # do we need the horrific SELECT MAX(COL) hack?
357 my $dumb_last_insert_id =
359 && (not exists $to_insert->{$identity_col})
360 && ($self->_identity_method||'') ne '@@IDENTITY';
362 my $next = $self->next::can;
364 # we are already in a transaction, or there are no blobs
365 # and we don't need the PK - just (try to) do it
366 if ($self->{transaction_depth}
367 || (!$blob_cols && !$dumb_last_insert_id)
369 return $self->_insert (
370 $next, $source, $to_insert, $blob_cols, $identity_col
374 # otherwise use the _writer_storage to do the insert+transaction on another
376 my $guard = $self->_writer_storage->txn_scope_guard;
378 my $updated_cols = $self->_writer_storage->_insert (
379 $next, $source, $to_insert, $blob_cols, $identity_col
382 $self->_identity($self->_writer_storage->_identity);
386 return $updated_cols;
390 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
392 my $updated_cols = $self->$next ($source, $to_insert);
395 $identity_col => $self->last_insert_id($source, $identity_col),
400 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
402 return $updated_cols;
407 my ($source, $fields, $where, @rest) = @_;
409 my $wantarray = wantarray;
411 my $blob_cols = $self->_remove_blob_cols($source, $fields);
413 my $table = $source->name;
415 my $identity_col = List::Util::first
416 { $source->column_info($_)->{is_auto_increment} }
419 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
421 if (not $blob_cols) {
422 $self->_set_session_identity(UPDATE => $table, 'ON')
423 if $is_identity_update;
425 return $self->next::method(@_);
427 $self->_set_session_identity(UPDATE => $table, 'OFF')
428 if $is_identity_update;
431 # If there are any blobs in $where, Sybase will return a descriptive error
434 # update+blob update(s) done atomically on separate connection
435 $self = $self->_writer_storage;
437 my $guard = $self->txn_scope_guard;
439 # First update the blob columns to be updated to '' (taken from $fields, where
440 # it is originally put by _remove_blob_cols .)
441 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
443 $self->next::method($source, \%blobs_to_empty, $where, @rest);
445 # Now update the blobs before the other columns in case the update of other
446 # columns makes the search condition invalid.
447 $self->_update_blobs($source, $blob_cols, $where);
451 $self->_set_session_identity(UPDATE => $table, 'ON')
452 if $is_identity_update;
455 @res = $self->next::method(@_);
457 elsif (defined $wantarray) {
458 $res[0] = $self->next::method(@_);
461 $self->next::method(@_);
464 $self->_set_session_identity(UPDATE => $table, 'OFF')
465 if $is_identity_update;
470 return $wantarray ? @res : $res[0];
473 # for IDENTITY_INSERT / IDENTITY_UPDATE
474 sub _set_session_identity {
475 my ($self, $op, $table, $off_on) = @_;
478 'SET IDENTITY_%s %s %s',
480 $self->sql_maker->_quote($table),
484 $self->_query_start($sql);
486 my $dbh = $self->_get_dbh;
488 local $dbh->{RaiseError} = 1;
489 local $dbh->{PrintError} = 0;
494 $self->_query_end($sql);
497 $self->throw_exception (sprintf "Error executing '%s': %s",
506 my ($source, $cols, $data) = @_;
508 my $identity_col = List::Util::first
509 { $source->column_info($_)->{is_auto_increment} }
512 my $is_identity_insert = (List::Util::first
513 { $_ eq $identity_col }
517 my @source_columns = $source->columns;
520 $self->_bulk_storage &&
521 $self->_get_dbh->{syb_has_blk};
523 if ((not $use_bulk_api) &&
524 (Scalar::Util::reftype($self->_dbi_connect_info->[0])||'') eq 'CODE' &&
525 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
527 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
528 regular array inserts.
530 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
533 if (not $use_bulk_api) {
534 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
536 ($self, my ($guard)) = do {
537 if ($self->{transaction_depth} == 0 && $blob_cols) {
538 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard);
545 $self->next::method(@_);
548 if ($is_identity_insert) {
549 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
552 my @cols_with_identities = (@$cols, $identity_col);
554 ## calculate identities
555 # XXX This assumes identities always increase by 1, which may or may not
557 my ($last_identity) =
558 $self->_dbh->selectrow_array (
559 $self->_fetch_identity_sql($source, $identity_col)
561 my @identities = (($last_identity - @$data + 1) .. $last_identity);
563 my @data_with_identities = map [@$_, shift @identities], @$data;
565 $self->_insert_blobs_array (
566 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
571 $guard->commit if $guard;
575 # otherwise, use the bulk API
577 # rearrange @$data so that columns are in database order
579 @orig_idx{@$cols} = 0..$#$cols;
582 @new_idx{@source_columns} = 0..$#source_columns;
585 for my $datum (@$data) {
587 for my $col (@source_columns) {
588 # identity data will be 'undef' if not $is_identity_insert
589 # columns with defaults will also be 'undef'
590 $new_datum->[ $new_idx{$col} ] =
591 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
593 push @new_data, $new_datum;
596 # bcp identity index is 1-based
597 my $identity_idx = exists $new_idx{$identity_col} ?
598 $new_idx{$identity_col} + 1 : 0;
600 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
601 # This ignores any data conversion errors detected by the client side libs, as
602 # they are usually harmless.
603 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
604 Sub::Name::subname insert_bulk => sub {
605 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
607 return 1 if $errno == 36;
610 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
611 ($errmsg ? "\n$errmsg" : '') .
612 ($osmsg ? "\n$osmsg" : '') .
613 ($blkmsg ? "\n$blkmsg" : '');
619 my $bulk = $self->_bulk_storage;
621 my $guard = $bulk->txn_scope_guard;
623 ## XXX get this to work instead of our own $sth
624 ## will require SQLA or *Hacks changes for ordered columns
625 # $bulk->next::method($source, \@source_columns, \@new_data, {
626 # syb_bcp_attribs => {
627 # identity_flag => $is_identity_insert,
628 # identity_column => $identity_idx,
631 my $sql = 'INSERT INTO ' .
632 $bulk->sql_maker->_quote($source->name) . ' (' .
633 # colname list is ignored for BCP, but does no harm
634 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
635 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
637 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
638 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
639 ## better yet the version above. Should be fixed in DBD::Sybase .
640 my $sth = $bulk->_get_dbh->prepare($sql,
644 identity_flag => $is_identity_insert,
645 identity_column => $identity_idx,
652 map [ $_, $idx++ ], @source_columns;
655 $self->_execute_array(
656 $source, $sth, \@bind, \@source_columns, \@new_data, $guard
659 $bulk->_query_end($sql);
662 if ($exception =~ /-Y option/) {
665 Sybase bulk API operation failed due to character set incompatibility, reverting
666 to regular array inserts:
668 *** Try unsetting the LANG environment variable.
672 $self->_bulk_storage(undef);
673 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
678 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
679 # rollback makes the bulkLogin connection unusable
680 $self->_bulk_storage->disconnect;
681 $self->throw_exception($exception);
684 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
687 # Make sure blobs are not bound as placeholders, and return any non-empty ones
689 sub _remove_blob_cols {
690 my ($self, $source, $fields) = @_;
694 for my $col (keys %$fields) {
695 if ($self->_is_lob_column($source, $col)) {
696 my $blob_val = delete $fields->{$col};
697 if (not defined $blob_val) {
698 $fields->{$col} = \'NULL';
701 $fields->{$col} = \"''";
702 $blob_cols{$col} = $blob_val unless $blob_val eq '';
707 return keys %blob_cols ? \%blob_cols : undef;
710 # same for insert_bulk
711 sub _remove_blob_cols_array {
712 my ($self, $source, $cols, $data) = @_;
716 for my $i (0..$#$cols) {
717 my $col = $cols->[$i];
719 if ($self->_is_lob_column($source, $col)) {
720 for my $j (0..$#$data) {
721 my $blob_val = delete $data->[$j][$i];
722 if (not defined $blob_val) {
723 $data->[$j][$i] = \'NULL';
726 $data->[$j][$i] = \"''";
727 $blob_cols[$j][$i] = $blob_val
728 unless $blob_val eq '';
734 return @blob_cols ? \@blob_cols : undef;
738 my ($self, $source, $blob_cols, $where) = @_;
740 my (@primary_cols) = $source->primary_columns;
742 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
743 unless @primary_cols;
745 # check if we're updating a single row by PK
746 my $pk_cols_in_where = 0;
747 for my $col (@primary_cols) {
748 $pk_cols_in_where++ if defined $where->{$col};
752 if ($pk_cols_in_where == @primary_cols) {
754 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
755 @rows = \%row_to_update;
757 my $cursor = $self->select ($source, \@primary_cols, $where, {});
759 my %row; @row{@primary_cols} = @$_; \%row
763 for my $row (@rows) {
764 $self->_insert_blobs($source, $blob_cols, $row);
769 my ($self, $source, $blob_cols, $row) = @_;
770 my $dbh = $self->_get_dbh;
772 my $table = $source->name;
775 my (@primary_cols) = $source->primary_columns;
777 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
778 unless @primary_cols;
780 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
781 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
783 for my $col (keys %$blob_cols) {
784 my $blob = $blob_cols->{$col};
786 my %where = map { ($_, $row{$_}) } @primary_cols;
788 my $cursor = $self->select ($source, [$col], \%where, {});
790 my $sth = $cursor->sth;
794 $self->throw_exception(
795 "Could not find row in table '$table' for blob update:\n"
796 . $self->_pretty_print (\%where)
802 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
805 $sth->func('ct_prepare_send') or die $sth->errstr;
807 my $log_on_update = $self->_blob_log_on_update;
808 $log_on_update = 1 if not defined $log_on_update;
810 $sth->func('CS_SET', 1, {
811 total_txtlen => length($blob),
812 log_on_update => $log_on_update
813 }, 'ct_data_info') or die $sth->errstr;
815 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
817 $sth->func('ct_finish_send') or die $sth->errstr;
820 $sth->finish if $sth;
822 if ($self->using_freetds) {
823 $self->throw_exception (
824 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
828 $self->throw_exception($exception);
834 sub _insert_blobs_array {
835 my ($self, $source, $blob_cols, $cols, $data) = @_;
837 for my $i (0..$#$data) {
838 my $datum = $data->[$i];
841 @row{ @$cols } = @$datum;
844 for my $j (0..$#$cols) {
845 if (exists $blob_cols->[$i][$j]) {
846 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
850 $self->_insert_blobs ($source, \%blob_vals, \%row);
854 =head2 connect_call_datetime_setup
858 on_connect_call => 'datetime_setup'
860 In L<DBIx::Class::Storage::DBI/connect_info> to set:
862 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
863 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
865 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
866 L<DateTime::Format::Sybase>, which you will need to install.
868 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
869 C<SMALLDATETIME> columns only have minute precision.
874 my $old_dbd_warned = 0;
876 sub connect_call_datetime_setup {
878 my $dbh = $self->_dbh;
880 if ($dbh->can('syb_date_fmt')) {
881 # amazingly, this works with FreeTDS
882 $dbh->syb_date_fmt('ISO_strict');
883 } elsif (not $old_dbd_warned) {
884 carp "Your DBD::Sybase is too old to support ".
885 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
889 $dbh->do('SET DATEFORMAT mdy');
895 sub datetime_parser_type { "DateTime::Format::Sybase" }
897 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
898 # let the DBD keep any state it needs to.
900 # If they ever do start working, the extra statements will do no harm (because
901 # Sybase supports nested transactions.)
903 sub _dbh_begin_work {
906 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
907 # TRAN once. However, we need to make sure there's a $dbh.
908 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
910 $self->next::method(@_);
912 if ($self->using_freetds) {
913 $self->_get_dbh->do('BEGIN TRAN');
916 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
921 if ($self->using_freetds) {
922 $self->_dbh->do('COMMIT');
924 return $self->next::method(@_);
929 if ($self->using_freetds) {
930 $self->_dbh->do('ROLLBACK');
932 return $self->next::method(@_);
935 # savepoint support using ASE syntax
938 my ($self, $name) = @_;
940 $self->_get_dbh->do("SAVE TRANSACTION $name");
943 # A new SAVE TRANSACTION with the same name releases the previous one.
944 sub _svp_release { 1 }
947 my ($self, $name) = @_;
949 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
954 =head1 Schema::Loader Support
956 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
957 allow you to dump a schema from most (if not all) versions of Sybase.
959 It is available via subversion from:
961 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
965 This driver supports L<DBD::Sybase> compiled against FreeTDS
966 (L<http://www.freetds.org/>) to the best of our ability, however it is
967 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
968 libraries. They are a part of the Sybase ASE distribution:
970 The Open Client FAQ is here:
971 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
973 Sybase ASE for Linux (which comes with the Open Client libraries) may be
974 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
976 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
978 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
980 Some versions of the libraries involved will not support placeholders, in which
981 case the storage will be reblessed to
982 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
984 In some configurations, placeholders will work but will throw implicit type
985 conversion errors for anything that's not expecting a string. In such a case,
986 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
987 automatically set, which you may enable on connection with
988 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
989 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
990 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
991 already) using a mapping based on L<SQL::Translator>.
993 In other configurations, placeholers will work just as they do with the Sybase
994 Open Client libraries.
996 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
998 =head1 INSERTS WITH PLACEHOLDERS
1000 With placeholders enabled, inserts are done in a transaction so that there are
1001 no concurrency issues with getting the inserted identity value using
1002 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
1005 In addition, they are done on a separate connection so that it's possible to
1006 have active cursors when doing an insert.
1008 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
1009 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
1014 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
1015 begin a transaction while there are active cursors; nor can you use multiple
1016 active cursors within a transaction. An active cursor is, for example, a
1017 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1018 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1020 For example, this will not work:
1022 $schema->txn_do(sub {
1023 my $rs = $schema->resultset('Book');
1024 while (my $row = $rs->next) {
1025 $schema->resultset('MetaData')->create({
1026 book_id => $row->id,
1034 my $first_row = $large_rs->first;
1035 $schema->txn_do(sub { ... });
1037 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1038 are not affected, as they are done on an extra database handle.
1044 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1046 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1048 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1052 =head1 MAXIMUM CONNECTIONS
1054 The TDS protocol makes separate connections to the server for active statements
1055 in the background. By default the number of such connections is limited to 25,
1056 on both the client side and the server side.
1058 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1059 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1060 can override it to whatever setting you like in the DSN.
1063 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1064 for information on changing the setting on the server side.
1068 See L</connect_call_datetime_setup> to setup date formats
1069 for L<DBIx::Class::InflateColumn::DateTime>.
1071 =head1 TEXT/IMAGE COLUMNS
1073 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1074 C<TEXT/IMAGE> columns.
1076 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1078 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1082 $schema->storage->set_textsize($bytes);
1086 However, the C<LongReadLen> you pass in
1087 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
1088 C<SET TEXTSIZE> command on connection.
1090 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
1091 setting you need to work with C<IMAGE> columns.
1095 The experimental L<DBD::Sybase> Bulk API support is used for
1096 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1097 on a separate connection.
1099 To use this feature effectively, use a large number of rows for each
1100 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1102 while (my $rows = $data_source->get_100_rows()) {
1103 $rs->populate($rows);
1106 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1107 calls in your C<Result> classes B<must> list columns in database order for this
1108 to work. Also, you may have to unset the C<LANG> environment variable before
1109 loading your app, if it doesn't match the character set of your database.
1111 When inserting IMAGE columns using this method, you'll need to use
1112 L</connect_call_blob_setup> as well.
1116 See L<DBIx::Class/CONTRIBUTORS>.
1120 You may distribute this code under the same terms as Perl itself.