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/;
15 use Context::Preserve 'preserve_context';
16 use DBIx::Class::_Util qw( sigwarn_silencer dbic_internal_try dump_value scope_guard set_subname );
19 __PACKAGE__->sql_limit_dialect ('GenericSubQ');
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 _identity_method _blob_log_on_update _parent_storage
27 _writer_storage _is_writer_storage
28 _bulk_storage _is_bulk_storage _began_bulk_work
33 my @also_proxy_to_extra_storages = qw/
34 connect_call_set_auto_cast auto_cast connect_call_blob_setup
35 connect_call_datetime_setup
37 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
38 auto_savepoint unsafe cursor_class debug debugobj schema
43 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
48 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
52 If your version of Sybase does not support placeholders, then your storage will
53 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
54 You can also enable that driver explicitly, see the documentation for more
57 With this driver there is unfortunately no way to get the C<last_insert_id>
58 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
59 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
61 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
63 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
72 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
74 if ($self->_using_freetds) {
75 carp_once <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
77 You are using FreeTDS with Sybase.
79 We will do our best to support this configuration, but please consider this
82 TEXT/IMAGE columns will definitely not work.
84 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
87 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
89 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
93 if (not $self->_use_typeless_placeholders) {
94 if ($self->_use_placeholders) {
98 $self->ensure_class_loaded($no_bind_vars);
99 bless $self, $no_bind_vars;
105 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
106 # not necessarily FreeTDS, but no placeholders nevertheless
107 $self->ensure_class_loaded($no_bind_vars);
108 bless $self, $no_bind_vars;
111 # this is highly unlikely, but we check just in case
112 elsif (not $self->_use_typeless_placeholders) {
120 $self->next::method(@_);
122 if ($self->_using_freetds && (my $ver = $self->_using_freetds_version||999) > 0.82) {
124 "Buggy FreeTDS version $ver detected, statement caching will not work and "
125 . 'will be disabled.'
127 $self->disable_sth_caching(1);
130 $self->_set_max_connect(256);
132 # create storage for insert/(update blob) transactions,
133 # unless this is that storage
134 return if $self->_parent_storage;
136 my $writer_storage = (ref $self)->new;
138 $writer_storage->_is_writer_storage(1); # just info
139 $writer_storage->connect_info($self->connect_info);
140 $writer_storage->auto_cast($self->auto_cast);
142 weaken ($writer_storage->{_parent_storage} = $self);
143 $self->_writer_storage($writer_storage);
145 # create a bulk storage unless connect_info is a coderef
146 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
148 my $bulk_storage = (ref $self)->new;
150 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
151 $bulk_storage->connect_info($self->connect_info);
154 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
156 weaken ($bulk_storage->{_parent_storage} = $self);
157 $self->_bulk_storage($bulk_storage);
160 for my $method (@also_proxy_to_extra_storages) {
162 no warnings 'redefine';
164 my $replaced = __PACKAGE__->can($method);
166 *{$method} = set_subname $method => sub {
168 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
169 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
170 return $self->$replaced(@_);
177 # Even though we call $sth->finish for uses off the bulk API, there's still an
178 # "active statement" warning on disconnect, which we throw away here.
179 # This is due to the bug described in _insert_bulk.
180 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
181 local $SIG{__WARN__} = sigwarn_silencer(qr/active statement/i)
182 if $self->_is_bulk_storage;
184 # so that next transaction gets a dbh
185 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
190 # This is only invoked for FreeTDS drivers by ::Storage::DBI::Sybase::FreeTDS
191 sub _set_autocommit_stmt {
192 my ($self, $on) = @_;
194 return 'SET CHAINED ' . ($on ? 'OFF' : 'ON');
197 # Set up session settings for Sybase databases for the connection.
199 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
200 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
201 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
202 # only want when AutoCommit is off.
203 sub _run_connection_actions {
206 if ($self->_is_bulk_storage) {
207 # this should be cleared on every reconnect
208 $self->_began_bulk_work(0);
212 $self->_dbh->{syb_chained_txn} = 1
213 unless $self->_using_freetds;
215 $self->next::method(@_);
218 =head2 connect_call_blob_setup
222 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
224 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
225 instead of as a hex string.
229 Also sets the C<log_on_update> value for blob write operations. The default is
230 C<1>, but C<0> is better if your database is configured for it.
233 L<DBD::Sybase/Handling IMAGE/TEXT data with syb_ct_get_data()/syb_ct_send_data()>.
237 sub connect_call_blob_setup {
240 my $dbh = $self->_dbh;
241 $dbh->{syb_binary_images} = 1;
243 $self->_blob_log_on_update($args{log_on_update})
244 if exists $args{log_on_update};
248 my ($self, $source, $column) = @_;
250 return $self->_is_lob_type($source->column_info($column)->{data_type});
253 sub _prep_for_execute {
254 my ($self, $op, $ident, $args) = @_;
256 my $limit; # extract and use shortcut on limit without offset
257 if ($op eq 'select' and ! $args->[4] and $limit = $args->[3]) {
262 my ($sql, $bind) = $self->next::method($op, $ident, $args);
264 # $limit is already sanitized by now
266 "SET ROWCOUNT $limit",
271 if (my $identity_col = $self->_perform_autoinc_retrieval) {
272 $sql .= "\n" . $self->_fetch_identity_sql($ident, $identity_col)
275 return ($sql, $bind);
278 sub _fetch_identity_sql {
279 my ($self, $source, $col) = @_;
281 return sprintf ("SELECT MAX(%s) FROM %s",
282 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
286 # Stolen from SQLT, with some modifications. This is a makeshift
287 # solution before a sane type-mapping library is available, thus
288 # the 'our' for easy overrides.
289 our %TYPE_MAPPING = (
292 varchar => 'varchar',
293 varchar2 => 'varchar',
294 timestamp => 'datetime',
296 real => 'double precision',
299 tinyint => 'smallint',
300 float => 'double precision',
302 bigserial => 'numeric',
303 boolean => 'varchar',
307 sub _native_data_type {
308 my ($self, $type) = @_;
311 $type =~ s/\s* identity//x;
313 return uc($TYPE_MAPPING{$type} || $type);
319 my ($rv, $sth, @bind) = $self->next::method(@_);
321 $self->_identity( ($sth->fetchall_arrayref)->[0][0] )
322 if $self->_perform_autoinc_retrieval;
324 return wantarray ? ($rv, $sth, @bind) : $rv;
327 sub last_insert_id { shift->_identity }
329 # handles TEXT/IMAGE and transaction for last_insert_id
332 my ($source, $to_insert) = @_;
334 my $columns_info = $source->columns_info;
336 my ($identity_col) = grep
337 { $columns_info->{$_}{is_auto_increment} }
341 $identity_col = '' if ! defined $identity_col;
343 # FIXME - this is duplication from DBI.pm. When refactored towards
344 # the LobWriter this can be folded back where it belongs.
345 local $self->{_autoinc_supplied_for_op} = exists $to_insert->{$identity_col}
350 local $self->{_perform_autoinc_retrieval} = $self->{_autoinc_supplied_for_op}
355 # check for empty insert
356 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
357 # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
358 # and computed columns)
359 if (not %$to_insert) {
360 for my $col ($source->columns) {
361 next if $col eq $identity_col;
363 my $info = $source->column_info($col);
365 next if ref $info->{default_value} eq 'SCALAR'
366 || (exists $info->{data_type} && (not defined $info->{data_type}));
368 next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
370 $to_insert->{$col} = \'DEFAULT';
374 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
376 # if a new txn is needed - it must happen on the _writer/new connection (for now)
379 ! $self->transaction_depth
384 # do we need the horrific SELECT MAX(COL) hack?
386 $self->_perform_autoinc_retrieval
388 ( ($self->_identity_method||'') ne '@@IDENTITY' )
392 $self = $self->_writer_storage;
393 $guard = $self->txn_scope_guard;
396 my $updated_cols = $self->next::method ($source, $to_insert);
398 $self->_insert_blobs (
403 ? ( $identity_col => $self->last_insert_id($source, $identity_col) )
411 $guard->commit if $guard;
413 return $updated_cols;
418 my ($source, $fields, $where, @rest) = @_;
421 # When *updating* identities, ASE requires SET IDENTITY_UPDATE called
423 if (my $blob_cols = $self->_remove_blob_cols($source, $fields)) {
425 # If there are any blobs in $where, Sybase will return a descriptive error
427 # XXX blobs can still be used with a LIKE query, and this should be handled.
429 # update+blob update(s) done atomically on separate connection
430 $self = $self->_writer_storage;
432 my $guard = $self->txn_scope_guard;
434 # First update the blob columns to be updated to '' (taken from $fields, where
435 # it is originally put by _remove_blob_cols .)
436 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
438 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
439 $self->next::method($source, \%blobs_to_empty, $where, @rest);
441 # Now update the blobs before the other columns in case the update of other
442 # columns makes the search condition invalid.
443 my $rv = $self->_update_blobs($source, $blob_cols, $where);
447 # Now set the identity update flags for the actual update
448 local $self->{_autoinc_supplied_for_op} = grep
449 { $_->{is_auto_increment} }
450 values %{ $source->columns_info([ keys %$fields ]) }
453 my $next = $self->next::can;
455 return preserve_context {
456 $self->$next(@$args);
457 } after => sub { $guard->commit };
465 # Set the identity update flags for the actual update
466 local $self->{_autoinc_supplied_for_op} = grep
467 { $_->{is_auto_increment} }
468 values %{ $source->columns_info([ keys %$fields ]) }
471 return $self->next::method(@_);
477 my ($source, $cols, $data) = @_;
479 my $columns_info = $source->columns_info;
482 grep { $columns_info->{$_}{is_auto_increment} }
485 # FIXME - this is duplication from DBI.pm. When refactored towards
486 # the LobWriter this can be folded back where it belongs.
487 local $self->{_autoinc_supplied_for_op}
488 = grep { $_ eq $identity_col } @$cols;
491 $self->_bulk_storage &&
492 $self->_get_dbh->{syb_has_blk};
494 if (! $use_bulk_api and ref($self->_dbi_connect_info->[0]) eq 'CODE') {
495 carp_unique( join ' ',
496 'Bulk API support disabled due to use of a CODEREF connect_info.',
497 'Reverting to regular array inserts.',
501 if (not $use_bulk_api) {
502 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
504 # next::method uses a txn anyway, but it ends too early in case we need to
505 # select max(col) to get the identity for inserting blobs.
506 ($self, my $guard) = $self->transaction_depth
508 : ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
511 $self->next::method(@_);
514 if ($self->_autoinc_supplied_for_op) {
515 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
518 my @cols_with_identities = (@$cols, $identity_col);
520 ## calculate identities
521 # XXX This assumes identities always increase by 1, which may or may not
523 my ($last_identity) =
524 $self->_dbh->selectrow_array (
525 $self->_fetch_identity_sql($source, $identity_col)
527 my @identities = (($last_identity - @$data + 1) .. $last_identity);
529 my @data_with_identities = map [@$_, shift @identities], @$data;
531 $self->_insert_blobs_array (
532 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
537 $guard->commit if $guard;
542 # otherwise, use the bulk API
544 # rearrange @$data so that columns are in database order
545 # and so we submit a full column list
546 my %orig_order = map { $cols->[$_] => $_ } 0..$#$cols;
548 my @source_columns = $source->columns;
550 # bcp identity index is 1-based
551 my ($identity_idx) = grep { $source_columns[$_] eq $identity_col } (0..$#source_columns);
552 $identity_idx = defined $identity_idx ? $identity_idx + 1 : 0;
555 for my $slice_idx (0..$#$data) {
556 push @new_data, [map {
557 # identity data will be 'undef' if not _autoinc_supplied_for_op()
558 # columns with defaults will also be 'undef'
559 exists $orig_order{$_}
560 ? $data->[$slice_idx][$orig_order{$_}]
565 my $proto_bind = $self->_resolve_bindattrs(
568 [ { dbic_colname => $source_columns[$_], _bind_data_slice_idx => $_ }
569 => $new_data[0][$_] ]
570 } (0 ..$#source_columns) ],
574 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
575 # This ignores any data conversion errors detected by the client side libs, as
576 # they are usually harmless.
577 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
578 set_subname _insert_bulk_cslib_errhandler => sub {
579 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
581 return 1 if $errno == 36;
584 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
585 ($errmsg ? "\n$errmsg" : '') .
586 ($osmsg ? "\n$osmsg" : '') .
587 ($blkmsg ? "\n$blkmsg" : '');
594 my $bulk = $self->_bulk_storage;
596 my $guard = $bulk->txn_scope_guard;
598 ## FIXME - once this is done - address the FIXME on finish() below
599 ## XXX get this to work instead of our own $sth
600 ## will require SQLA or *Hacks changes for ordered columns
601 # $bulk->next::method($source, \@source_columns, \@new_data, {
602 # syb_bcp_attribs => {
603 # identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
604 # identity_column => $identity_idx,
607 my $sql = 'INSERT INTO ' .
608 $bulk->sql_maker->_quote($source->name) . ' (' .
609 # colname list is ignored for BCP, but does no harm
610 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
611 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
613 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
614 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
615 ## better yet the version above. Should be fixed in DBD::Sybase .
616 my $sth = $bulk->_get_dbh->prepare($sql,
620 identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
621 identity_column => $identity_idx,
627 # FIXME the $sth->finish in _execute_array does a rollback for some
628 # reason. Disable it temporarily until we fix the SQLMaker thing above
629 no warnings 'redefine';
631 local *{ref($sth).'::finish'} = sub {};
633 $self->_dbh_execute_for_fetch(
634 $source, $sth, $proto_bind, \@source_columns, \@new_data
640 $bulk->_query_end($sql);
645 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
647 if ($exception =~ /-Y option/) {
648 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
649 . 'reverting to regular array inserts. Try unsetting the LC_ALL environment variable'
651 $w .= "\n$exception" if $self->debug;
654 $self->_bulk_storage(undef);
659 # rollback makes the bulkLogin connection unusable
660 $self->_bulk_storage->disconnect;
661 $self->throw_exception($exception);
665 # Make sure blobs are not bound as placeholders, and return any non-empty ones
667 sub _remove_blob_cols {
668 my ($self, $source, $fields) = @_;
672 for my $col (keys %$fields) {
673 if ($self->_is_lob_column($source, $col)) {
674 my $blob_val = delete $fields->{$col};
675 if (not defined $blob_val) {
676 $fields->{$col} = \'NULL';
679 $fields->{$col} = \"''";
680 $blob_cols{$col} = $blob_val
686 return %blob_cols ? \%blob_cols : undef;
689 # same for _insert_bulk
690 sub _remove_blob_cols_array {
691 my ($self, $source, $cols, $data) = @_;
695 for my $i (0..$#$cols) {
696 my $col = $cols->[$i];
698 if ($self->_is_lob_column($source, $col)) {
699 for my $j (0..$#$data) {
700 my $blob_val = delete $data->[$j][$i];
701 if (not defined $blob_val) {
702 $data->[$j][$i] = \'NULL';
705 $data->[$j][$i] = \"''";
706 $blob_cols[$j][$i] = $blob_val
713 return @blob_cols ? \@blob_cols : undef;
717 my ($self, $source, $blob_cols, $where) = @_;
719 my @primary_cols = dbic_internal_try
720 { $source->_pri_cols_or_die }
722 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
729 ! grep { ! defined $where->{$_} } @primary_cols
732 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
733 @pks_to_update = \%row_to_update;
736 my $cursor = $self->select ($source, \@primary_cols, $where, {});
737 @pks_to_update = map {
738 my %row; @row{@primary_cols} = @$_; \%row
742 for my $ident (@pks_to_update) {
743 $self->_insert_blobs($source, $blob_cols, $ident);
748 my ($self, $source, $blob_cols, $row_data) = @_;
750 my $table = $source->name;
752 my @primary_cols = dbic_internal_try
753 { $source->_pri_cols_or_die }
755 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
758 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
759 if grep { ! defined $row_data->{$_} } @primary_cols;
761 # if we are 2-phase inserting a blob - there is nothing to retrieve anymore,
762 # regardless of the previous state of the flag
763 local $self->{_perform_autoinc_retrieval}
764 if $self->_perform_autoinc_retrieval;
766 my %where = map {( $_ => $row_data->{$_} )} @primary_cols;
768 for my $col (keys %$blob_cols) {
769 my $blob = $blob_cols->{$col};
771 my $cursor = $self->select ($source, [$col], \%where, {});
773 my $sth = $cursor->sth;
776 $self->throw_exception(
777 "Could not find row in table '$table' for blob update:\n"
782 # FIXME - it is not clear if this is needed at all. But it's been
783 # there since 2009 ( d867eedaa ), might as well let sleeping dogs
785 weaken( my $wsth = $sth );
786 my $g = scope_guard { $wsth->finish if $wsth };
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($_);
820 sub _insert_blobs_array {
821 my ($self, $source, $blob_cols, $cols, $data) = @_;
823 for my $i (0..$#$data) {
824 my $datum = $data->[$i];
827 @row{ @$cols } = @$datum;
830 for my $j (0..$#$cols) {
831 if (exists $blob_cols->[$i][$j]) {
832 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
836 $self->_insert_blobs ($source, \%blob_vals, \%row);
840 =head2 connect_call_datetime_setup
844 on_connect_call => 'datetime_setup'
846 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
848 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
849 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
851 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
852 C<SMALLDATETIME> columns only have minute precision.
856 sub connect_call_datetime_setup {
858 my $dbh = $self->_get_dbh;
860 if ($dbh->can('syb_date_fmt')) {
861 # amazingly, this works with FreeTDS
862 $dbh->syb_date_fmt('ISO_strict');
866 'Your DBD::Sybase is too old to support '
867 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
869 # FIXME - in retrospect this is a rather bad US-centric choice
870 # of format. Not changing as a bugwards compat, though in reality
871 # the only piece that sees the results of $dt object formatting
872 # (as opposed to parsing) is the database itself, so theoretically
873 # changing both this SET command and the formatter definition of
874 # ::S::D::Sybase::ASE::DateTime::Format below should be safe and
877 $dbh->do('SET DATEFORMAT mdy');
882 sub _exec_txn_begin {
885 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
886 # TRAN once. However, we need to make sure there's a $dbh.
887 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
889 $self->next::method(@_);
891 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
894 # savepoint support using ASE syntax
896 sub _exec_svp_begin {
897 my ($self, $name) = @_;
899 $self->_dbh->do("SAVE TRANSACTION $name");
902 # A new SAVE TRANSACTION with the same name releases the previous one.
903 sub _exec_svp_release { 1 }
905 sub _exec_svp_rollback {
906 my ($self, $name) = @_;
908 $self->_dbh->do("ROLLBACK TRANSACTION $name");
911 package # hide from PAUSE
912 DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format;
914 my $datetime_parse_format = '%Y-%m-%dT%H:%M:%S.%3NZ';
915 my $datetime_format_format = '%m/%d/%Y %H:%M:%S.%3N';
917 my ($datetime_parser, $datetime_formatter);
921 require DateTime::Format::Strptime;
922 $datetime_parser ||= DateTime::Format::Strptime->new(
923 pattern => $datetime_parse_format,
926 return $datetime_parser->parse_datetime(shift);
929 sub format_datetime {
931 require DateTime::Format::Strptime;
932 $datetime_formatter ||= DateTime::Format::Strptime->new(
933 pattern => $datetime_format_format,
936 return $datetime_formatter->format_datetime(shift);
941 =head1 Schema::Loader Support
943 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
944 most versions of Sybase ASE.
948 This driver supports L<DBD::Sybase> compiled against FreeTDS
949 (L<http://www.freetds.org/>) to the best of our ability, however it is
950 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
951 libraries. They are a part of the Sybase ASE distribution:
953 The Open Client FAQ is here:
954 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
956 Sybase ASE for Linux (which comes with the Open Client libraries) may be
957 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
959 To see if you're using FreeTDS run:
961 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
963 It is recommended to set C<tds version> for your ASE server to C<5.0> in
964 C</etc/freetds/freetds.conf>.
966 Some versions or configurations of the libraries involved will not support
967 placeholders, in which case the storage will be reblessed to
968 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
970 In some configurations, placeholders will work but will throw implicit type
971 conversion errors for anything that's not expecting a string. In such a case,
972 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
973 automatically set, which you may enable on connection with
974 L<connect_call_set_auto_cast|DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>.
975 The type info for the C<CAST>s is taken from the
976 L<DBIx::Class::ResultSource/data_type> definitions in your Result classes, and
977 are mapped to a Sybase type (if it isn't already) using a mapping based on
980 In other configurations, placeholders will work just as they do with the Sybase
981 Open Client libraries.
983 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
985 =head1 INSERTS WITH PLACEHOLDERS
987 With placeholders enabled, inserts are done in a transaction so that there are
988 no concurrency issues with getting the inserted identity value using
989 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
992 In addition, they are done on a separate connection so that it's possible to
993 have active cursors when doing an insert.
995 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
996 are unnecessary and not used, as there are no concurrency issues with C<SELECT
997 @@IDENTITY> which is a session variable.
1001 Due to limitations of the TDS protocol and L<DBD::Sybase>, you cannot begin a
1002 transaction while there are active cursors, nor can you use multiple active
1003 cursors within a transaction. An active cursor is, for example, a
1004 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1005 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1007 For example, this will not work:
1009 $schema->txn_do(sub {
1010 my $rs = $schema->resultset('Book');
1011 while (my $result = $rs->next) {
1012 $schema->resultset('MetaData')->create({
1013 book_id => $result->id,
1021 my $first_row = $large_rs->first;
1022 $schema->txn_do(sub { ... });
1024 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1025 are not affected, as they are done on an extra database handle.
1031 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1033 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1035 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1039 =head1 MAXIMUM CONNECTIONS
1041 The TDS protocol makes separate connections to the server for active statements
1042 in the background. By default the number of such connections is limited to 25,
1043 on both the client side and the server side.
1045 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1046 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1047 can override it to whatever setting you like in the DSN.
1050 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1051 for information on changing the setting on the server side.
1055 See L</connect_call_datetime_setup> to setup date formats
1056 for L<DBIx::Class::InflateColumn::DateTime>.
1058 =head1 LIMITED QUERIES
1060 Because ASE does not have a good way to limit results in SQL that works for
1061 all types of queries, the limit dialect is set to
1062 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ>.
1064 Fortunately, ASE and L<DBD::Sybase> support cursors properly, so when
1065 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> is too slow
1066 you can use the L<software_limit|DBIx::Class::ResultSet/software_limit>
1067 L<DBIx::Class::ResultSet> attribute to simulate limited queries by skipping
1070 =head1 TEXT/IMAGE COLUMNS
1072 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1073 C<TEXT/IMAGE> columns.
1075 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1077 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1081 $schema->storage->set_textsize($bytes);
1085 However, the C<LongReadLen> you pass in
1086 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1087 equivalent C<SET TEXTSIZE> command on connection.
1089 See L</connect_call_blob_setup> for a
1090 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1091 with C<IMAGE> columns.
1095 The experimental L<DBD::Sybase> Bulk API support is used for
1096 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1097 on a separate connection.
1099 To use this feature effectively, use a large number of rows for each
1100 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1102 while (my $rows = $data_source->get_100_rows()) {
1103 $rs->populate($rows);
1106 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1107 calls in your C<Result> classes B<must> list columns in database order for this
1108 to work. Also, you may have to unset the C<LC_ALL> environment variable before
1109 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1111 When inserting IMAGE columns using this method, you'll need to use
1112 L</connect_call_blob_setup> as well.
1114 =head1 COMPUTED COLUMNS
1116 If you have columns such as:
1118 created_dtm AS getdate()
1120 represent them in your Result classes as:
1124 default_value => \'getdate()',
1126 inflate_datetime => 1,
1129 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1130 on tables with such columns.
1132 =head1 TIMESTAMP COLUMNS
1134 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1135 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1137 They should be defined in your Result classes as:
1140 data_type => 'timestamp',
1142 inflate_datetime => 0,
1145 The C<<inflate_datetime => 0>> is necessary if you use
1146 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1147 be able to read these values.
1149 The values will come back as hexadecimal.
1157 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1158 any active cursors, using eager cursors.
1162 Real limits and limited counts using stored procedures deployed on startup.
1166 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1170 bulk_insert using prepare_cached (see comments.)
1174 =head1 FURTHER QUESTIONS?
1176 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
1178 =head1 COPYRIGHT AND LICENSE
1180 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
1181 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
1182 redistribute it and/or modify it under the same terms as the
1183 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.