1 package DBIx::Class::Storage::DBI::Sybase::ASE;
7 DBIx::Class::Storage::DBI::Sybase
8 DBIx::Class::Storage::DBI::AutoCast
11 use DBIx::Class::Carp;
12 use Scalar::Util 'blessed';
13 use List::Util 'first';
15 use Data::Dumper::Concise 'Dumper';
19 __PACKAGE__->sql_limit_dialect ('RowCountOrGenericSubQ');
20 __PACKAGE__->sql_quote_char ([qw/[ ]/]);
21 __PACKAGE__->datetime_parser_type('DateTime::Format::Sybase');
23 __PACKAGE__->mk_group_accessors('simple' =>
24 qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
25 _bulk_storage _is_bulk_storage _began_bulk_work
26 _bulk_disabled_due_to_coderef_connect_info_warned
30 my @also_proxy_to_extra_storages = qw/
31 connect_call_set_auto_cast auto_cast connect_call_blob_setup
32 connect_call_datetime_setup
34 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
35 auto_savepoint unsafe cursor_class debug debugobj schema
40 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
45 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
49 If your version of Sybase does not support placeholders, then your storage will
50 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
51 You can also enable that driver explicitly, see the documentation for more
54 With this driver there is unfortunately no way to get the C<last_insert_id>
55 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
56 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
58 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
60 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
69 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
71 if ($self->using_freetds) {
72 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
74 You are using FreeTDS with Sybase.
76 We will do our best to support this configuration, but please consider this
79 TEXT/IMAGE columns will definitely not work.
81 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
84 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
86 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
90 if (not $self->_use_typeless_placeholders) {
91 if ($self->_use_placeholders) {
95 $self->ensure_class_loaded($no_bind_vars);
96 bless $self, $no_bind_vars;
102 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
103 # not necessarily FreeTDS, but no placeholders nevertheless
104 $self->ensure_class_loaded($no_bind_vars);
105 bless $self, $no_bind_vars;
108 # this is highly unlikely, but we check just in case
109 elsif (not $self->_use_typeless_placeholders) {
116 $self->_set_max_connect(256);
118 # create storage for insert/(update blob) transactions,
119 # unless this is that storage
120 return if $self->_is_extra_storage;
122 my $writer_storage = (ref $self)->new;
124 $writer_storage->_is_extra_storage(1);
125 $writer_storage->connect_info($self->connect_info);
126 $writer_storage->auto_cast($self->auto_cast);
128 $self->_writer_storage($writer_storage);
130 # create a bulk storage unless connect_info is a coderef
131 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
133 my $bulk_storage = (ref $self)->new;
135 $bulk_storage->_is_extra_storage(1);
136 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
137 $bulk_storage->connect_info($self->connect_info);
140 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
142 $self->_bulk_storage($bulk_storage);
145 for my $method (@also_proxy_to_extra_storages) {
147 no warnings 'redefine';
149 my $replaced = __PACKAGE__->can($method);
151 *{$method} = Sub::Name::subname $method => sub {
153 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
154 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
155 return $self->$replaced(@_);
162 # Even though we call $sth->finish for uses off the bulk API, there's still an
163 # "active statement" warning on disconnect, which we throw away here.
164 # This is due to the bug described in insert_bulk.
165 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
166 local $SIG{__WARN__} = sub {
167 warn $_[0] unless $_[0] =~ /active statement/i;
168 } if $self->_is_bulk_storage;
170 # so that next transaction gets a dbh
171 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
176 # This is only invoked for FreeTDS drivers by ::Storage::DBI::Sybase::FreeTDS
177 sub _set_autocommit_stmt {
178 my ($self, $on) = @_;
180 return 'SET CHAINED ' . ($on ? 'OFF' : 'ON');
183 # Set up session settings for Sybase databases for the connection.
185 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
186 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
187 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
188 # only want when AutoCommit is off.
189 sub _run_connection_actions {
192 if ($self->_is_bulk_storage) {
193 # this should be cleared on every reconnect
194 $self->_began_bulk_work(0);
198 $self->_dbh->{syb_chained_txn} = 1
199 unless $self->using_freetds;
201 $self->next::method(@_);
204 =head2 connect_call_blob_setup
208 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
210 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
211 instead of as a hex string.
215 Also sets the C<log_on_update> value for blob write operations. The default is
216 C<1>, but C<0> is better if your database is configured for it.
219 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
223 sub connect_call_blob_setup {
226 my $dbh = $self->_dbh;
227 $dbh->{syb_binary_images} = 1;
229 $self->_blob_log_on_update($args{log_on_update})
230 if exists $args{log_on_update};
234 my ($self, $source, $column) = @_;
236 return $self->_is_lob_type($source->column_info($column)->{data_type});
239 sub _prep_for_execute {
241 my ($op, $ident, $args) = @_;
243 my ($sql, $bind) = $self->next::method (@_);
245 my $table = blessed $ident ? $ident->from : $ident;
247 my $bind_info = $self->_resolve_column_info(
248 $ident, [map { $_->[0]{dbic_colname} || () } @{$bind}]
250 my $bound_identity_col =
251 first { $bind_info->{$_}{is_auto_increment} }
255 my $columns_info = blessed $ident && $ident->columns_info;
259 first { $columns_info->{$_}{is_auto_increment} }
263 if (($op eq 'insert' && $bound_identity_col) ||
264 ($op eq 'update' && exists $args->[0]{$identity_col})) {
266 $self->_set_table_identity_sql($op => $table, 'on'),
268 $self->_set_table_identity_sql($op => $table, 'off'),
272 if ($op eq 'insert' && (not $bound_identity_col) && $identity_col &&
273 (not $self->{insert_bulk})) {
276 $self->_fetch_identity_sql($ident, $identity_col);
279 return ($sql, $bind);
282 sub _set_table_identity_sql {
283 my ($self, $op, $table, $on_off) = @_;
285 return sprintf 'SET IDENTITY_%s %s %s',
286 uc($op), $self->sql_maker->_quote($table), uc($on_off);
289 # Stolen from SQLT, with some modifications. This is a makeshift
290 # solution before a sane type-mapping library is available, thus
291 # the 'our' for easy overrides.
292 our %TYPE_MAPPING = (
295 varchar => 'varchar',
296 varchar2 => 'varchar',
297 timestamp => 'datetime',
299 real => 'double precision',
302 tinyint => 'smallint',
303 float => 'double precision',
305 bigserial => 'numeric',
306 boolean => 'varchar',
310 sub _native_data_type {
311 my ($self, $type) = @_;
314 $type =~ s/\s* identity//x;
316 return uc($TYPE_MAPPING{$type} || $type);
319 sub _fetch_identity_sql {
320 my ($self, $source, $col) = @_;
322 return sprintf ("SELECT MAX(%s) FROM %s",
323 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
331 my ($rv, $sth, @bind) = $self->next::method(@_);
333 if ($op eq 'insert') {
334 $self->_identity($sth->fetchrow_array);
338 return wantarray ? ($rv, $sth, @bind) : $rv;
341 sub last_insert_id { shift->_identity }
343 # handles TEXT/IMAGE and transaction for last_insert_id
346 my ($source, $to_insert) = @_;
348 my $columns_info = $source->columns_info;
351 (first { $columns_info->{$_}{is_auto_increment} }
352 keys %$columns_info )
355 # check for empty insert
356 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
357 # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
358 # and computed columns)
359 if (not %$to_insert) {
360 for my $col ($source->columns) {
361 next if $col eq $identity_col;
363 my $info = $source->column_info($col);
365 next if ref $info->{default_value} eq 'SCALAR'
366 || (exists $info->{data_type} && (not defined $info->{data_type}));
368 next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
370 $to_insert->{$col} = \'DEFAULT';
374 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
376 # do we need the horrific SELECT MAX(COL) hack?
377 my $dumb_last_insert_id =
379 && (not exists $to_insert->{$identity_col})
380 && ($self->_identity_method||'') ne '@@IDENTITY';
382 my $next = $self->next::can;
384 # we are already in a transaction, or there are no blobs
385 # and we don't need the PK - just (try to) do it
386 if ($self->{transaction_depth}
387 || (!$blob_cols && !$dumb_last_insert_id)
389 return $self->_insert (
390 $next, $source, $to_insert, $blob_cols, $identity_col
394 # otherwise use the _writer_storage to do the insert+transaction on another
396 my $guard = $self->_writer_storage->txn_scope_guard;
398 my $updated_cols = $self->_writer_storage->_insert (
399 $next, $source, $to_insert, $blob_cols, $identity_col
402 $self->_identity($self->_writer_storage->_identity);
406 return $updated_cols;
410 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
412 my $updated_cols = $self->$next ($source, $to_insert);
416 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
421 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
423 return $updated_cols;
428 my ($source, $fields, $where, @rest) = @_;
430 my $blob_cols = $self->_remove_blob_cols($source, $fields);
432 my $table = $source->name;
434 my $columns_info = $source->columns_info;
437 first { $columns_info->{$_}{is_auto_increment} }
440 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
442 return $self->next::method(@_) unless $blob_cols;
444 # If there are any blobs in $where, Sybase will return a descriptive error
446 # XXX blobs can still be used with a LIKE query, and this should be handled.
448 # update+blob update(s) done atomically on separate connection
449 $self = $self->_writer_storage;
451 my $guard = $self->txn_scope_guard;
453 # First update the blob columns to be updated to '' (taken from $fields, where
454 # it is originally put by _remove_blob_cols .)
455 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
457 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
459 $self->next::method($source, \%blobs_to_empty, $where, @rest);
461 # Now update the blobs before the other columns in case the update of other
462 # columns makes the search condition invalid.
463 $self->_update_blobs($source, $blob_cols, $where);
468 @res = $self->next::method(@_);
470 elsif (defined wantarray) {
471 $res[0] = $self->next::method(@_);
474 $self->next::method(@_);
480 return wantarray ? @res : $res[0];
485 my ($source, $cols, $data) = @_;
487 my $columns_info = $source->columns_info;
490 first { $columns_info->{$_}{is_auto_increment} }
493 my $is_identity_insert = (first { $_ eq $identity_col } @{$cols}) ? 1 : 0;
495 my @source_columns = $source->columns;
498 $self->_bulk_storage &&
499 $self->_get_dbh->{syb_has_blk};
501 if ((not $use_bulk_api)
503 (ref($self->_dbi_connect_info->[0]) eq 'CODE')
505 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
507 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
508 regular array inserts.
510 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
513 if (not $use_bulk_api) {
514 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
516 # _execute_array uses a txn anyway, but it ends too early in case we need to
517 # select max(col) to get the identity for inserting blobs.
518 ($self, my $guard) = $self->{transaction_depth} == 0 ?
519 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
523 local $self->{insert_bulk} = 1;
525 $self->next::method(@_);
528 if ($is_identity_insert) {
529 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
532 my @cols_with_identities = (@$cols, $identity_col);
534 ## calculate identities
535 # XXX This assumes identities always increase by 1, which may or may not
537 my ($last_identity) =
538 $self->_dbh->selectrow_array (
539 $self->_fetch_identity_sql($source, $identity_col)
541 my @identities = (($last_identity - @$data + 1) .. $last_identity);
543 my @data_with_identities = map [@$_, shift @identities], @$data;
545 $self->_insert_blobs_array (
546 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
551 $guard->commit if $guard;
556 # otherwise, use the bulk API
558 # rearrange @$data so that columns are in database order
560 @orig_idx{@$cols} = 0..$#$cols;
563 @new_idx{@source_columns} = 0..$#source_columns;
566 for my $datum (@$data) {
568 for my $col (@source_columns) {
569 # identity data will be 'undef' if not $is_identity_insert
570 # columns with defaults will also be 'undef'
571 $new_datum->[ $new_idx{$col} ] =
572 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
574 push @new_data, $new_datum;
577 # bcp identity index is 1-based
578 my $identity_idx = exists $new_idx{$identity_col} ?
579 $new_idx{$identity_col} + 1 : 0;
581 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
582 # This ignores any data conversion errors detected by the client side libs, as
583 # they are usually harmless.
584 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
585 Sub::Name::subname insert_bulk => sub {
586 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
588 return 1 if $errno == 36;
591 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
592 ($errmsg ? "\n$errmsg" : '') .
593 ($osmsg ? "\n$osmsg" : '') .
594 ($blkmsg ? "\n$blkmsg" : '');
601 my $bulk = $self->_bulk_storage;
603 my $guard = $bulk->txn_scope_guard;
605 ## XXX get this to work instead of our own $sth
606 ## will require SQLA or *Hacks changes for ordered columns
607 # $bulk->next::method($source, \@source_columns, \@new_data, {
608 # syb_bcp_attribs => {
609 # identity_flag => $is_identity_insert,
610 # identity_column => $identity_idx,
613 my $sql = 'INSERT INTO ' .
614 $bulk->sql_maker->_quote($source->name) . ' (' .
615 # colname list is ignored for BCP, but does no harm
616 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
617 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
619 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
620 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
621 ## better yet the version above. Should be fixed in DBD::Sybase .
622 my $sth = $bulk->_get_dbh->prepare($sql,
626 identity_flag => $is_identity_insert,
627 identity_column => $identity_idx,
632 my @bind = map { [ $source_columns[$_] => $_ ] } (0 .. $#source_columns);
634 $self->_execute_array(
635 $source, $sth, \@bind, \@source_columns, \@new_data, sub {
640 $bulk->_query_end($sql);
645 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
647 if ($exception =~ /-Y option/) {
648 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
649 . 'reverting to regular array inserts. Try unsetting the LANG environment variable'
651 $w .= "\n$exception" if $self->debug;
654 $self->_bulk_storage(undef);
659 # rollback makes the bulkLogin connection unusable
660 $self->_bulk_storage->disconnect;
661 $self->throw_exception($exception);
665 sub _dbh_execute_array {
666 my ($self, $sth, $tuple_status, $cb) = @_;
668 my $rv = $self->next::method($sth, $tuple_status);
674 # Make sure blobs are not bound as placeholders, and return any non-empty ones
676 sub _remove_blob_cols {
677 my ($self, $source, $fields) = @_;
681 for my $col (keys %$fields) {
682 if ($self->_is_lob_column($source, $col)) {
683 my $blob_val = delete $fields->{$col};
684 if (not defined $blob_val) {
685 $fields->{$col} = \'NULL';
688 $fields->{$col} = \"''";
689 $blob_cols{$col} = $blob_val unless $blob_val eq '';
694 return %blob_cols ? \%blob_cols : undef;
697 # same for insert_bulk
698 sub _remove_blob_cols_array {
699 my ($self, $source, $cols, $data) = @_;
703 for my $i (0..$#$cols) {
704 my $col = $cols->[$i];
706 if ($self->_is_lob_column($source, $col)) {
707 for my $j (0..$#$data) {
708 my $blob_val = delete $data->[$j][$i];
709 if (not defined $blob_val) {
710 $data->[$j][$i] = \'NULL';
713 $data->[$j][$i] = \"''";
714 $blob_cols[$j][$i] = $blob_val
715 unless $blob_val eq '';
721 return @blob_cols ? \@blob_cols : undef;
725 my ($self, $source, $blob_cols, $where) = @_;
727 my @primary_cols = try
728 { $source->_pri_cols }
730 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
733 # check if we're updating a single row by PK
734 my $pk_cols_in_where = 0;
735 for my $col (@primary_cols) {
736 $pk_cols_in_where++ if defined $where->{$col};
740 if ($pk_cols_in_where == @primary_cols) {
742 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
743 @rows = \%row_to_update;
745 my $cursor = $self->select ($source, \@primary_cols, $where, {});
747 my %row; @row{@primary_cols} = @$_; \%row
751 for my $row (@rows) {
752 $self->_insert_blobs($source, $blob_cols, $row);
757 my ($self, $source, $blob_cols, $row) = @_;
758 my $dbh = $self->_get_dbh;
760 my $table = $source->name;
763 my @primary_cols = try
764 { $source->_pri_cols }
766 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
769 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
770 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
772 for my $col (keys %$blob_cols) {
773 my $blob = $blob_cols->{$col};
775 my %where = map { ($_, $row{$_}) } @primary_cols;
777 my $cursor = $self->select ($source, [$col], \%where, {});
779 my $sth = $cursor->sth;
782 $self->throw_exception(
783 "Could not find row in table '$table' for blob update:\n"
790 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
793 $sth->func('ct_prepare_send') or die $sth->errstr;
795 my $log_on_update = $self->_blob_log_on_update;
796 $log_on_update = 1 if not defined $log_on_update;
798 $sth->func('CS_SET', 1, {
799 total_txtlen => length($blob),
800 log_on_update => $log_on_update
801 }, 'ct_data_info') or die $sth->errstr;
803 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
805 $sth->func('ct_finish_send') or die $sth->errstr;
808 if ($self->using_freetds) {
809 $self->throw_exception (
810 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
814 $self->throw_exception($_);
818 $sth->finish if $sth;
823 sub _insert_blobs_array {
824 my ($self, $source, $blob_cols, $cols, $data) = @_;
826 for my $i (0..$#$data) {
827 my $datum = $data->[$i];
830 @row{ @$cols } = @$datum;
833 for my $j (0..$#$cols) {
834 if (exists $blob_cols->[$i][$j]) {
835 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
839 $self->_insert_blobs ($source, \%blob_vals, \%row);
843 =head2 connect_call_datetime_setup
847 on_connect_call => 'datetime_setup'
849 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
851 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
852 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
854 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
855 L<DateTime::Format::Sybase>, which you will need to install.
857 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
858 C<SMALLDATETIME> columns only have minute precision.
862 sub connect_call_datetime_setup {
864 my $dbh = $self->_get_dbh;
866 if ($dbh->can('syb_date_fmt')) {
867 # amazingly, this works with FreeTDS
868 $dbh->syb_date_fmt('ISO_strict');
872 'Your DBD::Sybase is too old to support '
873 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
875 $dbh->do('SET DATEFORMAT mdy');
881 sub _dbh_begin_work {
884 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
885 # TRAN once. However, we need to make sure there's a $dbh.
886 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
888 $self->next::method(@_);
890 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
893 # savepoint support using ASE syntax
896 my ($self, $name) = @_;
898 $self->_get_dbh->do("SAVE TRANSACTION $name");
901 # A new SAVE TRANSACTION with the same name releases the previous one.
902 sub _svp_release { 1 }
905 my ($self, $name) = @_;
907 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
912 =head1 Schema::Loader Support
914 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
915 most versions of Sybase ASE.
919 This driver supports L<DBD::Sybase> compiled against FreeTDS
920 (L<http://www.freetds.org/>) to the best of our ability, however it is
921 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
922 libraries. They are a part of the Sybase ASE distribution:
924 The Open Client FAQ is here:
925 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
927 Sybase ASE for Linux (which comes with the Open Client libraries) may be
928 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
930 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
932 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
934 It is recommended to set C<tds version> for your ASE server to C<5.0> in
935 C</etc/freetds/freetds.conf>.
937 Some versions or configurations of the libraries involved will not support
938 placeholders, in which case the storage will be reblessed to
939 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
941 In some configurations, placeholders will work but will throw implicit type
942 conversion errors for anything that's not expecting a string. In such a case,
943 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
944 automatically set, which you may enable on connection with
945 L<connect_call_set_auto_cast|DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>.
946 The type info for the C<CAST>s is taken from the
947 L<DBIx::Class::ResultSource/data_type> definitions in your Result classes, and
948 are mapped to a Sybase type (if it isn't already) using a mapping based on
951 In other configurations, placeholders will work just as they do with the Sybase
952 Open Client libraries.
954 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
956 =head1 INSERTS WITH PLACEHOLDERS
958 With placeholders enabled, inserts are done in a transaction so that there are
959 no concurrency issues with getting the inserted identity value using
960 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
963 In addition, they are done on a separate connection so that it's possible to
964 have active cursors when doing an insert.
966 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
967 are unnecessary and not used, as there are no concurrency issues with C<SELECT
968 @@IDENTITY> which is a session variable.
972 Due to limitations of the TDS protocol and L<DBD::Sybase>, you cannot begin a
973 transaction while there are active cursors, nor can you use multiple active
974 cursors within a transaction. An active cursor is, for example, a
975 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
976 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
978 For example, this will not work:
980 $schema->txn_do(sub {
981 my $rs = $schema->resultset('Book');
982 while (my $row = $rs->next) {
983 $schema->resultset('MetaData')->create({
992 my $first_row = $large_rs->first;
993 $schema->txn_do(sub { ... });
995 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
996 are not affected, as they are done on an extra database handle.
1002 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1004 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1006 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1010 =head1 MAXIMUM CONNECTIONS
1012 The TDS protocol makes separate connections to the server for active statements
1013 in the background. By default the number of such connections is limited to 25,
1014 on both the client side and the server side.
1016 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1017 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1018 can override it to whatever setting you like in the DSN.
1021 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1022 for information on changing the setting on the server side.
1026 See L</connect_call_datetime_setup> to setup date formats
1027 for L<DBIx::Class::InflateColumn::DateTime>.
1029 =head1 TEXT/IMAGE COLUMNS
1031 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1032 C<TEXT/IMAGE> columns.
1034 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1036 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1040 $schema->storage->set_textsize($bytes);
1044 However, the C<LongReadLen> you pass in
1045 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1046 equivalent C<SET TEXTSIZE> command on connection.
1048 See L</connect_call_blob_setup> for a
1049 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1050 with C<IMAGE> columns.
1054 The experimental L<DBD::Sybase> Bulk API support is used for
1055 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1056 on a separate connection.
1058 To use this feature effectively, use a large number of rows for each
1059 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1061 while (my $rows = $data_source->get_100_rows()) {
1062 $rs->populate($rows);
1065 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1066 calls in your C<Result> classes B<must> list columns in database order for this
1067 to work. Also, you may have to unset the C<LANG> environment variable before
1068 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1070 When inserting IMAGE columns using this method, you'll need to use
1071 L</connect_call_blob_setup> as well.
1073 =head1 COMPUTED COLUMNS
1075 If you have columns such as:
1077 created_dtm AS getdate()
1079 represent them in your Result classes as:
1083 default_value => \'getdate()',
1085 inflate_datetime => 1,
1088 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1089 on tables with such columns.
1091 =head1 TIMESTAMP COLUMNS
1093 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1094 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1096 They should be defined in your Result classes as:
1099 data_type => 'timestamp',
1101 inflate_datetime => 0,
1104 The C<<inflate_datetime => 0>> is necessary if you use
1105 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1106 be able to read these values.
1108 The values will come back as hexadecimal.
1116 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1117 any active cursors, using eager cursors.
1121 Real limits and limited counts using stored procedures deployed on startup.
1125 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1129 bulk_insert using prepare_cached (see comments.)
1135 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
1139 You may distribute this code under the same terms as Perl itself.