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';
19 use DBIx::Class::_Util 'sigwarn_silencer';
22 __PACKAGE__->sql_limit_dialect ('GenericSubQ');
23 __PACKAGE__->sql_quote_char ([qw/[ ]/]);
24 __PACKAGE__->datetime_parser_type(
25 'DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format'
28 __PACKAGE__->mk_group_accessors('simple' =>
29 qw/_identity _identity_method _blob_log_on_update _parent_storage
30 _writer_storage _is_writer_storage
31 _bulk_storage _is_bulk_storage _began_bulk_work
36 my @also_proxy_to_extra_storages = qw/
37 connect_call_set_auto_cast auto_cast connect_call_blob_setup
38 connect_call_datetime_setup
40 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
41 auto_savepoint unsafe cursor_class debug debugobj schema
46 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
51 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
55 If your version of Sybase does not support placeholders, then your storage will
56 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
57 You can also enable that driver explicitly, see the documentation for more
60 With this driver there is unfortunately no way to get the C<last_insert_id>
61 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
62 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
64 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
66 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
75 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
77 if ($self->_using_freetds) {
78 carp_once <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
80 You are using FreeTDS with Sybase.
82 We will do our best to support this configuration, but please consider this
85 TEXT/IMAGE columns will definitely not work.
87 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
90 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
92 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
96 if (not $self->_use_typeless_placeholders) {
97 if ($self->_use_placeholders) {
101 $self->ensure_class_loaded($no_bind_vars);
102 bless $self, $no_bind_vars;
108 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
109 # not necessarily FreeTDS, but no placeholders nevertheless
110 $self->ensure_class_loaded($no_bind_vars);
111 bless $self, $no_bind_vars;
114 # this is highly unlikely, but we check just in case
115 elsif (not $self->_use_typeless_placeholders) {
123 $self->next::method(@_);
125 if ($self->_using_freetds && (my $ver = $self->_using_freetds_version||999) > 0.82) {
127 "Buggy FreeTDS version $ver detected, statement caching will not work and "
128 . 'will be disabled.'
130 $self->disable_sth_caching(1);
133 $self->_set_max_connect(256);
135 # create storage for insert/(update blob) transactions,
136 # unless this is that storage
137 return if $self->_parent_storage;
139 my $writer_storage = (ref $self)->new;
141 $writer_storage->_is_writer_storage(1); # just info
142 $writer_storage->connect_info($self->connect_info);
143 $writer_storage->auto_cast($self->auto_cast);
145 weaken ($writer_storage->{_parent_storage} = $self);
146 $self->_writer_storage($writer_storage);
148 # create a bulk storage unless connect_info is a coderef
149 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
151 my $bulk_storage = (ref $self)->new;
153 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
154 $bulk_storage->connect_info($self->connect_info);
157 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
159 weaken ($bulk_storage->{_parent_storage} = $self);
160 $self->_bulk_storage($bulk_storage);
163 for my $method (@also_proxy_to_extra_storages) {
165 no warnings 'redefine';
167 my $replaced = __PACKAGE__->can($method);
169 *{$method} = Sub::Name::subname $method => sub {
171 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
172 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
173 return $self->$replaced(@_);
180 # Even though we call $sth->finish for uses off the bulk API, there's still an
181 # "active statement" warning on disconnect, which we throw away here.
182 # This is due to the bug described in _insert_bulk.
183 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
184 local $SIG{__WARN__} = sigwarn_silencer(qr/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) = @_;
259 my $limit; # extract and use shortcut on limit without offset
260 if ($op eq 'select' and ! $args->[4] and $limit = $args->[3]) {
265 my ($sql, $bind) = $self->next::method($op, $ident, $args);
267 # $limit is already sanitized by now
269 "SET ROWCOUNT $limit",
274 if (my $identity_col = $self->_perform_autoinc_retrieval) {
275 $sql .= "\n" . $self->_fetch_identity_sql($ident, $identity_col)
278 return ($sql, $bind);
281 sub _fetch_identity_sql {
282 my ($self, $source, $col) = @_;
284 return sprintf ("SELECT MAX(%s) FROM %s",
285 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
289 # Stolen from SQLT, with some modifications. This is a makeshift
290 # solution before a sane type-mapping library is available, thus
291 # the 'our' for easy overrides.
292 our %TYPE_MAPPING = (
295 varchar => 'varchar',
296 varchar2 => 'varchar',
297 timestamp => 'datetime',
299 real => 'double precision',
302 tinyint => 'smallint',
303 float => 'double precision',
305 bigserial => 'numeric',
306 boolean => 'varchar',
310 sub _native_data_type {
311 my ($self, $type) = @_;
314 $type =~ s/\s* identity//x;
316 return uc($TYPE_MAPPING{$type} || $type);
322 my ($rv, $sth, @bind) = $self->next::method(@_);
324 $self->_identity( ($sth->fetchall_arrayref)->[0][0] )
325 if $self->_perform_autoinc_retrieval;
327 return wantarray ? ($rv, $sth, @bind) : $rv;
330 sub last_insert_id { shift->_identity }
332 # handles TEXT/IMAGE and transaction for last_insert_id
335 my ($source, $to_insert) = @_;
337 my $columns_info = $source->columns_info;
339 my ($identity_col) = grep
340 { $columns_info->{$_}{is_auto_increment} }
344 $identity_col = '' if ! defined $identity_col;
346 # FIXME - this is duplication from DBI.pm. When refactored towards
347 # the LobWriter this can be folded back where it belongs.
348 local $self->{_autoinc_supplied_for_op} = exists $to_insert->{$identity_col}
353 local $self->{_perform_autoinc_retrieval} = $self->{_autoinc_supplied_for_op}
358 # check for empty insert
359 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
360 # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
361 # and computed columns)
362 if (not %$to_insert) {
363 for my $col ($source->columns) {
364 next if $col eq $identity_col;
366 my $info = $source->column_info($col);
368 next if ref $info->{default_value} eq 'SCALAR'
369 || (exists $info->{data_type} && (not defined $info->{data_type}));
371 next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
373 $to_insert->{$col} = \'DEFAULT';
377 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
379 # if a new txn is needed - it must happen on the _writer/new connection (for now)
382 ! $self->transaction_depth
387 # do we need the horrific SELECT MAX(COL) hack?
389 $self->_perform_autoinc_retrieval
391 ( ($self->_identity_method||'') ne '@@IDENTITY' )
395 $self = $self->_writer_storage;
396 $guard = $self->txn_scope_guard;
399 my $updated_cols = $self->next::method ($source, $to_insert);
401 $self->_insert_blobs (
406 ? ( $identity_col => $self->last_insert_id($source, $identity_col) )
414 $guard->commit if $guard;
416 return $updated_cols;
421 my ($source, $fields, $where, @rest) = @_;
424 # When *updating* identities, ASE requires SET IDENTITY_UPDATE called
426 if (my $blob_cols = $self->_remove_blob_cols($source, $fields)) {
428 # If there are any blobs in $where, Sybase will return a descriptive error
430 # XXX blobs can still be used with a LIKE query, and this should be handled.
432 # update+blob update(s) done atomically on separate connection
433 $self = $self->_writer_storage;
435 my $guard = $self->txn_scope_guard;
437 # First update the blob columns to be updated to '' (taken from $fields, where
438 # it is originally put by _remove_blob_cols .)
439 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
441 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
442 $self->next::method($source, \%blobs_to_empty, $where, @rest);
444 # Now update the blobs before the other columns in case the update of other
445 # columns makes the search condition invalid.
446 my $rv = $self->_update_blobs($source, $blob_cols, $where);
450 # Now set the identity update flags for the actual update
451 local $self->{_autoinc_supplied_for_op} = (first
452 { $_->{is_auto_increment} }
453 values %{ $source->columns_info([ keys %$fields ]) }
456 my $next = $self->next::can;
458 return preserve_context {
459 $self->$next(@$args);
460 } after => sub { $guard->commit };
468 # Set the identity update flags for the actual update
469 local $self->{_autoinc_supplied_for_op} = (first
470 { $_->{is_auto_increment} }
471 values %{ $source->columns_info([ keys %$fields ]) }
474 return $self->next::method(@_);
480 my ($source, $cols, $data) = @_;
482 my $columns_info = $source->columns_info;
485 first { $columns_info->{$_}{is_auto_increment} }
488 # FIXME - this is duplication from DBI.pm. When refactored towards
489 # the LobWriter this can be folded back where it belongs.
490 local $self->{_autoinc_supplied_for_op} =
491 (first { $_ eq $identity_col } @$cols)
497 $self->_bulk_storage &&
498 $self->_get_dbh->{syb_has_blk};
500 if (! $use_bulk_api and ref($self->_dbi_connect_info->[0]) eq 'CODE') {
501 carp_unique( join ' ',
502 'Bulk API support disabled due to use of a CODEREF connect_info.',
503 'Reverting to regular array inserts.',
507 if (not $use_bulk_api) {
508 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
510 # next::method uses a txn anyway, but it ends too early in case we need to
511 # select max(col) to get the identity for inserting blobs.
512 ($self, my $guard) = $self->transaction_depth
514 : ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
517 $self->next::method(@_);
520 if ($self->_autoinc_supplied_for_op) {
521 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
524 my @cols_with_identities = (@$cols, $identity_col);
526 ## calculate identities
527 # XXX This assumes identities always increase by 1, which may or may not
529 my ($last_identity) =
530 $self->_dbh->selectrow_array (
531 $self->_fetch_identity_sql($source, $identity_col)
533 my @identities = (($last_identity - @$data + 1) .. $last_identity);
535 my @data_with_identities = map [@$_, shift @identities], @$data;
537 $self->_insert_blobs_array (
538 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
543 $guard->commit if $guard;
548 # otherwise, use the bulk API
550 # rearrange @$data so that columns are in database order
551 # and so we submit a full column list
552 my %orig_order = map { $cols->[$_] => $_ } 0..$#$cols;
554 my @source_columns = $source->columns;
556 # bcp identity index is 1-based
557 my $identity_idx = first { $source_columns[$_] eq $identity_col } (0..$#source_columns);
558 $identity_idx = defined $identity_idx ? $identity_idx + 1 : 0;
561 for my $slice_idx (0..$#$data) {
562 push @new_data, [map {
563 # identity data will be 'undef' if not _autoinc_supplied_for_op()
564 # columns with defaults will also be 'undef'
565 exists $orig_order{$_}
566 ? $data->[$slice_idx][$orig_order{$_}]
571 my $proto_bind = $self->_resolve_bindattrs(
574 [ { dbic_colname => $source_columns[$_], _bind_data_slice_idx => $_ }
575 => $new_data[0][$_] ]
576 } (0 ..$#source_columns) ],
580 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
581 # This ignores any data conversion errors detected by the client side libs, as
582 # they are usually harmless.
583 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
584 Sub::Name::subname _insert_bulk_cslib_errhandler => sub {
585 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
587 return 1 if $errno == 36;
590 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
591 ($errmsg ? "\n$errmsg" : '') .
592 ($osmsg ? "\n$osmsg" : '') .
593 ($blkmsg ? "\n$blkmsg" : '');
600 my $bulk = $self->_bulk_storage;
602 my $guard = $bulk->txn_scope_guard;
604 ## FIXME - once this is done - address the FIXME on finish() below
605 ## XXX get this to work instead of our own $sth
606 ## will require SQLA or *Hacks changes for ordered columns
607 # $bulk->next::method($source, \@source_columns, \@new_data, {
608 # syb_bcp_attribs => {
609 # identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
610 # identity_column => $identity_idx,
613 my $sql = 'INSERT INTO ' .
614 $bulk->sql_maker->_quote($source->name) . ' (' .
615 # colname list is ignored for BCP, but does no harm
616 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
617 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
619 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
620 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
621 ## better yet the version above. Should be fixed in DBD::Sybase .
622 my $sth = $bulk->_get_dbh->prepare($sql,
626 identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
627 identity_column => $identity_idx,
633 # FIXME the $sth->finish in _execute_array does a rollback for some
634 # reason. Disable it temporarily until we fix the SQLMaker thing above
635 no warnings 'redefine';
637 local *{ref($sth).'::finish'} = sub {};
639 $self->_dbh_execute_for_fetch(
640 $source, $sth, $proto_bind, \@source_columns, \@new_data
646 $bulk->_query_end($sql);
651 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
653 if ($exception =~ /-Y option/) {
654 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
655 . 'reverting to regular array inserts. Try unsetting the LC_ALL environment variable'
657 $w .= "\n$exception" if $self->debug;
660 $self->_bulk_storage(undef);
665 # rollback makes the bulkLogin connection unusable
666 $self->_bulk_storage->disconnect;
667 $self->throw_exception($exception);
671 # Make sure blobs are not bound as placeholders, and return any non-empty ones
673 sub _remove_blob_cols {
674 my ($self, $source, $fields) = @_;
678 for my $col (keys %$fields) {
679 if ($self->_is_lob_column($source, $col)) {
680 my $blob_val = delete $fields->{$col};
681 if (not defined $blob_val) {
682 $fields->{$col} = \'NULL';
685 $fields->{$col} = \"''";
686 $blob_cols{$col} = $blob_val
692 return %blob_cols ? \%blob_cols : undef;
695 # same for _insert_bulk
696 sub _remove_blob_cols_array {
697 my ($self, $source, $cols, $data) = @_;
701 for my $i (0..$#$cols) {
702 my $col = $cols->[$i];
704 if ($self->_is_lob_column($source, $col)) {
705 for my $j (0..$#$data) {
706 my $blob_val = delete $data->[$j][$i];
707 if (not defined $blob_val) {
708 $data->[$j][$i] = \'NULL';
711 $data->[$j][$i] = \"''";
712 $blob_cols[$j][$i] = $blob_val
719 return @blob_cols ? \@blob_cols : undef;
723 my ($self, $source, $blob_cols, $where) = @_;
725 my @primary_cols = try
726 { $source->_pri_cols_or_die }
728 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
735 ! grep { ! defined $where->{$_} } @primary_cols
738 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
739 @pks_to_update = \%row_to_update;
742 my $cursor = $self->select ($source, \@primary_cols, $where, {});
743 @pks_to_update = map {
744 my %row; @row{@primary_cols} = @$_; \%row
748 for my $ident (@pks_to_update) {
749 $self->_insert_blobs($source, $blob_cols, $ident);
754 my ($self, $source, $blob_cols, $row_data) = @_;
756 my $table = $source->name;
758 my @primary_cols = try
759 { $source->_pri_cols_or_die }
761 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
764 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
765 if grep { ! defined $row_data->{$_} } @primary_cols;
767 # if we are 2-phase inserting a blob - there is nothing to retrieve anymore,
768 # regardless of the previous state of the flag
769 local $self->{_perform_autoinc_retrieval}
770 if $self->_perform_autoinc_retrieval;
772 my %where = map {( $_ => $row_data->{$_} )} @primary_cols;
774 for my $col (keys %$blob_cols) {
775 my $blob = $blob_cols->{$col};
777 my $cursor = $self->select ($source, [$col], \%where, {});
779 my $sth = $cursor->sth;
782 $self->throw_exception(
783 "Could not find row in table '$table' for blob update:\n"
790 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
793 $sth->func('ct_prepare_send') or die $sth->errstr;
795 my $log_on_update = $self->_blob_log_on_update;
796 $log_on_update = 1 if not defined $log_on_update;
798 $sth->func('CS_SET', 1, {
799 total_txtlen => length($blob),
800 log_on_update => $log_on_update
801 }, 'ct_data_info') or die $sth->errstr;
803 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
805 $sth->func('ct_finish_send') or die $sth->errstr;
808 if ($self->_using_freetds) {
809 $self->throw_exception (
810 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
814 $self->throw_exception($_);
818 $sth->finish if $sth;
823 sub _insert_blobs_array {
824 my ($self, $source, $blob_cols, $cols, $data) = @_;
826 for my $i (0..$#$data) {
827 my $datum = $data->[$i];
830 @row{ @$cols } = @$datum;
833 for my $j (0..$#$cols) {
834 if (exists $blob_cols->[$i][$j]) {
835 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
839 $self->_insert_blobs ($source, \%blob_vals, \%row);
843 =head2 connect_call_datetime_setup
847 on_connect_call => 'datetime_setup'
849 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
851 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
852 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
854 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
855 C<SMALLDATETIME> columns only have minute precision.
859 sub connect_call_datetime_setup {
861 my $dbh = $self->_get_dbh;
863 if ($dbh->can('syb_date_fmt')) {
864 # amazingly, this works with FreeTDS
865 $dbh->syb_date_fmt('ISO_strict');
869 'Your DBD::Sybase is too old to support '
870 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
872 # FIXME - in retrospect this is a rather bad US-centric choice
873 # of format. Not changing as a bugwards compat, though in reality
874 # the only piece that sees the results of $dt object formatting
875 # (as opposed to parsing) is the database itself, so theoretically
876 # changing both this SET command and the formatter definition of
877 # ::S::D::Sybase::ASE::DateTime::Format below should be safe and
880 $dbh->do('SET DATEFORMAT mdy');
885 sub _exec_txn_begin {
888 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
889 # TRAN once. However, we need to make sure there's a $dbh.
890 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
892 $self->next::method(@_);
894 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
897 # savepoint support using ASE syntax
899 sub _exec_svp_begin {
900 my ($self, $name) = @_;
902 $self->_dbh->do("SAVE TRANSACTION $name");
905 # A new SAVE TRANSACTION with the same name releases the previous one.
906 sub _exec_svp_release { 1 }
908 sub _exec_svp_rollback {
909 my ($self, $name) = @_;
911 $self->_dbh->do("ROLLBACK TRANSACTION $name");
914 package # hide from PAUSE
915 DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format;
917 my $datetime_parse_format = '%Y-%m-%dT%H:%M:%S.%3NZ';
918 my $datetime_format_format = '%m/%d/%Y %H:%M:%S.%3N';
920 my ($datetime_parser, $datetime_formatter);
924 require DateTime::Format::Strptime;
925 $datetime_parser ||= DateTime::Format::Strptime->new(
926 pattern => $datetime_parse_format,
929 return $datetime_parser->parse_datetime(shift);
932 sub format_datetime {
934 require DateTime::Format::Strptime;
935 $datetime_formatter ||= DateTime::Format::Strptime->new(
936 pattern => $datetime_format_format,
939 return $datetime_formatter->format_datetime(shift);
944 =head1 Schema::Loader Support
946 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
947 most versions of Sybase ASE.
951 This driver supports L<DBD::Sybase> compiled against FreeTDS
952 (L<http://www.freetds.org/>) to the best of our ability, however it is
953 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
954 libraries. They are a part of the Sybase ASE distribution:
956 The Open Client FAQ is here:
957 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
959 Sybase ASE for Linux (which comes with the Open Client libraries) may be
960 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
962 To see if you're using FreeTDS run:
964 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
966 It is recommended to set C<tds version> for your ASE server to C<5.0> in
967 C</etc/freetds/freetds.conf>.
969 Some versions or configurations of the libraries involved will not support
970 placeholders, in which case the storage will be reblessed to
971 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
973 In some configurations, placeholders will work but will throw implicit type
974 conversion errors for anything that's not expecting a string. In such a case,
975 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
976 automatically set, which you may enable on connection with
977 L<connect_call_set_auto_cast|DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>.
978 The type info for the C<CAST>s is taken from the
979 L<DBIx::Class::ResultSource/data_type> definitions in your Result classes, and
980 are mapped to a Sybase type (if it isn't already) using a mapping based on
983 In other configurations, placeholders will work just as they do with the Sybase
984 Open Client libraries.
986 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
988 =head1 INSERTS WITH PLACEHOLDERS
990 With placeholders enabled, inserts are done in a transaction so that there are
991 no concurrency issues with getting the inserted identity value using
992 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
995 In addition, they are done on a separate connection so that it's possible to
996 have active cursors when doing an insert.
998 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
999 are unnecessary and not used, as there are no concurrency issues with C<SELECT
1000 @@IDENTITY> which is a session variable.
1004 Due to limitations of the TDS protocol and L<DBD::Sybase>, you cannot begin a
1005 transaction while there are active cursors, nor can you use multiple active
1006 cursors within a transaction. An active cursor is, for example, a
1007 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1008 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1010 For example, this will not work:
1012 $schema->txn_do(sub {
1013 my $rs = $schema->resultset('Book');
1014 while (my $result = $rs->next) {
1015 $schema->resultset('MetaData')->create({
1016 book_id => $result->id,
1024 my $first_row = $large_rs->first;
1025 $schema->txn_do(sub { ... });
1027 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1028 are not affected, as they are done on an extra database handle.
1034 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1036 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1038 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1042 =head1 MAXIMUM CONNECTIONS
1044 The TDS protocol makes separate connections to the server for active statements
1045 in the background. By default the number of such connections is limited to 25,
1046 on both the client side and the server side.
1048 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1049 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1050 can override it to whatever setting you like in the DSN.
1053 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1054 for information on changing the setting on the server side.
1058 See L</connect_call_datetime_setup> to setup date formats
1059 for L<DBIx::Class::InflateColumn::DateTime>.
1061 =head1 LIMITED QUERIES
1063 Because ASE does not have a good way to limit results in SQL that works for
1064 all types of queries, the limit dialect is set to
1065 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ>.
1067 Fortunately, ASE and L<DBD::Sybase> support cursors properly, so when
1068 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> is too slow
1069 you can use the L<software_limit|DBIx::Class::ResultSet/software_limit>
1070 L<DBIx::Class::ResultSet> attribute to simulate limited queries by skipping
1073 =head1 TEXT/IMAGE COLUMNS
1075 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1076 C<TEXT/IMAGE> columns.
1078 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1080 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1084 $schema->storage->set_textsize($bytes);
1088 However, the C<LongReadLen> you pass in
1089 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1090 equivalent C<SET TEXTSIZE> command on connection.
1092 See L</connect_call_blob_setup> for a
1093 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1094 with C<IMAGE> columns.
1098 The experimental L<DBD::Sybase> Bulk API support is used for
1099 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1100 on a separate connection.
1102 To use this feature effectively, use a large number of rows for each
1103 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1105 while (my $rows = $data_source->get_100_rows()) {
1106 $rs->populate($rows);
1109 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1110 calls in your C<Result> classes B<must> list columns in database order for this
1111 to work. Also, you may have to unset the C<LC_ALL> environment variable before
1112 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1114 When inserting IMAGE columns using this method, you'll need to use
1115 L</connect_call_blob_setup> as well.
1117 =head1 COMPUTED COLUMNS
1119 If you have columns such as:
1121 created_dtm AS getdate()
1123 represent them in your Result classes as:
1127 default_value => \'getdate()',
1129 inflate_datetime => 1,
1132 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1133 on tables with such columns.
1135 =head1 TIMESTAMP COLUMNS
1137 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1138 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1140 They should be defined in your Result classes as:
1143 data_type => 'timestamp',
1145 inflate_datetime => 0,
1148 The C<<inflate_datetime => 0>> is necessary if you use
1149 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1150 be able to read these values.
1152 The values will come back as hexadecimal.
1160 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1161 any active cursors, using eager cursors.
1165 Real limits and limited counts using stored procedures deployed on startup.
1169 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1173 bulk_insert using prepare_cached (see comments.)
1177 =head1 FURTHER QUESTIONS?
1179 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
1181 =head1 COPYRIGHT AND LICENSE
1183 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
1184 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
1185 redistribute it and/or modify it under the same terms as the
1186 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.