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 &&
281 (not $self->{insert_bulk})) {
284 $self->_fetch_identity_sql($ident, $identity_col);
287 return ($sql, $bind);
290 sub _set_table_identity_sql {
291 my ($self, $op, $table, $on_off) = @_;
293 return sprintf 'SET IDENTITY_%s %s %s',
294 uc($op), $self->sql_maker->_quote($table), uc($on_off);
297 # Stolen from SQLT, with some modifications. This is a makeshift
298 # solution before a sane type-mapping library is available, thus
299 # the 'our' for easy overrides.
300 our %TYPE_MAPPING = (
303 varchar => 'varchar',
304 varchar2 => 'varchar',
305 timestamp => 'datetime',
307 real => 'double precision',
310 tinyint => 'smallint',
311 float => 'double precision',
313 bigserial => 'numeric',
314 boolean => 'varchar',
318 sub _native_data_type {
319 my ($self, $type) = @_;
322 $type =~ s/\s* identity//x;
324 return uc($TYPE_MAPPING{$type} || $type);
327 sub _fetch_identity_sql {
328 my ($self, $source, $col) = @_;
330 return sprintf ("SELECT MAX(%s) FROM %s",
331 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
339 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
341 if ($op eq 'insert') {
342 $self->_identity($sth->fetchrow_array);
346 return wantarray ? ($rv, $sth, @bind) : $rv;
349 sub last_insert_id { shift->_identity }
351 # handles TEXT/IMAGE and transaction for last_insert_id
354 my ($source, $to_insert) = @_;
356 my $identity_col = (List::Util::first
357 { $source->column_info($_)->{is_auto_increment} }
358 $source->columns) || '';
360 # check for empty insert
361 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
362 # try to insert explicit 'DEFAULT's instead (except for identity)
363 if (not %$to_insert) {
364 for my $col ($source->columns) {
365 next if $col eq $identity_col;
366 $to_insert->{$col} = \'DEFAULT';
370 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
372 # do we need the horrific SELECT MAX(COL) hack?
373 my $dumb_last_insert_id =
375 && (not exists $to_insert->{$identity_col})
376 && ($self->_identity_method||'') ne '@@IDENTITY';
378 my $next = $self->next::can;
380 # we are already in a transaction, or there are no blobs
381 # and we don't need the PK - just (try to) do it
382 if ($self->{transaction_depth}
383 || (!$blob_cols && !$dumb_last_insert_id)
385 return $self->_insert (
386 $next, $source, $to_insert, $blob_cols, $identity_col
390 # otherwise use the _writer_storage to do the insert+transaction on another
392 my $guard = $self->_writer_storage->txn_scope_guard;
394 my $updated_cols = $self->_writer_storage->_insert (
395 $next, $source, $to_insert, $blob_cols, $identity_col
398 $self->_identity($self->_writer_storage->_identity);
402 return $updated_cols;
406 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
408 my $updated_cols = $self->$next ($source, $to_insert);
412 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
417 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
419 return $updated_cols;
424 my ($source, $fields, $where, @rest) = @_;
426 my $wantarray = wantarray;
428 my $blob_cols = $self->_remove_blob_cols($source, $fields);
430 my $table = $source->name;
432 my $identity_col = List::Util::first
433 { $source->column_info($_)->{is_auto_increment} }
436 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
438 return $self->next::method(@_) unless $blob_cols;
440 # If there are any blobs in $where, Sybase will return a descriptive error
442 # XXX blobs can still be used with a LIKE query, and this should be handled.
444 # update+blob update(s) done atomically on separate connection
445 $self = $self->_writer_storage;
447 my $guard = $self->txn_scope_guard;
449 # First update the blob columns to be updated to '' (taken from $fields, where
450 # it is originally put by _remove_blob_cols .)
451 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
453 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
455 $self->next::method($source, \%blobs_to_empty, $where, @rest);
457 # Now update the blobs before the other columns in case the update of other
458 # columns makes the search condition invalid.
459 $self->_update_blobs($source, $blob_cols, $where);
464 @res = $self->next::method(@_);
466 elsif (defined $wantarray) {
467 $res[0] = $self->next::method(@_);
470 $self->next::method(@_);
476 return $wantarray ? @res : $res[0];
481 my ($source, $cols, $data) = @_;
483 my $identity_col = List::Util::first
484 { $source->column_info($_)->{is_auto_increment} }
487 my $is_identity_insert = (List::Util::first
488 { $_ eq $identity_col }
492 my @source_columns = $source->columns;
495 $self->_bulk_storage &&
496 $self->_get_dbh->{syb_has_blk};
498 if ((not $use_bulk_api) &&
499 (Scalar::Util::reftype($self->_dbi_connect_info->[0])||'') eq 'CODE' &&
500 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
502 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
503 regular array inserts.
505 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
508 if (not $use_bulk_api) {
509 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
511 my $dumb_last_insert_id =
513 && (not $is_identity_insert)
514 && ($self->_identity_method||'') ne '@@IDENTITY';
516 $self = $self->_writer_storage;
517 my $guard = $self->txn_scope_guard;
518 local $self->{insert_bulk} = 1;
520 $self->next::method(@_);
523 if ($is_identity_insert) {
524 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
527 my @cols_with_identities = (@$cols, $identity_col);
529 ## calculate identities
530 # XXX This assumes identities always increase by 1, which may or may not
532 my ($last_identity) =
533 $self->_dbh->selectrow_array (
534 $self->_fetch_identity_sql($source, $identity_col)
536 my @identities = (($last_identity - @$data + 1) .. $last_identity);
538 my @data_with_identities = map [@$_, shift @identities], @$data;
540 $self->_insert_blobs_array (
541 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
550 # otherwise, use the bulk API
552 # rearrange @$data so that columns are in database order
554 @orig_idx{@$cols} = 0..$#$cols;
557 @new_idx{@source_columns} = 0..$#source_columns;
560 for my $datum (@$data) {
562 for my $col (@source_columns) {
563 # identity data will be 'undef' if not $is_identity_insert
564 # columns with defaults will also be 'undef'
565 $new_datum->[ $new_idx{$col} ] =
566 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
568 push @new_data, $new_datum;
571 # bcp identity index is 1-based
572 my $identity_idx = exists $new_idx{$identity_col} ?
573 $new_idx{$identity_col} + 1 : 0;
575 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
576 # This ignores any data conversion errors detected by the client side libs, as
577 # they are usually harmless.
578 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
579 Sub::Name::subname insert_bulk => sub {
580 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
582 return 1 if $errno == 36;
585 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
586 ($errmsg ? "\n$errmsg" : '') .
587 ($osmsg ? "\n$osmsg" : '') .
588 ($blkmsg ? "\n$blkmsg" : '');
594 my $bulk = $self->_bulk_storage;
596 my $guard = $bulk->txn_scope_guard;
598 ## XXX get this to work instead of our own $sth
599 ## will require SQLA or *Hacks changes for ordered columns
600 # $bulk->next::method($source, \@source_columns, \@new_data, {
601 # syb_bcp_attribs => {
602 # identity_flag => $is_identity_insert,
603 # identity_column => $identity_idx,
606 my $sql = 'INSERT INTO ' .
607 $bulk->sql_maker->_quote($source->name) . ' (' .
608 # colname list is ignored for BCP, but does no harm
609 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
610 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
612 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
613 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
614 ## better yet the version above. Should be fixed in DBD::Sybase .
615 my $sth = $bulk->_get_dbh->prepare($sql,
619 identity_flag => $is_identity_insert,
620 identity_column => $identity_idx,
627 map [ $_, $idx++ ], @source_columns;
630 $self->_execute_array(
631 $source, $sth, \@bind, \@source_columns, \@new_data, sub {
636 $bulk->_query_end($sql);
640 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
642 if ($exception =~ /-Y option/) {
645 Sybase bulk API operation failed due to character set incompatibility, reverting
646 to regular array inserts:
648 *** Try unsetting the LANG environment variable.
652 $self->_bulk_storage(undef);
657 # rollback makes the bulkLogin connection unusable
658 $self->_bulk_storage->disconnect;
659 $self->throw_exception($exception);
663 # Make sure blobs are not bound as placeholders, and return any non-empty ones
665 sub _remove_blob_cols {
666 my ($self, $source, $fields) = @_;
670 for my $col (keys %$fields) {
671 if ($self->_is_lob_column($source, $col)) {
672 my $blob_val = delete $fields->{$col};
673 if (not defined $blob_val) {
674 $fields->{$col} = \'NULL';
677 $fields->{$col} = \"''";
678 $blob_cols{$col} = $blob_val unless $blob_val eq '';
683 return %blob_cols ? \%blob_cols : undef;
686 # same for insert_bulk
687 sub _remove_blob_cols_array {
688 my ($self, $source, $cols, $data) = @_;
692 for my $i (0..$#$cols) {
693 my $col = $cols->[$i];
695 if ($self->_is_lob_column($source, $col)) {
696 for my $j (0..$#$data) {
697 my $blob_val = delete $data->[$j][$i];
698 if (not defined $blob_val) {
699 $data->[$j][$i] = \'NULL';
702 $data->[$j][$i] = \"''";
703 $blob_cols[$j][$i] = $blob_val
704 unless $blob_val eq '';
710 return @blob_cols ? \@blob_cols : undef;
714 my ($self, $source, $blob_cols, $where) = @_;
716 my (@primary_cols) = $source->primary_columns;
718 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
719 unless @primary_cols;
721 # check if we're updating a single row by PK
722 my $pk_cols_in_where = 0;
723 for my $col (@primary_cols) {
724 $pk_cols_in_where++ if defined $where->{$col};
728 if ($pk_cols_in_where == @primary_cols) {
730 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
731 @rows = \%row_to_update;
733 my $cursor = $self->select ($source, \@primary_cols, $where, {});
735 my %row; @row{@primary_cols} = @$_; \%row
739 for my $row (@rows) {
740 $self->_insert_blobs($source, $blob_cols, $row);
745 my ($self, $source, $blob_cols, $row) = @_;
746 my $dbh = $self->_get_dbh;
748 my $table = $source->name;
751 my (@primary_cols) = $source->primary_columns;
753 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
754 unless @primary_cols;
756 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
757 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
759 for my $col (keys %$blob_cols) {
760 my $blob = $blob_cols->{$col};
762 my %where = map { ($_, $row{$_}) } @primary_cols;
764 my $cursor = $self->select ($source, [$col], \%where, {});
766 my $sth = $cursor->sth;
770 $self->throw_exception(
771 "Could not find row in table '$table' for blob update:\n"
772 . $self->_pretty_print (\%where)
778 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
781 $sth->func('ct_prepare_send') or die $sth->errstr;
783 my $log_on_update = $self->_blob_log_on_update;
784 $log_on_update = 1 if not defined $log_on_update;
786 $sth->func('CS_SET', 1, {
787 total_txtlen => length($blob),
788 log_on_update => $log_on_update
789 }, 'ct_data_info') or die $sth->errstr;
791 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
793 $sth->func('ct_finish_send') or die $sth->errstr;
796 $sth->finish if $sth;
798 if ($self->using_freetds) {
799 $self->throw_exception (
800 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
804 $self->throw_exception($exception);
810 sub _insert_blobs_array {
811 my ($self, $source, $blob_cols, $cols, $data) = @_;
813 for my $i (0..$#$data) {
814 my $datum = $data->[$i];
817 @row{ @$cols } = @$datum;
820 for my $j (0..$#$cols) {
821 if (exists $blob_cols->[$i][$j]) {
822 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
826 $self->_insert_blobs ($source, \%blob_vals, \%row);
830 =head2 connect_call_datetime_setup
834 on_connect_call => 'datetime_setup'
836 In L<DBIx::Class::Storage::DBI/connect_info> to set:
838 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
839 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
841 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
842 L<DateTime::Format::Sybase>, which you will need to install.
844 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
845 C<SMALLDATETIME> columns only have minute precision.
850 my $old_dbd_warned = 0;
852 sub connect_call_datetime_setup {
854 my $dbh = $self->_get_dbh;
856 if ($dbh->can('syb_date_fmt')) {
857 # amazingly, this works with FreeTDS
858 $dbh->syb_date_fmt('ISO_strict');
859 } elsif (not $old_dbd_warned) {
860 carp "Your DBD::Sybase is too old to support ".
861 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
865 $dbh->do('SET DATEFORMAT mdy');
871 sub datetime_parser_type { "DateTime::Format::Sybase" }
873 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
874 # let the DBD keep any state it needs to.
876 # If they ever do start working, the extra statements will do no harm (because
877 # Sybase supports nested transactions.)
879 sub _dbh_begin_work {
882 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
883 # TRAN once. However, we need to make sure there's a $dbh.
884 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
886 $self->next::method(@_);
888 if ($self->using_freetds) {
889 $self->_get_dbh->do('BEGIN TRAN');
892 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
897 if ($self->using_freetds) {
898 $self->_dbh->do('COMMIT');
900 return $self->next::method(@_);
905 if ($self->using_freetds) {
906 $self->_dbh->do('ROLLBACK');
908 return $self->next::method(@_);
911 # savepoint support using ASE syntax
914 my ($self, $name) = @_;
916 $self->_get_dbh->do("SAVE TRANSACTION $name");
919 # A new SAVE TRANSACTION with the same name releases the previous one.
920 sub _svp_release { 1 }
923 my ($self, $name) = @_;
925 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
930 =head1 Schema::Loader Support
932 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
933 allow you to dump a schema from most (if not all) versions of Sybase.
935 It is available via subversion from:
937 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
941 This driver supports L<DBD::Sybase> compiled against FreeTDS
942 (L<http://www.freetds.org/>) to the best of our ability, however it is
943 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
944 libraries. They are a part of the Sybase ASE distribution:
946 The Open Client FAQ is here:
947 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
949 Sybase ASE for Linux (which comes with the Open Client libraries) may be
950 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
952 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
954 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
956 Some versions of the libraries involved will not support placeholders, in which
957 case the storage will be reblessed to
958 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
960 In some configurations, placeholders will work but will throw implicit type
961 conversion errors for anything that's not expecting a string. In such a case,
962 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
963 automatically set, which you may enable on connection with
964 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
965 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
966 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
967 already) using a mapping based on L<SQL::Translator>.
969 In other configurations, placeholers will work just as they do with the Sybase
970 Open Client libraries.
972 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
974 =head1 INSERTS WITH PLACEHOLDERS
976 With placeholders enabled, inserts are done in a transaction so that there are
977 no concurrency issues with getting the inserted identity value using
978 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
981 In addition, they are done on a separate connection so that it's possible to
982 have active cursors when doing an insert.
984 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
985 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
990 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
991 begin a transaction while there are active cursors; nor can you use multiple
992 active cursors within a transaction. An active cursor is, for example, a
993 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
994 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
996 For example, this will not work:
998 $schema->txn_do(sub {
999 my $rs = $schema->resultset('Book');
1000 while (my $row = $rs->next) {
1001 $schema->resultset('MetaData')->create({
1002 book_id => $row->id,
1010 my $first_row = $large_rs->first;
1011 $schema->txn_do(sub { ... });
1013 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1014 are not affected, as they are done on an extra database handle.
1020 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1022 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1024 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1028 =head1 MAXIMUM CONNECTIONS
1030 The TDS protocol makes separate connections to the server for active statements
1031 in the background. By default the number of such connections is limited to 25,
1032 on both the client side and the server side.
1034 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1035 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1036 can override it to whatever setting you like in the DSN.
1039 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1040 for information on changing the setting on the server side.
1044 See L</connect_call_datetime_setup> to setup date formats
1045 for L<DBIx::Class::InflateColumn::DateTime>.
1047 =head1 TEXT/IMAGE COLUMNS
1049 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1050 C<TEXT/IMAGE> columns.
1052 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1054 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1058 $schema->storage->set_textsize($bytes);
1062 However, the C<LongReadLen> you pass in
1063 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
1064 C<SET TEXTSIZE> command on connection.
1066 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
1067 setting you need to work with C<IMAGE> columns.
1071 The experimental L<DBD::Sybase> Bulk API support is used for
1072 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1073 on a separate connection.
1075 To use this feature effectively, use a large number of rows for each
1076 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1078 while (my $rows = $data_source->get_100_rows()) {
1079 $rs->populate($rows);
1082 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1083 calls in your C<Result> classes B<must> list columns in database order for this
1084 to work. Also, you may have to unset the C<LANG> environment variable before
1085 loading your app, if it doesn't match the character set of your database.
1087 When inserting IMAGE columns using this method, you'll need to use
1088 L</connect_call_blob_setup> as well.
1096 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1097 any active cursors, using eager cursors.
1101 Real limits and limited counts using stored procedures deployed on startup.
1105 Adaptive Server Anywhere (ASA) support, with possible SQLA::Limit support.
1109 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1113 bulk_insert using prepare_cached (see comments.)
1119 See L<DBIx::Class/CONTRIBUTORS>.
1123 You may distribute this code under the same terms as Perl itself.