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';
17 use Context::Preserve 'preserve_context';
18 use DBIx::Class::_Util qw( sigwarn_silencer dbic_internal_try dump_value );
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__} = sigwarn_silencer(qr/active statement/i)
184 if $self->_is_bulk_storage;
186 # so that next transaction gets a dbh
187 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
192 # This is only invoked for FreeTDS drivers by ::Storage::DBI::Sybase::FreeTDS
193 sub _set_autocommit_stmt {
194 my ($self, $on) = @_;
196 return 'SET CHAINED ' . ($on ? 'OFF' : 'ON');
199 # Set up session settings for Sybase databases for the connection.
201 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
202 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
203 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
204 # only want when AutoCommit is off.
205 sub _run_connection_actions {
208 if ($self->_is_bulk_storage) {
209 # this should be cleared on every reconnect
210 $self->_began_bulk_work(0);
214 $self->_dbh->{syb_chained_txn} = 1
215 unless $self->_using_freetds;
217 $self->next::method(@_);
220 =head2 connect_call_blob_setup
224 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
226 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
227 instead of as a hex string.
231 Also sets the C<log_on_update> value for blob write operations. The default is
232 C<1>, but C<0> is better if your database is configured for it.
235 L<DBD::Sybase/Handling IMAGE/TEXT data with syb_ct_get_data()/syb_ct_send_data()>.
239 sub connect_call_blob_setup {
242 my $dbh = $self->_dbh;
243 $dbh->{syb_binary_images} = 1;
245 $self->_blob_log_on_update($args{log_on_update})
246 if exists $args{log_on_update};
250 my ($self, $source, $column) = @_;
252 return $self->_is_lob_type($source->column_info($column)->{data_type});
255 sub _prep_for_execute {
256 my ($self, $op, $ident, $args) = @_;
258 my $limit; # extract and use shortcut on limit without offset
259 if ($op eq 'select' and ! $args->[4] and $limit = $args->[3]) {
264 my ($sql, $bind) = $self->next::method($op, $ident, $args);
266 # $limit is already sanitized by now
268 "SET ROWCOUNT $limit",
273 if (my $identity_col = $self->_perform_autoinc_retrieval) {
274 $sql .= "\n" . $self->_fetch_identity_sql($ident, $identity_col)
277 return ($sql, $bind);
280 sub _fetch_identity_sql {
281 my ($self, $source, $col) = @_;
283 return sprintf ("SELECT MAX(%s) FROM %s",
284 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
288 # Stolen from SQLT, with some modifications. This is a makeshift
289 # solution before a sane type-mapping library is available, thus
290 # the 'our' for easy overrides.
291 our %TYPE_MAPPING = (
294 varchar => 'varchar',
295 varchar2 => 'varchar',
296 timestamp => 'datetime',
298 real => 'double precision',
301 tinyint => 'smallint',
302 float => 'double precision',
304 bigserial => 'numeric',
305 boolean => 'varchar',
309 sub _native_data_type {
310 my ($self, $type) = @_;
313 $type =~ s/\s* identity//x;
315 return uc($TYPE_MAPPING{$type} || $type);
321 my ($rv, $sth, @bind) = $self->next::method(@_);
323 $self->_identity( ($sth->fetchall_arrayref)->[0][0] )
324 if $self->_perform_autoinc_retrieval;
326 return wantarray ? ($rv, $sth, @bind) : $rv;
329 sub last_insert_id { shift->_identity }
331 # handles TEXT/IMAGE and transaction for last_insert_id
334 my ($source, $to_insert) = @_;
336 my $columns_info = $source->columns_info;
338 my ($identity_col) = grep
339 { $columns_info->{$_}{is_auto_increment} }
343 $identity_col = '' if ! defined $identity_col;
345 # FIXME - this is duplication from DBI.pm. When refactored towards
346 # the LobWriter this can be folded back where it belongs.
347 local $self->{_autoinc_supplied_for_op} = exists $to_insert->{$identity_col}
352 local $self->{_perform_autoinc_retrieval} = $self->{_autoinc_supplied_for_op}
357 # check for empty insert
358 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
359 # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
360 # and computed columns)
361 if (not %$to_insert) {
362 for my $col ($source->columns) {
363 next if $col eq $identity_col;
365 my $info = $source->column_info($col);
367 next if ref $info->{default_value} eq 'SCALAR'
368 || (exists $info->{data_type} && (not defined $info->{data_type}));
370 next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
372 $to_insert->{$col} = \'DEFAULT';
376 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
378 # if a new txn is needed - it must happen on the _writer/new connection (for now)
381 ! $self->transaction_depth
386 # do we need the horrific SELECT MAX(COL) hack?
388 $self->_perform_autoinc_retrieval
390 ( ($self->_identity_method||'') ne '@@IDENTITY' )
394 $self = $self->_writer_storage;
395 $guard = $self->txn_scope_guard;
398 my $updated_cols = $self->next::method ($source, $to_insert);
400 $self->_insert_blobs (
405 ? ( $identity_col => $self->last_insert_id($source, $identity_col) )
413 $guard->commit if $guard;
415 return $updated_cols;
420 my ($source, $fields, $where, @rest) = @_;
423 # When *updating* identities, ASE requires SET IDENTITY_UPDATE called
425 if (my $blob_cols = $self->_remove_blob_cols($source, $fields)) {
427 # If there are any blobs in $where, Sybase will return a descriptive error
429 # XXX blobs can still be used with a LIKE query, and this should be handled.
431 # update+blob update(s) done atomically on separate connection
432 $self = $self->_writer_storage;
434 my $guard = $self->txn_scope_guard;
436 # First update the blob columns to be updated to '' (taken from $fields, where
437 # it is originally put by _remove_blob_cols .)
438 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
440 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
441 $self->next::method($source, \%blobs_to_empty, $where, @rest);
443 # Now update the blobs before the other columns in case the update of other
444 # columns makes the search condition invalid.
445 my $rv = $self->_update_blobs($source, $blob_cols, $where);
449 # Now set the identity update flags for the actual update
450 local $self->{_autoinc_supplied_for_op} = (first
451 { $_->{is_auto_increment} }
452 values %{ $source->columns_info([ keys %$fields ]) }
455 my $next = $self->next::can;
457 return preserve_context {
458 $self->$next(@$args);
459 } after => sub { $guard->commit };
467 # Set the identity update flags for the actual update
468 local $self->{_autoinc_supplied_for_op} = (first
469 { $_->{is_auto_increment} }
470 values %{ $source->columns_info([ keys %$fields ]) }
473 return $self->next::method(@_);
479 my ($source, $cols, $data) = @_;
481 my $columns_info = $source->columns_info;
484 first { $columns_info->{$_}{is_auto_increment} }
487 # FIXME - this is duplication from DBI.pm. When refactored towards
488 # the LobWriter this can be folded back where it belongs.
489 local $self->{_autoinc_supplied_for_op} =
490 (first { $_ eq $identity_col } @$cols)
496 $self->_bulk_storage &&
497 $self->_get_dbh->{syb_has_blk};
499 if (! $use_bulk_api and ref($self->_dbi_connect_info->[0]) eq 'CODE') {
500 carp_unique( join ' ',
501 'Bulk API support disabled due to use of a CODEREF connect_info.',
502 'Reverting to regular array inserts.',
506 if (not $use_bulk_api) {
507 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
509 # next::method uses a txn anyway, but it ends too early in case we need to
510 # select max(col) to get the identity for inserting blobs.
511 ($self, my $guard) = $self->transaction_depth
513 : ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
516 $self->next::method(@_);
519 if ($self->_autoinc_supplied_for_op) {
520 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
523 my @cols_with_identities = (@$cols, $identity_col);
525 ## calculate identities
526 # XXX This assumes identities always increase by 1, which may or may not
528 my ($last_identity) =
529 $self->_dbh->selectrow_array (
530 $self->_fetch_identity_sql($source, $identity_col)
532 my @identities = (($last_identity - @$data + 1) .. $last_identity);
534 my @data_with_identities = map [@$_, shift @identities], @$data;
536 $self->_insert_blobs_array (
537 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
542 $guard->commit if $guard;
547 # otherwise, use the bulk API
549 # rearrange @$data so that columns are in database order
550 # and so we submit a full column list
551 my %orig_order = map { $cols->[$_] => $_ } 0..$#$cols;
553 my @source_columns = $source->columns;
555 # bcp identity index is 1-based
556 my $identity_idx = first { $source_columns[$_] eq $identity_col } (0..$#source_columns);
557 $identity_idx = defined $identity_idx ? $identity_idx + 1 : 0;
560 for my $slice_idx (0..$#$data) {
561 push @new_data, [map {
562 # identity data will be 'undef' if not _autoinc_supplied_for_op()
563 # columns with defaults will also be 'undef'
564 exists $orig_order{$_}
565 ? $data->[$slice_idx][$orig_order{$_}]
570 my $proto_bind = $self->_resolve_bindattrs(
573 [ { dbic_colname => $source_columns[$_], _bind_data_slice_idx => $_ }
574 => $new_data[0][$_] ]
575 } (0 ..$#source_columns) ],
579 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
580 # This ignores any data conversion errors detected by the client side libs, as
581 # they are usually harmless.
582 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
583 Sub::Name::subname _insert_bulk_cslib_errhandler => sub {
584 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
586 return 1 if $errno == 36;
589 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
590 ($errmsg ? "\n$errmsg" : '') .
591 ($osmsg ? "\n$osmsg" : '') .
592 ($blkmsg ? "\n$blkmsg" : '');
599 my $bulk = $self->_bulk_storage;
601 my $guard = $bulk->txn_scope_guard;
603 ## FIXME - once this is done - address the FIXME on finish() below
604 ## XXX get this to work instead of our own $sth
605 ## will require SQLA or *Hacks changes for ordered columns
606 # $bulk->next::method($source, \@source_columns, \@new_data, {
607 # syb_bcp_attribs => {
608 # identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
609 # identity_column => $identity_idx,
612 my $sql = 'INSERT INTO ' .
613 $bulk->sql_maker->_quote($source->name) . ' (' .
614 # colname list is ignored for BCP, but does no harm
615 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
616 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
618 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
619 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
620 ## better yet the version above. Should be fixed in DBD::Sybase .
621 my $sth = $bulk->_get_dbh->prepare($sql,
625 identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
626 identity_column => $identity_idx,
632 # FIXME the $sth->finish in _execute_array does a rollback for some
633 # reason. Disable it temporarily until we fix the SQLMaker thing above
634 no warnings 'redefine';
636 local *{ref($sth).'::finish'} = sub {};
638 $self->_dbh_execute_for_fetch(
639 $source, $sth, $proto_bind, \@source_columns, \@new_data
645 $bulk->_query_end($sql);
650 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
652 if ($exception =~ /-Y option/) {
653 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
654 . 'reverting to regular array inserts. Try unsetting the LC_ALL environment variable'
656 $w .= "\n$exception" if $self->debug;
659 $self->_bulk_storage(undef);
664 # rollback makes the bulkLogin connection unusable
665 $self->_bulk_storage->disconnect;
666 $self->throw_exception($exception);
670 # Make sure blobs are not bound as placeholders, and return any non-empty ones
672 sub _remove_blob_cols {
673 my ($self, $source, $fields) = @_;
677 for my $col (keys %$fields) {
678 if ($self->_is_lob_column($source, $col)) {
679 my $blob_val = delete $fields->{$col};
680 if (not defined $blob_val) {
681 $fields->{$col} = \'NULL';
684 $fields->{$col} = \"''";
685 $blob_cols{$col} = $blob_val
691 return %blob_cols ? \%blob_cols : undef;
694 # same for _insert_bulk
695 sub _remove_blob_cols_array {
696 my ($self, $source, $cols, $data) = @_;
700 for my $i (0..$#$cols) {
701 my $col = $cols->[$i];
703 if ($self->_is_lob_column($source, $col)) {
704 for my $j (0..$#$data) {
705 my $blob_val = delete $data->[$j][$i];
706 if (not defined $blob_val) {
707 $data->[$j][$i] = \'NULL';
710 $data->[$j][$i] = \"''";
711 $blob_cols[$j][$i] = $blob_val
718 return @blob_cols ? \@blob_cols : undef;
722 my ($self, $source, $blob_cols, $where) = @_;
724 my @primary_cols = dbic_internal_try
725 { $source->_pri_cols_or_die }
727 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
734 ! grep { ! defined $where->{$_} } @primary_cols
737 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
738 @pks_to_update = \%row_to_update;
741 my $cursor = $self->select ($source, \@primary_cols, $where, {});
742 @pks_to_update = map {
743 my %row; @row{@primary_cols} = @$_; \%row
747 for my $ident (@pks_to_update) {
748 $self->_insert_blobs($source, $blob_cols, $ident);
753 my ($self, $source, $blob_cols, $row_data) = @_;
755 my $table = $source->name;
757 my @primary_cols = dbic_internal_try
758 { $source->_pri_cols_or_die }
760 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
763 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
764 if grep { ! defined $row_data->{$_} } @primary_cols;
766 # if we are 2-phase inserting a blob - there is nothing to retrieve anymore,
767 # regardless of the previous state of the flag
768 local $self->{_perform_autoinc_retrieval}
769 if $self->_perform_autoinc_retrieval;
771 my %where = map {( $_ => $row_data->{$_} )} @primary_cols;
773 for my $col (keys %$blob_cols) {
774 my $blob = $blob_cols->{$col};
776 my $cursor = $self->select ($source, [$col], \%where, {});
778 my $sth = $cursor->sth;
781 $self->throw_exception(
782 "Could not find row in table '$table' for blob update:\n"
789 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
792 $sth->func('ct_prepare_send') or die $sth->errstr;
794 my $log_on_update = $self->_blob_log_on_update;
795 $log_on_update = 1 if not defined $log_on_update;
797 $sth->func('CS_SET', 1, {
798 total_txtlen => length($blob),
799 log_on_update => $log_on_update
800 }, 'ct_data_info') or die $sth->errstr;
802 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
804 $sth->func('ct_finish_send') or die $sth->errstr;
807 if ($self->_using_freetds) {
808 $self->throw_exception (
809 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
813 $self->throw_exception($_);
817 $sth->finish if $sth;
822 sub _insert_blobs_array {
823 my ($self, $source, $blob_cols, $cols, $data) = @_;
825 for my $i (0..$#$data) {
826 my $datum = $data->[$i];
829 @row{ @$cols } = @$datum;
832 for my $j (0..$#$cols) {
833 if (exists $blob_cols->[$i][$j]) {
834 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
838 $self->_insert_blobs ($source, \%blob_vals, \%row);
842 =head2 connect_call_datetime_setup
846 on_connect_call => 'datetime_setup'
848 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
850 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
851 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
853 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
854 C<SMALLDATETIME> columns only have minute precision.
858 sub connect_call_datetime_setup {
860 my $dbh = $self->_get_dbh;
862 if ($dbh->can('syb_date_fmt')) {
863 # amazingly, this works with FreeTDS
864 $dbh->syb_date_fmt('ISO_strict');
868 'Your DBD::Sybase is too old to support '
869 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
871 # FIXME - in retrospect this is a rather bad US-centric choice
872 # of format. Not changing as a bugwards compat, though in reality
873 # the only piece that sees the results of $dt object formatting
874 # (as opposed to parsing) is the database itself, so theoretically
875 # changing both this SET command and the formatter definition of
876 # ::S::D::Sybase::ASE::DateTime::Format below should be safe and
879 $dbh->do('SET DATEFORMAT mdy');
884 sub _exec_txn_begin {
887 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
888 # TRAN once. However, we need to make sure there's a $dbh.
889 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
891 $self->next::method(@_);
893 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
896 # savepoint support using ASE syntax
898 sub _exec_svp_begin {
899 my ($self, $name) = @_;
901 $self->_dbh->do("SAVE TRANSACTION $name");
904 # A new SAVE TRANSACTION with the same name releases the previous one.
905 sub _exec_svp_release { 1 }
907 sub _exec_svp_rollback {
908 my ($self, $name) = @_;
910 $self->_dbh->do("ROLLBACK TRANSACTION $name");
913 package # hide from PAUSE
914 DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format;
916 my $datetime_parse_format = '%Y-%m-%dT%H:%M:%S.%3NZ';
917 my $datetime_format_format = '%m/%d/%Y %H:%M:%S.%3N';
919 my ($datetime_parser, $datetime_formatter);
923 require DateTime::Format::Strptime;
924 $datetime_parser ||= DateTime::Format::Strptime->new(
925 pattern => $datetime_parse_format,
928 return $datetime_parser->parse_datetime(shift);
931 sub format_datetime {
933 require DateTime::Format::Strptime;
934 $datetime_formatter ||= DateTime::Format::Strptime->new(
935 pattern => $datetime_format_format,
938 return $datetime_formatter->format_datetime(shift);
943 =head1 Schema::Loader Support
945 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
946 most versions of Sybase ASE.
950 This driver supports L<DBD::Sybase> compiled against FreeTDS
951 (L<http://www.freetds.org/>) to the best of our ability, however it is
952 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
953 libraries. They are a part of the Sybase ASE distribution:
955 The Open Client FAQ is here:
956 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
958 Sybase ASE for Linux (which comes with the Open Client libraries) may be
959 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
961 To see if you're using FreeTDS run:
963 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
965 It is recommended to set C<tds version> for your ASE server to C<5.0> in
966 C</etc/freetds/freetds.conf>.
968 Some versions or configurations of the libraries involved will not support
969 placeholders, in which case the storage will be reblessed to
970 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
972 In some configurations, placeholders will work but will throw implicit type
973 conversion errors for anything that's not expecting a string. In such a case,
974 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
975 automatically set, which you may enable on connection with
976 L<connect_call_set_auto_cast|DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>.
977 The type info for the C<CAST>s is taken from the
978 L<DBIx::Class::ResultSource/data_type> definitions in your Result classes, and
979 are mapped to a Sybase type (if it isn't already) using a mapping based on
982 In other configurations, placeholders will work just as they do with the Sybase
983 Open Client libraries.
985 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
987 =head1 INSERTS WITH PLACEHOLDERS
989 With placeholders enabled, inserts are done in a transaction so that there are
990 no concurrency issues with getting the inserted identity value using
991 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
994 In addition, they are done on a separate connection so that it's possible to
995 have active cursors when doing an insert.
997 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
998 are unnecessary and not used, as there are no concurrency issues with C<SELECT
999 @@IDENTITY> which is a session variable.
1003 Due to limitations of the TDS protocol and L<DBD::Sybase>, you cannot begin a
1004 transaction while there are active cursors, nor can you use multiple active
1005 cursors within a transaction. An active cursor is, for example, a
1006 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1007 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1009 For example, this will not work:
1011 $schema->txn_do(sub {
1012 my $rs = $schema->resultset('Book');
1013 while (my $result = $rs->next) {
1014 $schema->resultset('MetaData')->create({
1015 book_id => $result->id,
1023 my $first_row = $large_rs->first;
1024 $schema->txn_do(sub { ... });
1026 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1027 are not affected, as they are done on an extra database handle.
1033 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1035 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1037 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1041 =head1 MAXIMUM CONNECTIONS
1043 The TDS protocol makes separate connections to the server for active statements
1044 in the background. By default the number of such connections is limited to 25,
1045 on both the client side and the server side.
1047 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1048 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1049 can override it to whatever setting you like in the DSN.
1052 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1053 for information on changing the setting on the server side.
1057 See L</connect_call_datetime_setup> to setup date formats
1058 for L<DBIx::Class::InflateColumn::DateTime>.
1060 =head1 LIMITED QUERIES
1062 Because ASE does not have a good way to limit results in SQL that works for
1063 all types of queries, the limit dialect is set to
1064 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ>.
1066 Fortunately, ASE and L<DBD::Sybase> support cursors properly, so when
1067 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> is too slow
1068 you can use the L<software_limit|DBIx::Class::ResultSet/software_limit>
1069 L<DBIx::Class::ResultSet> attribute to simulate limited queries by skipping
1072 =head1 TEXT/IMAGE COLUMNS
1074 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1075 C<TEXT/IMAGE> columns.
1077 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1079 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1083 $schema->storage->set_textsize($bytes);
1087 However, the C<LongReadLen> you pass in
1088 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1089 equivalent C<SET TEXTSIZE> command on connection.
1091 See L</connect_call_blob_setup> for a
1092 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1093 with C<IMAGE> columns.
1097 The experimental L<DBD::Sybase> Bulk API support is used for
1098 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1099 on a separate connection.
1101 To use this feature effectively, use a large number of rows for each
1102 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1104 while (my $rows = $data_source->get_100_rows()) {
1105 $rs->populate($rows);
1108 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1109 calls in your C<Result> classes B<must> list columns in database order for this
1110 to work. Also, you may have to unset the C<LC_ALL> environment variable before
1111 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1113 When inserting IMAGE columns using this method, you'll need to use
1114 L</connect_call_blob_setup> as well.
1116 =head1 COMPUTED COLUMNS
1118 If you have columns such as:
1120 created_dtm AS getdate()
1122 represent them in your Result classes as:
1126 default_value => \'getdate()',
1128 inflate_datetime => 1,
1131 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1132 on tables with such columns.
1134 =head1 TIMESTAMP COLUMNS
1136 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1137 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1139 They should be defined in your Result classes as:
1142 data_type => 'timestamp',
1144 inflate_datetime => 0,
1147 The C<<inflate_datetime => 0>> is necessary if you use
1148 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1149 be able to read these values.
1151 The values will come back as hexadecimal.
1159 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1160 any active cursors, using eager cursors.
1164 Real limits and limited counts using stored procedures deployed on startup.
1168 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1172 bulk_insert using prepare_cached (see comments.)
1176 =head1 FURTHER QUESTIONS?
1178 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
1180 =head1 COPYRIGHT AND LICENSE
1182 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
1183 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
1184 redistribute it and/or modify it under the same terms as the
1185 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.