1 package DBIx::Class::Storage::DBI::Sybase::ASE;
7 DBIx::Class::Storage::DBI::Sybase
8 DBIx::Class::Storage::DBI::AutoCast
9 DBIx::Class::Storage::DBI::IdentityInsert
12 use DBIx::Class::Carp;
13 use Scalar::Util qw/blessed weaken/;
14 use List::Util 'first';
16 use Data::Dumper::Concise 'Dumper';
18 use Context::Preserve 'preserve_context';
21 __PACKAGE__->sql_limit_dialect ('GenericSubQ');
22 __PACKAGE__->sql_quote_char ([qw/[ ]/]);
23 __PACKAGE__->datetime_parser_type(
24 'DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format'
27 __PACKAGE__->mk_group_accessors('simple' =>
28 qw/_identity _identity_method _blob_log_on_update _parent_storage
29 _writer_storage _is_writer_storage
30 _bulk_storage _is_bulk_storage _began_bulk_work
35 my @also_proxy_to_extra_storages = qw/
36 connect_call_set_auto_cast auto_cast connect_call_blob_setup
37 connect_call_datetime_setup
39 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
40 auto_savepoint unsafe cursor_class debug debugobj schema
45 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
50 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
54 If your version of Sybase does not support placeholders, then your storage will
55 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
56 You can also enable that driver explicitly, see the documentation for more
59 With this driver there is unfortunately no way to get the C<last_insert_id>
60 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
61 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
63 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
65 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
74 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
76 if ($self->_using_freetds) {
77 carp_once <<'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::ASE for more details.
91 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
95 if (not $self->_use_typeless_placeholders) {
96 if ($self->_use_placeholders) {
100 $self->ensure_class_loaded($no_bind_vars);
101 bless $self, $no_bind_vars;
107 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
108 # not necessarily FreeTDS, but no placeholders nevertheless
109 $self->ensure_class_loaded($no_bind_vars);
110 bless $self, $no_bind_vars;
113 # this is highly unlikely, but we check just in case
114 elsif (not $self->_use_typeless_placeholders) {
122 $self->next::method(@_);
124 if ($self->_using_freetds && (my $ver = $self->_using_freetds_version||999) > 0.82) {
126 "Buggy FreeTDS version $ver detected, statement caching will not work and "
127 . 'will be disabled.'
129 $self->disable_sth_caching(1);
132 $self->_set_max_connect(256);
134 # create storage for insert/(update blob) transactions,
135 # unless this is that storage
136 return if $self->_parent_storage;
138 my $writer_storage = (ref $self)->new;
140 $writer_storage->_is_writer_storage(1); # just info
141 $writer_storage->connect_info($self->connect_info);
142 $writer_storage->auto_cast($self->auto_cast);
144 weaken ($writer_storage->{_parent_storage} = $self);
145 $self->_writer_storage($writer_storage);
147 # create a bulk storage unless connect_info is a coderef
148 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
150 my $bulk_storage = (ref $self)->new;
152 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
153 $bulk_storage->connect_info($self->connect_info);
156 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
158 weaken ($bulk_storage->{_parent_storage} = $self);
159 $self->_bulk_storage($bulk_storage);
162 for my $method (@also_proxy_to_extra_storages) {
164 no warnings 'redefine';
166 my $replaced = __PACKAGE__->can($method);
168 *{$method} = Sub::Name::subname $method => sub {
170 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
171 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
172 return $self->$replaced(@_);
179 # Even though we call $sth->finish for uses off the bulk API, there's still an
180 # "active statement" warning on disconnect, which we throw away here.
181 # This is due to the bug described in insert_bulk.
182 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
183 local $SIG{__WARN__} = sub {
184 warn $_[0] unless $_[0] =~ /active statement/i;
185 } if $self->_is_bulk_storage;
187 # so that next transaction gets a dbh
188 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
193 # This is only invoked for FreeTDS drivers by ::Storage::DBI::Sybase::FreeTDS
194 sub _set_autocommit_stmt {
195 my ($self, $on) = @_;
197 return 'SET CHAINED ' . ($on ? 'OFF' : 'ON');
200 # Set up session settings for Sybase databases for the connection.
202 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
203 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
204 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
205 # only want when AutoCommit is off.
206 sub _run_connection_actions {
209 if ($self->_is_bulk_storage) {
210 # this should be cleared on every reconnect
211 $self->_began_bulk_work(0);
215 $self->_dbh->{syb_chained_txn} = 1
216 unless $self->_using_freetds;
218 $self->next::method(@_);
221 =head2 connect_call_blob_setup
225 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
227 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
228 instead of as a hex string.
232 Also sets the C<log_on_update> value for blob write operations. The default is
233 C<1>, but C<0> is better if your database is configured for it.
236 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
240 sub connect_call_blob_setup {
243 my $dbh = $self->_dbh;
244 $dbh->{syb_binary_images} = 1;
246 $self->_blob_log_on_update($args{log_on_update})
247 if exists $args{log_on_update};
251 my ($self, $source, $column) = @_;
253 return $self->_is_lob_type($source->column_info($column)->{data_type});
256 sub _prep_for_execute {
257 my ($self, $op, $ident, $args) = @_;
260 ### This is commented out because all tests pass. However I am leaving it
261 ### here as it may prove necessary (can't think through all combinations)
262 ### BTW it doesn't currently work exactly - need better sensitivity to
263 # currently set value
265 #my ($op, $ident) = @_;
267 # inherit these from the parent for the duration of _prep_for_execute
268 # Don't know how to make a localizing loop with if's, otherwise I would
269 #local $self->{_autoinc_supplied_for_op}
270 # = $self->_parent_storage->_autoinc_supplied_for_op
271 #if ($op eq 'insert' or $op eq 'update') and $self->_parent_storage;
272 #local $self->{_perform_autoinc_retrieval}
273 # = $self->_parent_storage->_perform_autoinc_retrieval
274 #if ($op eq 'insert' or $op eq 'update') and $self->_parent_storage;
276 my $limit; # extract and use shortcut on limit without offset
277 if ($op eq 'select' and ! $args->[4] and $limit = $args->[3]) {
282 my ($sql, $bind) = $self->next::method($op, $ident, $args);
284 # $limit is already sanitized by now
286 "SET ROWCOUNT $limit",
291 if (my $identity_col = $self->_perform_autoinc_retrieval) {
292 $sql .= "\n" . $self->_fetch_identity_sql($ident, $identity_col)
295 return ($sql, $bind);
298 sub _fetch_identity_sql {
299 my ($self, $source, $col) = @_;
301 return sprintf ("SELECT MAX(%s) FROM %s",
302 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
306 # Stolen from SQLT, with some modifications. This is a makeshift
307 # solution before a sane type-mapping library is available, thus
308 # the 'our' for easy overrides.
309 our %TYPE_MAPPING = (
312 varchar => 'varchar',
313 varchar2 => 'varchar',
314 timestamp => 'datetime',
316 real => 'double precision',
319 tinyint => 'smallint',
320 float => 'double precision',
322 bigserial => 'numeric',
323 boolean => 'varchar',
327 sub _native_data_type {
328 my ($self, $type) = @_;
331 $type =~ s/\s* identity//x;
333 return uc($TYPE_MAPPING{$type} || $type);
339 my ($rv, $sth, @bind) = $self->next::method(@_);
341 $self->_identity( ($sth->fetchall_arrayref)->[0][0] )
342 if $self->_perform_autoinc_retrieval;
344 return wantarray ? ($rv, $sth, @bind) : $rv;
347 sub last_insert_id { shift->_identity }
349 # handles TEXT/IMAGE and transaction for last_insert_id
352 my ($source, $to_insert) = @_;
354 my $columns_info = $source->columns_info;
357 (first { $columns_info->{$_}{is_auto_increment} }
358 keys %$columns_info )
361 # FIXME - this is duplication from DBI.pm. When refactored towards
362 # the LobWriter this can be folded back where it belongs.
363 local $self->{_autoinc_supplied_for_op} = exists $to_insert->{$identity_col}
367 local $self->{_perform_autoinc_retrieval} =
368 ($identity_col and ! exists $to_insert->{$identity_col})
373 # check for empty insert
374 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
375 # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
376 # and computed columns)
377 if (not %$to_insert) {
378 for my $col ($source->columns) {
379 next if $col eq $identity_col;
381 my $info = $source->column_info($col);
383 next if ref $info->{default_value} eq 'SCALAR'
384 || (exists $info->{data_type} && (not defined $info->{data_type}));
386 next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
388 $to_insert->{$col} = \'DEFAULT';
392 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
394 # do we need the horrific SELECT MAX(COL) hack?
395 my $need_dumb_last_insert_id = (
396 $self->_perform_autoinc_retrieval
398 ($self->_identity_method||'') ne '@@IDENTITY'
401 my $next = $self->next::can;
403 # we are already in a transaction, or there are no blobs
404 # and we don't need the PK - just (try to) do it
405 if ($self->{transaction_depth}
406 || (!$blob_cols && !$need_dumb_last_insert_id)
408 return $self->_insert (
409 $next, $source, $to_insert, $blob_cols, $identity_col
413 # otherwise use the _writer_storage to do the insert+transaction on another
415 my $guard = $self->_writer_storage->txn_scope_guard;
417 my $updated_cols = $self->_writer_storage->_insert (
418 $next, $source, $to_insert, $blob_cols, $identity_col
421 $self->_identity($self->_writer_storage->_identity);
425 return $updated_cols;
429 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
431 my $updated_cols = $self->$next ($source, $to_insert);
435 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
440 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
442 return $updated_cols;
447 my ($source, $fields, $where, @rest) = @_;
450 # When *updating* identities, ASE requires SET IDENTITY_UPDATE called
452 if (my $blob_cols = $self->_remove_blob_cols($source, $fields)) {
454 # If there are any blobs in $where, Sybase will return a descriptive error
456 # XXX blobs can still be used with a LIKE query, and this should be handled.
458 # update+blob update(s) done atomically on separate connection
459 $self = $self->_writer_storage;
461 my $guard = $self->txn_scope_guard;
463 # First update the blob columns to be updated to '' (taken from $fields, where
464 # it is originally put by _remove_blob_cols .)
465 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
467 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
468 $self->next::method($source, \%blobs_to_empty, $where, @rest);
470 # Now update the blobs before the other columns in case the update of other
471 # columns makes the search condition invalid.
472 my $rv = $self->_update_blobs($source, $blob_cols, $where);
476 # Now set the identity update flags for the actual update
477 local $self->{_autoinc_supplied_for_op} = (first
478 { $_->{is_auto_increment} }
479 values %{ $source->columns_info([ keys %$fields ]) }
482 my $next = $self->next::can;
484 return preserve_context {
485 $self->$next(@$args);
486 } after => sub { $guard->commit };
494 # Set the identity update flags for the actual update
495 local $self->{_autoinc_supplied_for_op} = (first
496 { $_->{is_auto_increment} }
497 values %{ $source->columns_info([ keys %$fields ]) }
500 return $self->next::method(@_);
506 my ($source, $cols, $data) = @_;
508 my $columns_info = $source->columns_info;
511 first { $columns_info->{$_}{is_auto_increment} }
514 # FIXME - this is duplication from DBI.pm. When refactored towards
515 # the LobWriter this can be folded back where it belongs.
516 local $self->{_autoinc_supplied_for_op} =
517 (first { $_ eq $identity_col } @$cols)
523 $self->_bulk_storage &&
524 $self->_get_dbh->{syb_has_blk};
526 if (! $use_bulk_api and ref($self->_dbi_connect_info->[0]) eq 'CODE') {
527 carp_unique( join ' ',
528 'Bulk API support disabled due to use of a CODEREF connect_info.',
529 'Reverting to regular array inserts.',
533 if (not $use_bulk_api) {
534 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
536 # next::method uses a txn anyway, but it ends too early in case we need to
537 # select max(col) to get the identity for inserting blobs.
538 ($self, my $guard) = $self->{transaction_depth} == 0 ?
539 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
543 $self->next::method(@_);
546 if ($self->_autoinc_supplied_for_op) {
547 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
550 my @cols_with_identities = (@$cols, $identity_col);
552 ## calculate identities
553 # XXX This assumes identities always increase by 1, which may or may not
555 my ($last_identity) =
556 $self->_dbh->selectrow_array (
557 $self->_fetch_identity_sql($source, $identity_col)
559 my @identities = (($last_identity - @$data + 1) .. $last_identity);
561 my @data_with_identities = map [@$_, shift @identities], @$data;
563 $self->_insert_blobs_array (
564 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
569 $guard->commit if $guard;
574 # otherwise, use the bulk API
576 # rearrange @$data so that columns are in database order
577 # and so we submit a full column list
578 my %orig_order = map { $cols->[$_] => $_ } 0..$#$cols;
580 my @source_columns = $source->columns;
582 # bcp identity index is 1-based
583 my $identity_idx = first { $source_columns[$_] eq $identity_col } (0..$#source_columns);
584 $identity_idx = defined $identity_idx ? $identity_idx + 1 : 0;
587 for my $slice_idx (0..$#$data) {
588 push @new_data, [map {
589 # identity data will be 'undef' if not _autoinc_supplied_for_op()
590 # columns with defaults will also be 'undef'
591 exists $orig_order{$_}
592 ? $data->[$slice_idx][$orig_order{$_}]
597 my $proto_bind = $self->_resolve_bindattrs(
600 [ { dbic_colname => $source_columns[$_], _bind_data_slice_idx => $_ }
601 => $new_data[0][$_] ]
602 } (0 ..$#source_columns) ],
606 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
607 # This ignores any data conversion errors detected by the client side libs, as
608 # they are usually harmless.
609 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
610 Sub::Name::subname insert_bulk => sub {
611 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
613 return 1 if $errno == 36;
616 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
617 ($errmsg ? "\n$errmsg" : '') .
618 ($osmsg ? "\n$osmsg" : '') .
619 ($blkmsg ? "\n$blkmsg" : '');
626 my $bulk = $self->_bulk_storage;
628 my $guard = $bulk->txn_scope_guard;
630 ## FIXME - once this is done - address the FIXME on finish() below
631 ## XXX get this to work instead of our own $sth
632 ## will require SQLA or *Hacks changes for ordered columns
633 # $bulk->next::method($source, \@source_columns, \@new_data, {
634 # syb_bcp_attribs => {
635 # identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
636 # identity_column => $identity_idx,
639 my $sql = 'INSERT INTO ' .
640 $bulk->sql_maker->_quote($source->name) . ' (' .
641 # colname list is ignored for BCP, but does no harm
642 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
643 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
645 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
646 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
647 ## better yet the version above. Should be fixed in DBD::Sybase .
648 my $sth = $bulk->_get_dbh->prepare($sql,
652 identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
653 identity_column => $identity_idx,
659 # FIXME the $sth->finish in _execute_array does a rollback for some
660 # reason. Disable it temporarily until we fix the SQLMaker thing above
661 no warnings 'redefine';
663 local *{ref($sth).'::finish'} = sub {};
665 $self->_dbh_execute_for_fetch(
666 $source, $sth, $proto_bind, \@source_columns, \@new_data
672 $bulk->_query_end($sql);
677 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
679 if ($exception =~ /-Y option/) {
680 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
681 . 'reverting to regular array inserts. Try unsetting the LANG environment variable'
683 $w .= "\n$exception" if $self->debug;
686 $self->_bulk_storage(undef);
691 # rollback makes the bulkLogin connection unusable
692 $self->_bulk_storage->disconnect;
693 $self->throw_exception($exception);
697 # Make sure blobs are not bound as placeholders, and return any non-empty ones
699 sub _remove_blob_cols {
700 my ($self, $source, $fields) = @_;
704 for my $col (keys %$fields) {
705 if ($self->_is_lob_column($source, $col)) {
706 my $blob_val = delete $fields->{$col};
707 if (not defined $blob_val) {
708 $fields->{$col} = \'NULL';
711 $fields->{$col} = \"''";
712 $blob_cols{$col} = $blob_val unless $blob_val eq '';
717 return %blob_cols ? \%blob_cols : undef;
720 # same for insert_bulk
721 sub _remove_blob_cols_array {
722 my ($self, $source, $cols, $data) = @_;
726 for my $i (0..$#$cols) {
727 my $col = $cols->[$i];
729 if ($self->_is_lob_column($source, $col)) {
730 for my $j (0..$#$data) {
731 my $blob_val = delete $data->[$j][$i];
732 if (not defined $blob_val) {
733 $data->[$j][$i] = \'NULL';
736 $data->[$j][$i] = \"''";
737 $blob_cols[$j][$i] = $blob_val
738 unless $blob_val eq '';
744 return @blob_cols ? \@blob_cols : undef;
748 my ($self, $source, $blob_cols, $where) = @_;
750 my @primary_cols = try
751 { $source->_pri_cols }
753 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
760 @primary_cols == grep { defined $where->{$_} } @primary_cols
763 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
764 @pks_to_update = \%row_to_update;
767 my $cursor = $self->select ($source, \@primary_cols, $where, {});
768 @pks_to_update = map {
769 my %row; @row{@primary_cols} = @$_; \%row
773 for my $ident (@pks_to_update) {
774 $self->_insert_blobs($source, $blob_cols, $ident);
779 my ($self, $source, $blob_cols, $row) = @_;
780 my $dbh = $self->_get_dbh;
782 my $table = $source->name;
785 my @primary_cols = try
786 { $source->_pri_cols }
788 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
791 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
792 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
794 for my $col (keys %$blob_cols) {
795 my $blob = $blob_cols->{$col};
797 my %where = map { ($_, $row{$_}) } @primary_cols;
799 my $cursor = $self->select ($source, [$col], \%where, {});
801 my $sth = $cursor->sth;
804 $self->throw_exception(
805 "Could not find row in table '$table' for blob update:\n"
812 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
815 $sth->func('ct_prepare_send') or die $sth->errstr;
817 my $log_on_update = $self->_blob_log_on_update;
818 $log_on_update = 1 if not defined $log_on_update;
820 $sth->func('CS_SET', 1, {
821 total_txtlen => length($blob),
822 log_on_update => $log_on_update
823 }, 'ct_data_info') or die $sth->errstr;
825 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
827 $sth->func('ct_finish_send') or die $sth->errstr;
830 if ($self->_using_freetds) {
831 $self->throw_exception (
832 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
836 $self->throw_exception($_);
840 $sth->finish if $sth;
845 sub _insert_blobs_array {
846 my ($self, $source, $blob_cols, $cols, $data) = @_;
848 for my $i (0..$#$data) {
849 my $datum = $data->[$i];
852 @row{ @$cols } = @$datum;
855 for my $j (0..$#$cols) {
856 if (exists $blob_cols->[$i][$j]) {
857 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
861 $self->_insert_blobs ($source, \%blob_vals, \%row);
865 =head2 connect_call_datetime_setup
869 on_connect_call => 'datetime_setup'
871 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
873 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
874 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
876 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
877 C<SMALLDATETIME> columns only have minute precision.
881 sub connect_call_datetime_setup {
883 my $dbh = $self->_get_dbh;
885 if ($dbh->can('syb_date_fmt')) {
886 # amazingly, this works with FreeTDS
887 $dbh->syb_date_fmt('ISO_strict');
891 'Your DBD::Sybase is too old to support '
892 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
894 # FIXME - in retrospect this is a rather bad US-centric choice
895 # of format. Not changing as a bugwards compat, though in reality
896 # the only piece that sees the results of $dt object formatting
897 # (as opposed to parsing) is the database itself, so theoretically
898 # changing both this SET command and the formatter definition of
899 # ::S::D::Sybase::ASE::DateTime::Format below should be safe and
902 $dbh->do('SET DATEFORMAT mdy');
907 sub _exec_txn_begin {
910 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
911 # TRAN once. However, we need to make sure there's a $dbh.
912 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
914 $self->next::method(@_);
916 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
919 # savepoint support using ASE syntax
921 sub _exec_svp_begin {
922 my ($self, $name) = @_;
924 $self->_dbh->do("SAVE TRANSACTION $name");
927 # A new SAVE TRANSACTION with the same name releases the previous one.
928 sub _exec_svp_release { 1 }
930 sub _exec_svp_rollback {
931 my ($self, $name) = @_;
933 $self->_dbh->do("ROLLBACK TRANSACTION $name");
936 package # hide from PAUSE
937 DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format;
939 my $datetime_parse_format = '%Y-%m-%dT%H:%M:%S.%3NZ';
940 my $datetime_format_format = '%m/%d/%Y %H:%M:%S.%3N';
942 my ($datetime_parser, $datetime_formatter);
946 require DateTime::Format::Strptime;
947 $datetime_parser ||= DateTime::Format::Strptime->new(
948 pattern => $datetime_parse_format,
951 return $datetime_parser->parse_datetime(shift);
954 sub format_datetime {
956 require DateTime::Format::Strptime;
957 $datetime_formatter ||= DateTime::Format::Strptime->new(
958 pattern => $datetime_format_format,
961 return $datetime_formatter->format_datetime(shift);
966 =head1 Schema::Loader Support
968 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
969 most versions of Sybase ASE.
973 This driver supports L<DBD::Sybase> compiled against FreeTDS
974 (L<http://www.freetds.org/>) to the best of our ability, however it is
975 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
976 libraries. They are a part of the Sybase ASE distribution:
978 The Open Client FAQ is here:
979 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
981 Sybase ASE for Linux (which comes with the Open Client libraries) may be
982 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
984 To see if you're using FreeTDS run:
986 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
988 It is recommended to set C<tds version> for your ASE server to C<5.0> in
989 C</etc/freetds/freetds.conf>.
991 Some versions or configurations of the libraries involved will not support
992 placeholders, in which case the storage will be reblessed to
993 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
995 In some configurations, placeholders will work but will throw implicit type
996 conversion errors for anything that's not expecting a string. In such a case,
997 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
998 automatically set, which you may enable on connection with
999 L<connect_call_set_auto_cast|DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>.
1000 The type info for the C<CAST>s is taken from the
1001 L<DBIx::Class::ResultSource/data_type> definitions in your Result classes, and
1002 are mapped to a Sybase type (if it isn't already) using a mapping based on
1005 In other configurations, placeholders will work just as they do with the Sybase
1006 Open Client libraries.
1008 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
1010 =head1 INSERTS WITH PLACEHOLDERS
1012 With placeholders enabled, inserts are done in a transaction so that there are
1013 no concurrency issues with getting the inserted identity value using
1014 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
1017 In addition, they are done on a separate connection so that it's possible to
1018 have active cursors when doing an insert.
1020 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
1021 are unnecessary and not used, as there are no concurrency issues with C<SELECT
1022 @@IDENTITY> which is a session variable.
1026 Due to limitations of the TDS protocol and L<DBD::Sybase>, you cannot begin a
1027 transaction while there are active cursors, nor can you use multiple active
1028 cursors within a transaction. An active cursor is, for example, a
1029 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1030 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1032 For example, this will not work:
1034 $schema->txn_do(sub {
1035 my $rs = $schema->resultset('Book');
1036 while (my $row = $rs->next) {
1037 $schema->resultset('MetaData')->create({
1038 book_id => $row->id,
1046 my $first_row = $large_rs->first;
1047 $schema->txn_do(sub { ... });
1049 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1050 are not affected, as they are done on an extra database handle.
1056 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1058 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1060 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1064 =head1 MAXIMUM CONNECTIONS
1066 The TDS protocol makes separate connections to the server for active statements
1067 in the background. By default the number of such connections is limited to 25,
1068 on both the client side and the server side.
1070 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1071 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1072 can override it to whatever setting you like in the DSN.
1075 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1076 for information on changing the setting on the server side.
1080 See L</connect_call_datetime_setup> to setup date formats
1081 for L<DBIx::Class::InflateColumn::DateTime>.
1083 =head1 LIMITED QUERIES
1085 Because ASE does not have a good way to limit results in SQL that works for all
1086 types of queries, the limit dialect is set to
1087 L<GenericSubQ|SQL::Abstract::Limit/GenericSubQ>.
1089 Fortunately, ASE and L<DBD::Sybase> support cursors properly, so when
1090 L<GenericSubQ|SQL::Abstract::Limit/GenericSubQ> is too slow you can use
1091 the L<software_limit|DBIx::Class::ResultSet/software_limit>
1092 L<DBIx::Class::ResultSet> attribute to simulate limited queries by skipping over
1095 =head1 TEXT/IMAGE COLUMNS
1097 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1098 C<TEXT/IMAGE> columns.
1100 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1102 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1106 $schema->storage->set_textsize($bytes);
1110 However, the C<LongReadLen> you pass in
1111 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1112 equivalent C<SET TEXTSIZE> command on connection.
1114 See L</connect_call_blob_setup> for a
1115 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1116 with C<IMAGE> columns.
1120 The experimental L<DBD::Sybase> Bulk API support is used for
1121 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1122 on a separate connection.
1124 To use this feature effectively, use a large number of rows for each
1125 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1127 while (my $rows = $data_source->get_100_rows()) {
1128 $rs->populate($rows);
1131 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1132 calls in your C<Result> classes B<must> list columns in database order for this
1133 to work. Also, you may have to unset the C<LANG> environment variable before
1134 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1136 When inserting IMAGE columns using this method, you'll need to use
1137 L</connect_call_blob_setup> as well.
1139 =head1 COMPUTED COLUMNS
1141 If you have columns such as:
1143 created_dtm AS getdate()
1145 represent them in your Result classes as:
1149 default_value => \'getdate()',
1151 inflate_datetime => 1,
1154 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1155 on tables with such columns.
1157 =head1 TIMESTAMP COLUMNS
1159 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1160 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1162 They should be defined in your Result classes as:
1165 data_type => 'timestamp',
1167 inflate_datetime => 0,
1170 The C<<inflate_datetime => 0>> is necessary if you use
1171 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1172 be able to read these values.
1174 The values will come back as hexadecimal.
1182 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1183 any active cursors, using eager cursors.
1187 Real limits and limited counts using stored procedures deployed on startup.
1191 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1195 bulk_insert using prepare_cached (see comments.)
1201 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
1205 You may distribute this code under the same terms as Perl itself.