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(
22 'DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format'
25 __PACKAGE__->mk_group_accessors('simple' =>
26 qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
27 _bulk_storage _is_bulk_storage _began_bulk_work
32 my @also_proxy_to_extra_storages = qw/
33 connect_call_set_auto_cast auto_cast connect_call_blob_setup
34 connect_call_datetime_setup
36 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
37 auto_savepoint unsafe cursor_class debug debugobj schema
42 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
47 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
51 If your version of Sybase does not support placeholders, then your storage will
52 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
53 You can also enable that driver explicitly, see the documentation for more
56 With this driver there is unfortunately no way to get the C<last_insert_id>
57 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
58 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
60 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
62 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
71 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
73 if ($self->using_freetds) {
74 carp_once <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
76 You are using FreeTDS with Sybase.
78 We will do our best to support this configuration, but please consider this
81 TEXT/IMAGE columns will definitely not work.
83 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
86 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
88 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
92 if (not $self->_use_typeless_placeholders) {
93 if ($self->_use_placeholders) {
97 $self->ensure_class_loaded($no_bind_vars);
98 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;
110 # this is highly unlikely, but we check just in case
111 elsif (not $self->_use_typeless_placeholders) {
118 $self->_set_max_connect(256);
120 # create storage for insert/(update blob) transactions,
121 # unless this is that storage
122 return if $self->_is_extra_storage;
124 my $writer_storage = (ref $self)->new;
126 $writer_storage->_is_extra_storage(1);
127 $writer_storage->connect_info($self->connect_info);
128 $writer_storage->auto_cast($self->auto_cast);
130 $self->_writer_storage($writer_storage);
132 # create a bulk storage unless connect_info is a coderef
133 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
135 my $bulk_storage = (ref $self)->new;
137 $bulk_storage->_is_extra_storage(1);
138 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
139 $bulk_storage->connect_info($self->connect_info);
142 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
144 $self->_bulk_storage($bulk_storage);
147 for my $method (@also_proxy_to_extra_storages) {
149 no warnings 'redefine';
151 my $replaced = __PACKAGE__->can($method);
153 *{$method} = Sub::Name::subname $method => sub {
155 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
156 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
157 return $self->$replaced(@_);
164 # Even though we call $sth->finish for uses off the bulk API, there's still an
165 # "active statement" warning on disconnect, which we throw away here.
166 # This is due to the bug described in insert_bulk.
167 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
168 local $SIG{__WARN__} = sub {
169 warn $_[0] unless $_[0] =~ /active statement/i;
170 } if $self->_is_bulk_storage;
172 # so that next transaction gets a dbh
173 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
178 # This is only invoked for FreeTDS drivers by ::Storage::DBI::Sybase::FreeTDS
179 sub _set_autocommit_stmt {
180 my ($self, $on) = @_;
182 return 'SET CHAINED ' . ($on ? 'OFF' : 'ON');
185 # Set up session settings for Sybase databases for the connection.
187 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
188 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
189 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
190 # only want when AutoCommit is off.
191 sub _run_connection_actions {
194 if ($self->_is_bulk_storage) {
195 # this should be cleared on every reconnect
196 $self->_began_bulk_work(0);
200 $self->_dbh->{syb_chained_txn} = 1
201 unless $self->using_freetds;
203 $self->next::method(@_);
206 =head2 connect_call_blob_setup
210 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
212 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
213 instead of as a hex string.
217 Also sets the C<log_on_update> value for blob write operations. The default is
218 C<1>, but C<0> is better if your database is configured for it.
221 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
225 sub connect_call_blob_setup {
228 my $dbh = $self->_dbh;
229 $dbh->{syb_binary_images} = 1;
231 $self->_blob_log_on_update($args{log_on_update})
232 if exists $args{log_on_update};
236 my ($self, $source, $column) = @_;
238 return $self->_is_lob_type($source->column_info($column)->{data_type});
241 sub _prep_for_execute {
243 my ($op, $ident, $args) = @_;
245 my ($sql, $bind) = $self->next::method (@_);
247 my $table = blessed $ident ? $ident->from : $ident;
249 my $bind_info = $self->_resolve_column_info(
250 $ident, [map { $_->[0]{dbic_colname} || () } @{$bind}]
252 my $bound_identity_col =
253 first { $bind_info->{$_}{is_auto_increment} }
257 my $columns_info = blessed $ident && $ident->columns_info;
261 first { $columns_info->{$_}{is_auto_increment} }
266 ($bound_identity_col and $op eq 'insert')
271 defined $identity_col
273 exists $args->[0]{$identity_col}
277 $self->_set_table_identity_sql($op => $table, 'on'),
279 $self->_set_table_identity_sql($op => $table, 'off'),
284 (not $bound_identity_col)
288 (not $self->{insert_bulk})
294 $self->_fetch_identity_sql($ident, $identity_col);
297 return ($sql, $bind);
300 sub _set_table_identity_sql {
301 my ($self, $op, $table, $on_off) = @_;
303 return sprintf 'SET IDENTITY_%s %s %s',
304 uc($op), $self->sql_maker->_quote($table), uc($on_off);
307 # Stolen from SQLT, with some modifications. This is a makeshift
308 # solution before a sane type-mapping library is available, thus
309 # the 'our' for easy overrides.
310 our %TYPE_MAPPING = (
313 varchar => 'varchar',
314 varchar2 => 'varchar',
315 timestamp => 'datetime',
317 real => 'double precision',
320 tinyint => 'smallint',
321 float => 'double precision',
323 bigserial => 'numeric',
324 boolean => 'varchar',
328 sub _native_data_type {
329 my ($self, $type) = @_;
332 $type =~ s/\s* identity//x;
334 return uc($TYPE_MAPPING{$type} || $type);
337 sub _fetch_identity_sql {
338 my ($self, $source, $col) = @_;
340 return sprintf ("SELECT MAX(%s) FROM %s",
341 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
349 my ($rv, $sth, @bind) = $self->next::method(@_);
351 if ($op eq 'insert') {
352 $self->_identity($sth->fetchrow_array);
356 return wantarray ? ($rv, $sth, @bind) : $rv;
359 sub last_insert_id { shift->_identity }
361 # handles TEXT/IMAGE and transaction for last_insert_id
364 my ($source, $to_insert) = @_;
366 my $columns_info = $source->columns_info;
369 (first { $columns_info->{$_}{is_auto_increment} }
370 keys %$columns_info )
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 $dumb_last_insert_id =
397 && (not exists $to_insert->{$identity_col})
398 && ($self->_identity_method||'') ne '@@IDENTITY';
400 my $next = $self->next::can;
402 # we are already in a transaction, or there are no blobs
403 # and we don't need the PK - just (try to) do it
404 if ($self->{transaction_depth}
405 || (!$blob_cols && !$dumb_last_insert_id)
407 return $self->_insert (
408 $next, $source, $to_insert, $blob_cols, $identity_col
412 # otherwise use the _writer_storage to do the insert+transaction on another
414 my $guard = $self->_writer_storage->txn_scope_guard;
416 my $updated_cols = $self->_writer_storage->_insert (
417 $next, $source, $to_insert, $blob_cols, $identity_col
420 $self->_identity($self->_writer_storage->_identity);
424 return $updated_cols;
428 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
430 my $updated_cols = $self->$next ($source, $to_insert);
434 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
439 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
441 return $updated_cols;
446 my ($source, $fields, $where, @rest) = @_;
448 my $blob_cols = $self->_remove_blob_cols($source, $fields);
450 my $table = $source->name;
452 my $columns_info = $source->columns_info;
455 first { $columns_info->{$_}{is_auto_increment} }
458 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
460 return $self->next::method(@_) unless $blob_cols;
462 # If there are any blobs in $where, Sybase will return a descriptive error
464 # XXX blobs can still be used with a LIKE query, and this should be handled.
466 # update+blob update(s) done atomically on separate connection
467 $self = $self->_writer_storage;
469 my $guard = $self->txn_scope_guard;
471 # First update the blob columns to be updated to '' (taken from $fields, where
472 # it is originally put by _remove_blob_cols .)
473 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
475 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
476 $self->next::method($source, \%blobs_to_empty, $where, @rest);
478 # Now update the blobs before the other columns in case the update of other
479 # columns makes the search condition invalid.
480 $self->_update_blobs($source, $blob_cols, $where);
485 @res = $self->next::method(@_);
487 elsif (defined wantarray) {
488 $res[0] = $self->next::method(@_);
491 $self->next::method(@_);
497 return wantarray ? @res : $res[0];
502 my ($source, $cols, $data) = @_;
504 my $columns_info = $source->columns_info;
507 first { $columns_info->{$_}{is_auto_increment} }
510 my $is_identity_insert = (first { $_ eq $identity_col } @{$cols}) ? 1 : 0;
513 $self->_bulk_storage &&
514 $self->_get_dbh->{syb_has_blk};
516 if (! $use_bulk_api and ref($self->_dbi_connect_info->[0]) eq 'CODE') {
517 carp_unique( join ' ',
518 'Bulk API support disabled due to use of a CODEREF connect_info.',
519 'Reverting to regular array inserts.',
523 if (not $use_bulk_api) {
524 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
526 # _execute_array uses a txn anyway, but it ends too early in case we need to
527 # select max(col) to get the identity for inserting blobs.
528 ($self, my $guard) = $self->{transaction_depth} == 0 ?
529 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
533 local $self->{insert_bulk} = 1;
535 $self->next::method(@_);
538 if ($is_identity_insert) {
539 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
542 my @cols_with_identities = (@$cols, $identity_col);
544 ## calculate identities
545 # XXX This assumes identities always increase by 1, which may or may not
547 my ($last_identity) =
548 $self->_dbh->selectrow_array (
549 $self->_fetch_identity_sql($source, $identity_col)
551 my @identities = (($last_identity - @$data + 1) .. $last_identity);
553 my @data_with_identities = map [@$_, shift @identities], @$data;
555 $self->_insert_blobs_array (
556 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
561 $guard->commit if $guard;
566 # otherwise, use the bulk API
568 # rearrange @$data so that columns are in database order
569 # and so we submit a full column list
570 my %orig_order = map { $cols->[$_] => $_ } 0..$#$cols;
572 my @source_columns = $source->columns;
574 # bcp identity index is 1-based
575 my $identity_idx = first { $source_columns[$_] eq $identity_col } (0..$#source_columns);
576 $identity_idx = defined $identity_idx ? $identity_idx + 1 : 0;
579 for my $slice_idx (0..$#$data) {
580 push @new_data, [map {
581 # identity data will be 'undef' if not $is_identity_insert
582 # columns with defaults will also be 'undef'
583 exists $orig_order{$_}
584 ? $data->[$slice_idx][$orig_order{$_}]
589 my $proto_bind = $self->_resolve_bindattrs(
592 [ { dbic_colname => $source_columns[$_], _bind_data_slice_idx => $_ }
593 => $new_data[0][$_] ]
594 } (0 ..$#source_columns) ],
598 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
599 # This ignores any data conversion errors detected by the client side libs, as
600 # they are usually harmless.
601 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
602 Sub::Name::subname insert_bulk => sub {
603 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
605 return 1 if $errno == 36;
608 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
609 ($errmsg ? "\n$errmsg" : '') .
610 ($osmsg ? "\n$osmsg" : '') .
611 ($blkmsg ? "\n$blkmsg" : '');
618 my $bulk = $self->_bulk_storage;
620 my $guard = $bulk->txn_scope_guard;
622 ## FIXME - once this is done - address the FIXME on finish() below
623 ## XXX get this to work instead of our own $sth
624 ## will require SQLA or *Hacks changes for ordered columns
625 # $bulk->next::method($source, \@source_columns, \@new_data, {
626 # syb_bcp_attribs => {
627 # identity_flag => $is_identity_insert,
628 # identity_column => $identity_idx,
631 my $sql = 'INSERT INTO ' .
632 $bulk->sql_maker->_quote($source->name) . ' (' .
633 # colname list is ignored for BCP, but does no harm
634 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
635 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
637 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
638 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
639 ## better yet the version above. Should be fixed in DBD::Sybase .
640 my $sth = $bulk->_get_dbh->prepare($sql,
644 identity_flag => $is_identity_insert,
645 identity_column => $identity_idx,
651 # FIXME the $sth->finish in _execute_array does a rollback for some
652 # reason. Disable it temporarily until we fix the SQLMaker thing above
653 no warnings 'redefine';
655 local *{ref($sth).'::finish'} = sub {};
657 $self->_execute_array(
658 $source, $sth, $proto_bind, \@source_columns, \@new_data
664 $bulk->_query_end($sql);
669 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
671 if ($exception =~ /-Y option/) {
672 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
673 . 'reverting to regular array inserts. Try unsetting the LANG environment variable'
675 $w .= "\n$exception" if $self->debug;
678 $self->_bulk_storage(undef);
683 # rollback makes the bulkLogin connection unusable
684 $self->_bulk_storage->disconnect;
685 $self->throw_exception($exception);
689 # Make sure blobs are not bound as placeholders, and return any non-empty ones
691 sub _remove_blob_cols {
692 my ($self, $source, $fields) = @_;
696 for my $col (keys %$fields) {
697 if ($self->_is_lob_column($source, $col)) {
698 my $blob_val = delete $fields->{$col};
699 if (not defined $blob_val) {
700 $fields->{$col} = \'NULL';
703 $fields->{$col} = \"''";
704 $blob_cols{$col} = $blob_val unless $blob_val eq '';
709 return %blob_cols ? \%blob_cols : undef;
712 # same for insert_bulk
713 sub _remove_blob_cols_array {
714 my ($self, $source, $cols, $data) = @_;
718 for my $i (0..$#$cols) {
719 my $col = $cols->[$i];
721 if ($self->_is_lob_column($source, $col)) {
722 for my $j (0..$#$data) {
723 my $blob_val = delete $data->[$j][$i];
724 if (not defined $blob_val) {
725 $data->[$j][$i] = \'NULL';
728 $data->[$j][$i] = \"''";
729 $blob_cols[$j][$i] = $blob_val
730 unless $blob_val eq '';
736 return @blob_cols ? \@blob_cols : undef;
740 my ($self, $source, $blob_cols, $where) = @_;
742 my @primary_cols = try
743 { $source->_pri_cols }
745 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
752 @primary_cols == grep { defined $where->{$_} } @primary_cols
755 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
756 @pks_to_update = \%row_to_update;
759 my $cursor = $self->select ($source, \@primary_cols, $where, {});
760 @pks_to_update = map {
761 my %row; @row{@primary_cols} = @$_; \%row
765 for my $ident (@pks_to_update) {
766 $self->_insert_blobs($source, $blob_cols, $ident);
771 my ($self, $source, $blob_cols, $row) = @_;
772 my $dbh = $self->_get_dbh;
774 my $table = $source->name;
777 my @primary_cols = try
778 { $source->_pri_cols }
780 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
783 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
784 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
786 for my $col (keys %$blob_cols) {
787 my $blob = $blob_cols->{$col};
789 my %where = map { ($_, $row{$_}) } @primary_cols;
791 my $cursor = $self->select ($source, [$col], \%where, {});
793 my $sth = $cursor->sth;
796 $self->throw_exception(
797 "Could not find row in table '$table' for blob update:\n"
804 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
807 $sth->func('ct_prepare_send') or die $sth->errstr;
809 my $log_on_update = $self->_blob_log_on_update;
810 $log_on_update = 1 if not defined $log_on_update;
812 $sth->func('CS_SET', 1, {
813 total_txtlen => length($blob),
814 log_on_update => $log_on_update
815 }, 'ct_data_info') or die $sth->errstr;
817 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
819 $sth->func('ct_finish_send') or die $sth->errstr;
822 if ($self->using_freetds) {
823 $self->throw_exception (
824 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
828 $self->throw_exception($_);
832 $sth->finish if $sth;
837 sub _insert_blobs_array {
838 my ($self, $source, $blob_cols, $cols, $data) = @_;
840 for my $i (0..$#$data) {
841 my $datum = $data->[$i];
844 @row{ @$cols } = @$datum;
847 for my $j (0..$#$cols) {
848 if (exists $blob_cols->[$i][$j]) {
849 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
853 $self->_insert_blobs ($source, \%blob_vals, \%row);
857 =head2 connect_call_datetime_setup
861 on_connect_call => 'datetime_setup'
863 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
865 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
866 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
868 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
869 C<SMALLDATETIME> columns only have minute precision.
873 sub connect_call_datetime_setup {
875 my $dbh = $self->_get_dbh;
877 if ($dbh->can('syb_date_fmt')) {
878 # amazingly, this works with FreeTDS
879 $dbh->syb_date_fmt('ISO_strict');
883 'Your DBD::Sybase is too old to support '
884 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
886 # FIXME - in retrospect this is a rather bad US-centric choice
887 # of format. Not changing as a bugwards compat, though in reality
888 # the only piece that sees the results of $dt object formatting
889 # (as opposed to parsing) is the database itself, so theoretically
890 # changing both this SET command and the formatter definition of
891 # ::S::D::Sybase::ASE::DateTime::Format below should be safe and
894 $dbh->do('SET DATEFORMAT mdy');
899 sub _exec_txn_begin {
902 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
903 # TRAN once. However, we need to make sure there's a $dbh.
904 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
906 $self->next::method(@_);
908 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
911 # savepoint support using ASE syntax
913 sub _exec_svp_begin {
914 my ($self, $name) = @_;
916 $self->_dbh->do("SAVE TRANSACTION $name");
919 # A new SAVE TRANSACTION with the same name releases the previous one.
920 sub _exec_svp_release { 1 }
922 sub _exec_svp_rollback {
923 my ($self, $name) = @_;
925 $self->_dbh->do("ROLLBACK TRANSACTION $name");
928 package # hide from PAUSE
929 DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format;
931 my $datetime_parse_format = '%Y-%m-%dT%H:%M:%S.%3NZ';
932 my $datetime_format_format = '%m/%d/%Y %H:%M:%S.%3N';
934 my ($datetime_parser, $datetime_formatter);
938 require DateTime::Format::Strptime;
939 $datetime_parser ||= DateTime::Format::Strptime->new(
940 pattern => $datetime_parse_format,
943 return $datetime_parser->parse_datetime(shift);
946 sub format_datetime {
948 require DateTime::Format::Strptime;
949 $datetime_formatter ||= DateTime::Format::Strptime->new(
950 pattern => $datetime_format_format,
953 return $datetime_formatter->format_datetime(shift);
958 =head1 Schema::Loader Support
960 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
961 most versions of Sybase ASE.
965 This driver supports L<DBD::Sybase> compiled against FreeTDS
966 (L<http://www.freetds.org/>) to the best of our ability, however it is
967 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
968 libraries. They are a part of the Sybase ASE distribution:
970 The Open Client FAQ is here:
971 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
973 Sybase ASE for Linux (which comes with the Open Client libraries) may be
974 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
976 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
978 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
980 It is recommended to set C<tds version> for your ASE server to C<5.0> in
981 C</etc/freetds/freetds.conf>.
983 Some versions or configurations of the libraries involved will not support
984 placeholders, in which case the storage will be reblessed to
985 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
987 In some configurations, placeholders will work but will throw implicit type
988 conversion errors for anything that's not expecting a string. In such a case,
989 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
990 automatically set, which you may enable on connection with
991 L<connect_call_set_auto_cast|DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>.
992 The type info for the C<CAST>s is taken from the
993 L<DBIx::Class::ResultSource/data_type> definitions in your Result classes, and
994 are mapped to a Sybase type (if it isn't already) using a mapping based on
997 In other configurations, placeholders will work just as they do with the Sybase
998 Open Client libraries.
1000 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
1002 =head1 INSERTS WITH PLACEHOLDERS
1004 With placeholders enabled, inserts are done in a transaction so that there are
1005 no concurrency issues with getting the inserted identity value using
1006 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
1009 In addition, they are done on a separate connection so that it's possible to
1010 have active cursors when doing an insert.
1012 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
1013 are unnecessary and not used, as there are no concurrency issues with C<SELECT
1014 @@IDENTITY> which is a session variable.
1018 Due to limitations of the TDS protocol and L<DBD::Sybase>, you cannot begin a
1019 transaction while there are active cursors, nor can you use multiple active
1020 cursors within a transaction. An active cursor is, for example, a
1021 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1022 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1024 For example, this will not work:
1026 $schema->txn_do(sub {
1027 my $rs = $schema->resultset('Book');
1028 while (my $row = $rs->next) {
1029 $schema->resultset('MetaData')->create({
1030 book_id => $row->id,
1038 my $first_row = $large_rs->first;
1039 $schema->txn_do(sub { ... });
1041 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1042 are not affected, as they are done on an extra database handle.
1048 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1050 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1052 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1056 =head1 MAXIMUM CONNECTIONS
1058 The TDS protocol makes separate connections to the server for active statements
1059 in the background. By default the number of such connections is limited to 25,
1060 on both the client side and the server side.
1062 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1063 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1064 can override it to whatever setting you like in the DSN.
1067 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1068 for information on changing the setting on the server side.
1072 See L</connect_call_datetime_setup> to setup date formats
1073 for L<DBIx::Class::InflateColumn::DateTime>.
1075 =head1 TEXT/IMAGE COLUMNS
1077 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1078 C<TEXT/IMAGE> columns.
1080 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1082 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1086 $schema->storage->set_textsize($bytes);
1090 However, the C<LongReadLen> you pass in
1091 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1092 equivalent C<SET TEXTSIZE> command on connection.
1094 See L</connect_call_blob_setup> for a
1095 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1096 with C<IMAGE> columns.
1100 The experimental L<DBD::Sybase> Bulk API support is used for
1101 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1102 on a separate connection.
1104 To use this feature effectively, use a large number of rows for each
1105 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1107 while (my $rows = $data_source->get_100_rows()) {
1108 $rs->populate($rows);
1111 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1112 calls in your C<Result> classes B<must> list columns in database order for this
1113 to work. Also, you may have to unset the C<LANG> environment variable before
1114 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1116 When inserting IMAGE columns using this method, you'll need to use
1117 L</connect_call_blob_setup> as well.
1119 =head1 COMPUTED COLUMNS
1121 If you have columns such as:
1123 created_dtm AS getdate()
1125 represent them in your Result classes as:
1129 default_value => \'getdate()',
1131 inflate_datetime => 1,
1134 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1135 on tables with such columns.
1137 =head1 TIMESTAMP COLUMNS
1139 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1140 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1142 They should be defined in your Result classes as:
1145 data_type => 'timestamp',
1147 inflate_datetime => 0,
1150 The C<<inflate_datetime => 0>> is necessary if you use
1151 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1152 be able to read these values.
1154 The values will come back as hexadecimal.
1162 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1163 any active cursors, using eager cursors.
1167 Real limits and limited counts using stored procedures deployed on startup.
1171 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1175 bulk_insert using prepare_cached (see comments.)
1181 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
1185 You may distribute this code under the same terms as Perl itself.