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_identity_insert($table, 'update') if $is_identity_update;
423 return $self->next::method(@_);
424 $self->_unset_identity_insert($table, 'update') if $is_identity_update;
427 # check that we're not updating a blob column that's also in $where
428 for my $blob (grep $self->_is_lob_column($source, $_), $source->columns) {
429 if (exists $where->{$blob} && exists $fields->{$blob}) {
431 'Update of TEXT/IMAGE column that is also in search condition impossible';
435 # update+blob update(s) done atomically on separate connection
436 $self = $self->_writer_storage;
438 my $guard = $self->txn_scope_guard;
440 # First update the blob columns to be updated to '' (taken from $fields, where
441 # it is originally put by _remove_blob_cols .)
442 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
444 $self->next::method($source, \%blobs_to_empty, $where, @rest);
446 # Now update the blobs before the other columns in case the update of other
447 # columns makes the search condition invalid.
448 $self->_update_blobs($source, $blob_cols, $where);
452 $self->_set_identity_insert($table, 'update') 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->_unset_identity_insert($table, 'update') if $is_identity_update;
469 return $wantarray ? @res : $res[0];
472 ### the insert_bulk partially stolen from DBI/MSSQL.pm
474 sub _set_identity_insert {
475 my ($self, $table, $op) = @_;
478 'SET IDENTITY_%s %s ON',
479 (uc($op) || 'INSERT'),
480 $self->sql_maker->_quote ($table),
483 $self->_query_start($sql);
485 my $dbh = $self->_get_dbh;
486 eval { $dbh->do ($sql) };
489 $self->_query_end($sql);
492 $self->throw_exception (sprintf "Error executing '%s': %s",
499 sub _unset_identity_insert {
500 my ($self, $table, $op) = @_;
503 'SET IDENTITY_%s %s OFF',
504 (uc($op) || 'INSERT'),
505 $self->sql_maker->_quote ($table),
508 $self->_query_start($sql);
510 my $dbh = $self->_get_dbh;
513 $self->_query_end($sql);
517 sub _can_insert_bulk { 1 }
521 my ($source, $cols, $data) = @_;
523 my $identity_col = List::Util::first
524 { $source->column_info($_)->{is_auto_increment} }
527 my $is_identity_insert = (List::Util::first
528 { $source->column_info ($_)->{is_auto_increment} }
532 my @source_columns = $source->columns;
535 $self->_bulk_storage &&
536 $self->_get_dbh->{syb_has_blk};
538 if ((not $use_bulk_api) &&
539 (Scalar::Util::reftype($self->_dbi_connect_info->[0])||'') eq 'CODE' &&
540 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
542 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
545 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
548 if (not $use_bulk_api) {
549 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
551 my $dumb_last_insert_id =
553 && (not $is_identity_insert)
554 && ($self->_identity_method||'') ne '@@IDENTITY';
556 ($self, my ($guard)) = do {
557 if ($self->{transaction_depth} == 0 &&
558 ($blob_cols || $dumb_last_insert_id)) {
559 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard);
566 $self->_set_identity_insert ($source->name) if $is_identity_insert;
567 $self->next::method(@_);
568 $self->_unset_identity_insert ($source->name) if $is_identity_insert;
571 if ($is_identity_insert) {
572 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
575 my @cols_with_identities = (@$cols, $identity_col);
577 ## calculate identities
578 # XXX This assumes identities always increase by 1, which may or may not
580 my ($last_identity) =
581 $self->_dbh->selectrow_array (
582 $self->_fetch_identity_sql($source, $identity_col)
584 my @identities = (($last_identity - @$data + 1) .. $last_identity);
586 my @data_with_identities = map [@$_, shift @identities], @$data;
588 $self->_insert_blobs_array (
589 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
594 $guard->commit if $guard;
598 # otherwise, use the bulk API
600 # rearrange @$data so that columns are in database order
602 @orig_idx{@$cols} = 0..$#$cols;
605 @new_idx{@source_columns} = 0..$#source_columns;
608 for my $datum (@$data) {
610 for my $col (@source_columns) {
611 # identity data will be 'undef' if not $is_identity_insert
612 # columns with defaults will also be 'undef'
613 $new_datum->[ $new_idx{$col} ] =
614 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
616 push @new_data, $new_datum;
619 # bcp identity index is 1-based
620 my $identity_idx = exists $new_idx{$identity_col} ?
621 $new_idx{$identity_col} + 1 : 0;
623 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
624 # This ignores any data conversion errors detected by the client side libs, as
625 # they are usually harmless.
626 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
627 Sub::Name::subname insert_bulk => sub {
628 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
630 return 1 if $errno == 36;
633 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
634 ($errmsg ? "\n$errmsg" : '') .
635 ($osmsg ? "\n$osmsg" : '') .
636 ($blkmsg ? "\n$blkmsg" : '');
642 my $bulk = $self->_bulk_storage;
644 my $guard = $bulk->txn_scope_guard;
646 ## XXX get this to work instead of our own $sth
647 ## will require SQLA or *Hacks changes for ordered columns
648 # $bulk->next::method($source, \@source_columns, \@new_data, {
649 # syb_bcp_attribs => {
650 # identity_flag => $is_identity_insert,
651 # identity_column => $identity_idx,
654 my $sql = 'INSERT INTO ' .
655 $bulk->sql_maker->_quote($source->name) . ' (' .
656 # colname list is ignored for BCP, but does no harm
657 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
658 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
660 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
661 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
662 ## better yet the version above. Should be fixed in DBD::Sybase .
663 my $sth = $bulk->_get_dbh->prepare($sql,
667 identity_flag => $is_identity_insert,
668 identity_column => $identity_idx,
673 my $bind_attributes = $self->source_bind_attributes($source);
675 foreach my $slice_idx (0..$#source_columns) {
676 my $col = $source_columns[$slice_idx];
678 my $attributes = $bind_attributes->{$col}
679 if $bind_attributes && defined $bind_attributes->{$col};
681 my @slice = map $_->[$slice_idx], @new_data;
683 $sth->bind_param_array(($slice_idx + 1), \@slice, $attributes);
686 $bulk->_query_start($sql);
688 # this is stolen from DBI::insert_bulk
689 my $tuple_status = [];
690 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
692 if (my $err = $@ || $sth->errstr) {
694 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
696 $self->throw_exception("Unexpected populate error: $err")
697 if ($i > $#$tuple_status);
699 $self->throw_exception(sprintf "%s for populate slice:\n%s",
700 ($tuple_status->[$i][1] || $err),
701 $self->_pretty_print ({
702 map { $source_columns[$_] => $new_data[$i][$_] } (0 .. $#$cols)
710 $bulk->_query_end($sql);
713 if ($exception =~ /-Y option/) {
716 Sybase bulk API operation failed due to character set incompatibility, reverting
717 to regular array inserts:
719 *** Try unsetting the LANG environment variable.
723 $self->_bulk_storage(undef);
724 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
729 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
730 # rollback makes the bulkLogin connection unusable
731 $self->_bulk_storage->disconnect;
732 $self->throw_exception($exception);
735 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
738 # Make sure blobs are not bound as placeholders, and return any non-empty ones
740 sub _remove_blob_cols {
741 my ($self, $source, $fields) = @_;
745 for my $col (keys %$fields) {
746 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
747 my $blob_val = delete $fields->{$col};
748 if (not defined $blob_val) {
749 $fields->{$col} = \'NULL';
752 $fields->{$col} = \"''";
753 $blob_cols{$col} = $blob_val unless $blob_val eq '';
758 return keys %blob_cols ? \%blob_cols : undef;
761 # same for insert_bulk
762 sub _remove_blob_cols_array {
763 my ($self, $source, $cols, $data) = @_;
767 for my $i (0..$#$cols) {
768 my $col = $cols->[$i];
770 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
771 for my $j (0..$#$data) {
772 my $blob_val = delete $data->[$j][$i];
773 if (not defined $blob_val) {
774 $data->[$j][$i] = \'NULL';
777 $data->[$j][$i] = \"''";
778 $blob_cols[$j][$i] = $blob_val
779 unless $blob_val eq '';
785 return @blob_cols ? \@blob_cols : undef;
789 my ($self, $source, $blob_cols, $where) = @_;
791 my (@primary_cols) = $source->primary_columns;
793 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
794 unless @primary_cols;
796 # check if we're updating a single row by PK
797 my $pk_cols_in_where = 0;
798 for my $col (@primary_cols) {
799 $pk_cols_in_where++ if defined $where->{$col};
803 if ($pk_cols_in_where == @primary_cols) {
805 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
806 @rows = \%row_to_update;
808 my $cursor = $self->select ($source, \@primary_cols, $where, {});
810 my %row; @row{@primary_cols} = @$_; \%row
814 for my $row (@rows) {
815 $self->_insert_blobs($source, $blob_cols, $row);
820 my ($self, $source, $blob_cols, $row) = @_;
821 my $dbh = $self->_get_dbh;
823 my $table = $source->name;
826 my (@primary_cols) = $source->primary_columns;
828 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
829 unless @primary_cols;
831 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
832 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
835 for my $col (keys %$blob_cols) {
836 my $blob = $blob_cols->{$col};
838 my %where = map { ($_, $row{$_}) } @primary_cols;
840 my $cursor = $self->select ($source, [$col], \%where, {});
842 my $sth = $cursor->sth;
846 $self->throw_exception(
847 "Could not find row in table '$table' for blob update:\n"
848 . $self->_pretty_print (\%where)
854 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
857 $sth->func('ct_prepare_send') or die $sth->errstr;
859 my $log_on_update = $self->_blob_log_on_update;
860 $log_on_update = 1 if not defined $log_on_update;
862 $sth->func('CS_SET', 1, {
863 total_txtlen => length($blob),
864 log_on_update => $log_on_update
865 }, 'ct_data_info') or die $sth->errstr;
867 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
869 $sth->func('ct_finish_send') or die $sth->errstr;
872 $sth->finish if $sth;
874 if ($self->using_freetds) {
876 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
886 sub _insert_blobs_array {
887 my ($self, $source, $blob_cols, $cols, $data) = @_;
889 for my $i (0..$#$data) {
890 my $datum = $data->[$i];
893 @row{ @$cols } = @$datum;
896 for my $j (0..$#$cols) {
897 if (exists $blob_cols->[$i][$j]) {
898 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
902 $self->_insert_blobs ($source, \%blob_vals, \%row);
906 =head2 connect_call_datetime_setup
910 on_connect_call => 'datetime_setup'
912 In L<DBIx::Class::Storage::DBI/connect_info> to set:
914 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
915 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
917 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
918 L<DateTime::Format::Sybase>, which you will need to install.
920 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
921 C<SMALLDATETIME> columns only have minute precision.
926 my $old_dbd_warned = 0;
928 sub connect_call_datetime_setup {
930 my $dbh = $self->_dbh;
932 if ($dbh->can('syb_date_fmt')) {
933 # amazingly, this works with FreeTDS
934 $dbh->syb_date_fmt('ISO_strict');
935 } elsif (not $old_dbd_warned) {
936 carp "Your DBD::Sybase is too old to support ".
937 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
941 $dbh->do('SET DATEFORMAT mdy');
947 sub datetime_parser_type { "DateTime::Format::Sybase" }
949 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
950 # let the DBD keep any state it needs to.
952 # If they ever do start working, the extra statements will do no harm (because
953 # Sybase supports nested transactions.)
955 sub _dbh_begin_work {
958 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
959 # TRAN once. However, we need to make sure there's a $dbh.
960 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
962 $self->next::method(@_);
964 if ($self->using_freetds) {
965 $self->_get_dbh->do('BEGIN TRAN');
968 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
973 if ($self->using_freetds) {
974 $self->_dbh->do('COMMIT');
976 return $self->next::method(@_);
981 if ($self->using_freetds) {
982 $self->_dbh->do('ROLLBACK');
984 return $self->next::method(@_);
987 # savepoint support using ASE syntax
990 my ($self, $name) = @_;
992 $self->_get_dbh->do("SAVE TRANSACTION $name");
995 # A new SAVE TRANSACTION with the same name releases the previous one.
996 sub _svp_release { 1 }
999 my ($self, $name) = @_;
1001 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
1006 =head1 Schema::Loader Support
1008 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
1009 allow you to dump a schema from most (if not all) versions of Sybase.
1011 It is available via subversion from:
1013 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
1017 This driver supports L<DBD::Sybase> compiled against FreeTDS
1018 (L<http://www.freetds.org/>) to the best of our ability, however it is
1019 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
1020 libraries. They are a part of the Sybase ASE distribution:
1022 The Open Client FAQ is here:
1023 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
1025 Sybase ASE for Linux (which comes with the Open Client libraries) may be
1026 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
1028 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
1030 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
1032 Some versions of the libraries involved will not support placeholders, in which
1033 case the storage will be reblessed to
1034 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
1036 In some configurations, placeholders will work but will throw implicit type
1037 conversion errors for anything that's not expecting a string. In such a case,
1038 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
1039 automatically set, which you may enable on connection with
1040 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
1041 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
1042 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
1043 already) using a mapping based on L<SQL::Translator>.
1045 In other configurations, placeholers will work just as they do with the Sybase
1046 Open Client libraries.
1048 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
1050 =head1 INSERTS WITH PLACEHOLDERS
1052 With placeholders enabled, inserts are done in a transaction so that there are
1053 no concurrency issues with getting the inserted identity value using
1054 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
1057 In addition, they are done on a separate connection so that it's possible to
1058 have active cursors when doing an insert.
1060 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
1061 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
1066 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
1067 begin a transaction while there are active cursors. An active cursor is, for
1068 example, a L<ResultSet|DBIx::Class::ResultSet> that has been executed using
1069 C<next> or C<first> but has not been exhausted or
1070 L<reset|DBIx::Class::ResultSet/reset>.
1072 For example, this will not work:
1074 $schema->txn_do(sub {
1075 my $rs = $schema->resultset('Book');
1076 while (my $row = $rs->next) {
1077 $schema->resultset('MetaData')->create({
1078 book_id => $row->id,
1084 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1085 are not affected, as they are done on an extra database handle.
1091 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1093 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1095 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1099 =head1 MAXIMUM CONNECTIONS
1101 The TDS protocol makes separate connections to the server for active statements
1102 in the background. By default the number of such connections is limited to 25,
1103 on both the client side and the server side.
1105 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1106 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1107 can override it to whatever setting you like in the DSN.
1110 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1111 for information on changing the setting on the server side.
1115 See L</connect_call_datetime_setup> to setup date formats
1116 for L<DBIx::Class::InflateColumn::DateTime>.
1118 =head1 TEXT/IMAGE COLUMNS
1120 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1121 C<TEXT/IMAGE> columns.
1123 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1125 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1129 $schema->storage->set_textsize($bytes);
1133 However, the C<LongReadLen> you pass in
1134 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
1135 C<SET TEXTSIZE> command on connection.
1137 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
1138 setting you need to work with C<IMAGE> columns.
1142 The experimental L<DBD::Sybase> Bulk API support is used for
1143 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1144 on a separate connection.
1146 To use this feature effectively, use a large number of rows for each
1147 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1149 while (my $rows = $data_source->get_100_rows()) {
1150 $rs->populate($rows);
1153 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1154 calls in your C<Result> classes B<must> list columns in database order for this
1155 to work. Also, you may have to unset the C<LANG> environment variable before
1156 loading your app, if it doesn't match the character set of your database.
1158 When inserting IMAGE columns using this method, you'll need to use
1159 L</connect_call_blob_setup> as well.
1163 See L<DBIx::Class/CONTRIBUTORS>.
1167 You may distribute this code under the same terms as Perl itself.