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 my $table = Scalar::Util::blessed($ident) ? $ident->from : $ident;
258 my $bind_info = $self->_resolve_column_info(
259 $ident, [map $_->[0], @{$bind}]
261 my $bound_identity_col = List::Util::first
262 { $bind_info->{$_}{is_auto_increment} }
265 my $identity_col = Scalar::Util::blessed($ident) &&
267 { $ident->column_info($_)->{is_auto_increment} }
271 if (($op eq 'insert' && $bound_identity_col) ||
272 ($op eq 'update' && exists $args->[0]{$identity_col})) {
274 $self->_set_table_identity_sql($op => $table, 'on'),
276 $self->_set_table_identity_sql($op => $table, 'off'),
280 if ($op eq 'insert' && (not $bound_identity_col) && $identity_col) {
283 $self->_fetch_identity_sql($ident, $identity_col);
286 return ($sql, $bind);
289 sub _set_table_identity_sql {
290 my ($self, $op, $table, $on_off) = @_;
292 return sprintf 'SET IDENTITY_%s %s %s',
293 uc($op), $self->sql_maker->_quote($table), uc($on_off);
296 # Stolen from SQLT, with some modifications. This is a makeshift
297 # solution before a sane type-mapping library is available, thus
298 # the 'our' for easy overrides.
299 our %TYPE_MAPPING = (
302 varchar => 'varchar',
303 varchar2 => 'varchar',
304 timestamp => 'datetime',
306 real => 'double precision',
309 tinyint => 'smallint',
310 float => 'double precision',
312 bigserial => 'numeric',
313 boolean => 'varchar',
317 sub _native_data_type {
318 my ($self, $type) = @_;
321 $type =~ s/\s* identity//x;
323 return uc($TYPE_MAPPING{$type} || $type);
326 sub _fetch_identity_sql {
327 my ($self, $source, $col) = @_;
329 return sprintf ("SELECT MAX(%s) FROM %s",
330 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
338 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
340 if ($op eq 'insert') {
341 $self->_identity($sth->fetchrow_array);
345 return wantarray ? ($rv, $sth, @bind) : $rv;
348 sub last_insert_id { shift->_identity }
350 # handles TEXT/IMAGE and transaction for last_insert_id
353 my ($source, $to_insert) = @_;
355 my $identity_col = (List::Util::first
356 { $source->column_info($_)->{is_auto_increment} }
357 $source->columns) || '';
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)
362 if (not %$to_insert) {
363 for my $col ($source->columns) {
364 next if $col eq $identity_col;
365 $to_insert->{$col} = \'DEFAULT';
369 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
371 # do we need the horrific SELECT MAX(COL) hack?
372 my $dumb_last_insert_id =
374 && (not exists $to_insert->{$identity_col})
375 && ($self->_identity_method||'') ne '@@IDENTITY';
377 my $next = $self->next::can;
379 # we are already in a transaction, or there are no blobs
380 # and we don't need the PK - just (try to) do it
381 if ($self->{transaction_depth}
382 || (!$blob_cols && !$dumb_last_insert_id)
384 return $self->_insert (
385 $next, $source, $to_insert, $blob_cols, $identity_col
389 # otherwise use the _writer_storage to do the insert+transaction on another
391 my $guard = $self->_writer_storage->txn_scope_guard;
393 my $updated_cols = $self->_writer_storage->_insert (
394 $next, $source, $to_insert, $blob_cols, $identity_col
397 $self->_identity($self->_writer_storage->_identity);
401 return $updated_cols;
405 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
407 my $updated_cols = $self->$next ($source, $to_insert);
411 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
416 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
418 return $updated_cols;
423 my ($source, $fields, $where, @rest) = @_;
425 my $wantarray = wantarray;
427 my $blob_cols = $self->_remove_blob_cols($source, $fields);
429 my $table = $source->name;
431 my $identity_col = List::Util::first
432 { $source->column_info($_)->{is_auto_increment} }
435 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
437 return $self->next::method(@_) unless $blob_cols;
439 # If there are any blobs in $where, Sybase will return a descriptive error
441 # XXX blobs can still be used with a LIKE query, and this should be handled.
443 # update+blob update(s) done atomically on separate connection
444 $self = $self->_writer_storage;
446 my $guard = $self->txn_scope_guard;
448 # First update the blob columns to be updated to '' (taken from $fields, where
449 # it is originally put by _remove_blob_cols .)
450 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
452 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
454 $self->next::method($source, \%blobs_to_empty, $where, @rest);
456 # Now update the blobs before the other columns in case the update of other
457 # columns makes the search condition invalid.
458 $self->_update_blobs($source, $blob_cols, $where);
463 @res = $self->next::method(@_);
465 elsif (defined $wantarray) {
466 $res[0] = $self->next::method(@_);
469 $self->next::method(@_);
475 return $wantarray ? @res : $res[0];
480 my ($source, $cols, $data) = @_;
482 my $identity_col = List::Util::first
483 { $source->column_info($_)->{is_auto_increment} }
486 my $is_identity_insert = (List::Util::first
487 { $_ eq $identity_col }
491 my @source_columns = $source->columns;
494 $self->_bulk_storage &&
495 $self->_get_dbh->{syb_has_blk};
497 if ((not $use_bulk_api) &&
498 (Scalar::Util::reftype($self->_dbi_connect_info->[0])||'') eq 'CODE' &&
499 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
501 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
502 regular array inserts.
504 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
507 if (not $use_bulk_api) {
508 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
510 my $dumb_last_insert_id =
512 && (not $is_identity_insert)
513 && ($self->_identity_method||'') ne '@@IDENTITY';
515 $self = $self->_writer_storage;
516 my $guard = $self->txn_scope_guard;
518 $self->next::method(@_);
521 if ($is_identity_insert) {
522 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
525 my @cols_with_identities = (@$cols, $identity_col);
527 ## calculate identities
528 # XXX This assumes identities always increase by 1, which may or may not
530 my ($last_identity) =
531 $self->_dbh->selectrow_array (
532 $self->_fetch_identity_sql($source, $identity_col)
534 my @identities = (($last_identity - @$data + 1) .. $last_identity);
536 my @data_with_identities = map [@$_, shift @identities], @$data;
538 $self->_insert_blobs_array (
539 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
548 # otherwise, use the bulk API
550 # rearrange @$data so that columns are in database order
552 @orig_idx{@$cols} = 0..$#$cols;
555 @new_idx{@source_columns} = 0..$#source_columns;
558 for my $datum (@$data) {
560 for my $col (@source_columns) {
561 # identity data will be 'undef' if not $is_identity_insert
562 # columns with defaults will also be 'undef'
563 $new_datum->[ $new_idx{$col} ] =
564 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
566 push @new_data, $new_datum;
569 # bcp identity index is 1-based
570 my $identity_idx = exists $new_idx{$identity_col} ?
571 $new_idx{$identity_col} + 1 : 0;
573 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
574 # This ignores any data conversion errors detected by the client side libs, as
575 # they are usually harmless.
576 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
577 Sub::Name::subname insert_bulk => sub {
578 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
580 return 1 if $errno == 36;
583 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
584 ($errmsg ? "\n$errmsg" : '') .
585 ($osmsg ? "\n$osmsg" : '') .
586 ($blkmsg ? "\n$blkmsg" : '');
592 my $bulk = $self->_bulk_storage;
594 my $guard = $bulk->txn_scope_guard;
596 ## XXX get this to work instead of our own $sth
597 ## will require SQLA or *Hacks changes for ordered columns
598 # $bulk->next::method($source, \@source_columns, \@new_data, {
599 # syb_bcp_attribs => {
600 # identity_flag => $is_identity_insert,
601 # identity_column => $identity_idx,
604 my $sql = 'INSERT INTO ' .
605 $bulk->sql_maker->_quote($source->name) . ' (' .
606 # colname list is ignored for BCP, but does no harm
607 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
608 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
610 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
611 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
612 ## better yet the version above. Should be fixed in DBD::Sybase .
613 my $sth = $bulk->_get_dbh->prepare($sql,
617 identity_flag => $is_identity_insert,
618 identity_column => $identity_idx,
625 map [ $_, $idx++ ], @source_columns;
628 $self->_execute_array(
629 $source, $sth, \@bind, \@source_columns, \@new_data, sub {
634 $bulk->_query_end($sql);
638 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
640 if ($exception =~ /-Y option/) {
643 Sybase bulk API operation failed due to character set incompatibility, reverting
644 to regular array inserts:
646 *** Try unsetting the LANG environment variable.
650 $self->_bulk_storage(undef);
655 # rollback makes the bulkLogin connection unusable
656 $self->_bulk_storage->disconnect;
657 $self->throw_exception($exception);
661 # Sybase is very sensitive to this.
662 sub _exhaust_statements { 1 }
664 # Make sure blobs are not bound as placeholders, and return any non-empty ones
666 sub _remove_blob_cols {
667 my ($self, $source, $fields) = @_;
671 for my $col (keys %$fields) {
672 if ($self->_is_lob_column($source, $col)) {
673 my $blob_val = delete $fields->{$col};
674 if (not defined $blob_val) {
675 $fields->{$col} = \'NULL';
678 $fields->{$col} = \"''";
679 $blob_cols{$col} = $blob_val unless $blob_val eq '';
684 return %blob_cols ? \%blob_cols : undef;
687 # same for insert_bulk
688 sub _remove_blob_cols_array {
689 my ($self, $source, $cols, $data) = @_;
693 for my $i (0..$#$cols) {
694 my $col = $cols->[$i];
696 if ($self->_is_lob_column($source, $col)) {
697 for my $j (0..$#$data) {
698 my $blob_val = delete $data->[$j][$i];
699 if (not defined $blob_val) {
700 $data->[$j][$i] = \'NULL';
703 $data->[$j][$i] = \"''";
704 $blob_cols[$j][$i] = $blob_val
705 unless $blob_val eq '';
711 return @blob_cols ? \@blob_cols : undef;
715 my ($self, $source, $blob_cols, $where) = @_;
717 my (@primary_cols) = $source->primary_columns;
719 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
720 unless @primary_cols;
722 # check if we're updating a single row by PK
723 my $pk_cols_in_where = 0;
724 for my $col (@primary_cols) {
725 $pk_cols_in_where++ if defined $where->{$col};
729 if ($pk_cols_in_where == @primary_cols) {
731 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
732 @rows = \%row_to_update;
734 my $cursor = $self->select ($source, \@primary_cols, $where, {});
736 my %row; @row{@primary_cols} = @$_; \%row
740 for my $row (@rows) {
741 $self->_insert_blobs($source, $blob_cols, $row);
746 my ($self, $source, $blob_cols, $row) = @_;
747 my $dbh = $self->_get_dbh;
749 my $table = $source->name;
752 my (@primary_cols) = $source->primary_columns;
754 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
755 unless @primary_cols;
757 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
758 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
760 for my $col (keys %$blob_cols) {
761 my $blob = $blob_cols->{$col};
763 my %where = map { ($_, $row{$_}) } @primary_cols;
765 my $cursor = $self->select ($source, [$col], \%where, {});
767 my $sth = $cursor->sth;
771 $self->throw_exception(
772 "Could not find row in table '$table' for blob update:\n"
773 . $self->_pretty_print (\%where)
779 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
782 $sth->func('ct_prepare_send') or die $sth->errstr;
784 my $log_on_update = $self->_blob_log_on_update;
785 $log_on_update = 1 if not defined $log_on_update;
787 $sth->func('CS_SET', 1, {
788 total_txtlen => length($blob),
789 log_on_update => $log_on_update
790 }, 'ct_data_info') or die $sth->errstr;
792 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
794 $sth->func('ct_finish_send') or die $sth->errstr;
797 $sth->finish if $sth;
799 if ($self->using_freetds) {
800 $self->throw_exception (
801 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
805 $self->throw_exception($exception);
811 sub _insert_blobs_array {
812 my ($self, $source, $blob_cols, $cols, $data) = @_;
814 for my $i (0..$#$data) {
815 my $datum = $data->[$i];
818 @row{ @$cols } = @$datum;
821 for my $j (0..$#$cols) {
822 if (exists $blob_cols->[$i][$j]) {
823 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
827 $self->_insert_blobs ($source, \%blob_vals, \%row);
831 =head2 connect_call_datetime_setup
835 on_connect_call => 'datetime_setup'
837 In L<DBIx::Class::Storage::DBI/connect_info> to set:
839 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
840 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
842 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
843 L<DateTime::Format::Sybase>, which you will need to install.
845 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
846 C<SMALLDATETIME> columns only have minute precision.
851 my $old_dbd_warned = 0;
853 sub connect_call_datetime_setup {
855 my $dbh = $self->_get_dbh;
857 if ($dbh->can('syb_date_fmt')) {
858 # amazingly, this works with FreeTDS
859 $dbh->syb_date_fmt('ISO_strict');
860 } elsif (not $old_dbd_warned) {
861 carp "Your DBD::Sybase is too old to support ".
862 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
866 $dbh->do('SET DATEFORMAT mdy');
872 sub datetime_parser_type { "DateTime::Format::Sybase" }
874 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
875 # let the DBD keep any state it needs to.
877 # If they ever do start working, the extra statements will do no harm (because
878 # Sybase supports nested transactions.)
880 sub _dbh_begin_work {
883 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
884 # TRAN once. However, we need to make sure there's a $dbh.
885 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
887 $self->next::method(@_);
889 if ($self->using_freetds) {
890 $self->_get_dbh->do('BEGIN TRAN');
893 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
898 if ($self->using_freetds) {
899 $self->_dbh->do('COMMIT');
901 return $self->next::method(@_);
906 if ($self->using_freetds) {
907 $self->_dbh->do('ROLLBACK');
909 return $self->next::method(@_);
912 # savepoint support using ASE syntax
915 my ($self, $name) = @_;
917 $self->_get_dbh->do("SAVE TRANSACTION $name");
920 # A new SAVE TRANSACTION with the same name releases the previous one.
921 sub _svp_release { 1 }
924 my ($self, $name) = @_;
926 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
931 =head1 Schema::Loader Support
933 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
934 allow you to dump a schema from most (if not all) versions of Sybase.
936 It is available via subversion from:
938 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
942 This driver supports L<DBD::Sybase> compiled against FreeTDS
943 (L<http://www.freetds.org/>) to the best of our ability, however it is
944 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
945 libraries. They are a part of the Sybase ASE distribution:
947 The Open Client FAQ is here:
948 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
950 Sybase ASE for Linux (which comes with the Open Client libraries) may be
951 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
953 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
955 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
957 Some versions of the libraries involved will not support placeholders, in which
958 case the storage will be reblessed to
959 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
961 In some configurations, placeholders will work but will throw implicit type
962 conversion errors for anything that's not expecting a string. In such a case,
963 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
964 automatically set, which you may enable on connection with
965 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
966 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
967 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
968 already) using a mapping based on L<SQL::Translator>.
970 In other configurations, placeholers will work just as they do with the Sybase
971 Open Client libraries.
973 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
975 =head1 INSERTS WITH PLACEHOLDERS
977 With placeholders enabled, inserts are done in a transaction so that there are
978 no concurrency issues with getting the inserted identity value using
979 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
982 In addition, they are done on a separate connection so that it's possible to
983 have active cursors when doing an insert.
985 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
986 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
991 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
992 begin a transaction while there are active cursors; nor can you use multiple
993 active cursors within a transaction. An active cursor is, for example, a
994 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
995 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
997 For example, this will not work:
999 $schema->txn_do(sub {
1000 my $rs = $schema->resultset('Book');
1001 while (my $row = $rs->next) {
1002 $schema->resultset('MetaData')->create({
1003 book_id => $row->id,
1011 my $first_row = $large_rs->first;
1012 $schema->txn_do(sub { ... });
1014 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1015 are not affected, as they are done on an extra database handle.
1021 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1023 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1025 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1029 =head1 MAXIMUM CONNECTIONS
1031 The TDS protocol makes separate connections to the server for active statements
1032 in the background. By default the number of such connections is limited to 25,
1033 on both the client side and the server side.
1035 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1036 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1037 can override it to whatever setting you like in the DSN.
1040 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1041 for information on changing the setting on the server side.
1045 See L</connect_call_datetime_setup> to setup date formats
1046 for L<DBIx::Class::InflateColumn::DateTime>.
1048 =head1 TEXT/IMAGE COLUMNS
1050 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1051 C<TEXT/IMAGE> columns.
1053 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1055 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1059 $schema->storage->set_textsize($bytes);
1063 However, the C<LongReadLen> you pass in
1064 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
1065 C<SET TEXTSIZE> command on connection.
1067 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
1068 setting you need to work with C<IMAGE> columns.
1072 The experimental L<DBD::Sybase> Bulk API support is used for
1073 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1074 on a separate connection.
1076 To use this feature effectively, use a large number of rows for each
1077 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1079 while (my $rows = $data_source->get_100_rows()) {
1080 $rs->populate($rows);
1083 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1084 calls in your C<Result> classes B<must> list columns in database order for this
1085 to work. Also, you may have to unset the C<LANG> environment variable before
1086 loading your app, if it doesn't match the character set of your database.
1088 When inserting IMAGE columns using this method, you'll need to use
1089 L</connect_call_blob_setup> as well.
1097 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1098 any active cursors, using eager cursors.
1102 Real limits and limited counts using stored procedures deployed on startup.
1106 Adaptive Server Anywhere (ASA) support, with possible SQLA::Limit support.
1110 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1114 bulk_insert using prepare_cached (see comments.)
1120 See L<DBIx::Class/CONTRIBUTORS>.
1124 You may distribute this code under the same terms as Perl itself.