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('DateTime::Format::Sybase');
23 __PACKAGE__->mk_group_accessors('simple' =>
24 qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
25 _bulk_storage _is_bulk_storage _began_bulk_work
26 _bulk_disabled_due_to_coderef_connect_info_warned
30 __PACKAGE__->datetime_parser_type(
31 'DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format'
34 my @also_proxy_to_extra_storages = qw/
35 connect_call_set_auto_cast auto_cast connect_call_blob_setup
36 connect_call_datetime_setup
38 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
39 auto_savepoint unsafe cursor_class debug debugobj schema
44 DBIx::Class::Storage::DBI::Sybase::ASE - Sybase ASE SQL Server support for
49 This subclass supports L<DBD::Sybase> for real (non-Microsoft) Sybase databases.
53 If your version of Sybase does not support placeholders, then your storage will
54 be reblessed to L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
55 You can also enable that driver explicitly, see the documentation for more
58 With this driver there is unfortunately no way to get the C<last_insert_id>
59 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
60 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
62 A recommended L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting:
64 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
73 my $no_bind_vars = __PACKAGE__ . '::NoBindVars';
75 if ($self->using_freetds) {
76 carp_once <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
78 You are using FreeTDS with Sybase.
80 We will do our best to support this configuration, but please consider this
83 TEXT/IMAGE columns will definitely not work.
85 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
88 See perldoc DBIx::Class::Storage::DBI::Sybase::ASE for more details.
90 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
94 if (not $self->_use_typeless_placeholders) {
95 if ($self->_use_placeholders) {
99 $self->ensure_class_loaded($no_bind_vars);
100 bless $self, $no_bind_vars;
106 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
107 # not necessarily FreeTDS, but no placeholders nevertheless
108 $self->ensure_class_loaded($no_bind_vars);
109 bless $self, $no_bind_vars;
112 # this is highly unlikely, but we check just in case
113 elsif (not $self->_use_typeless_placeholders) {
120 $self->_set_max_connect(256);
122 # create storage for insert/(update blob) transactions,
123 # unless this is that storage
124 return if $self->_is_extra_storage;
126 my $writer_storage = (ref $self)->new;
128 $writer_storage->_is_extra_storage(1);
129 $writer_storage->connect_info($self->connect_info);
130 $writer_storage->auto_cast($self->auto_cast);
132 $self->_writer_storage($writer_storage);
134 # create a bulk storage unless connect_info is a coderef
135 return if ref($self->_dbi_connect_info->[0]) eq 'CODE';
137 my $bulk_storage = (ref $self)->new;
139 $bulk_storage->_is_extra_storage(1);
140 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
141 $bulk_storage->connect_info($self->connect_info);
144 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
146 $self->_bulk_storage($bulk_storage);
149 for my $method (@also_proxy_to_extra_storages) {
151 no warnings 'redefine';
153 my $replaced = __PACKAGE__->can($method);
155 *{$method} = Sub::Name::subname $method => sub {
157 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
158 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
159 return $self->$replaced(@_);
166 # Even though we call $sth->finish for uses off the bulk API, there's still an
167 # "active statement" warning on disconnect, which we throw away here.
168 # This is due to the bug described in insert_bulk.
169 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
170 local $SIG{__WARN__} = sub {
171 warn $_[0] unless $_[0] =~ /active statement/i;
172 } if $self->_is_bulk_storage;
174 # so that next transaction gets a dbh
175 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
180 # This is only invoked for FreeTDS drivers by ::Storage::DBI::Sybase::FreeTDS
181 sub _set_autocommit_stmt {
182 my ($self, $on) = @_;
184 return 'SET CHAINED ' . ($on ? 'OFF' : 'ON');
187 # Set up session settings for Sybase databases for the connection.
189 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
190 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
191 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
192 # only want when AutoCommit is off.
193 sub _run_connection_actions {
196 if ($self->_is_bulk_storage) {
197 # this should be cleared on every reconnect
198 $self->_began_bulk_work(0);
202 $self->_dbh->{syb_chained_txn} = 1
203 unless $self->using_freetds;
205 $self->next::method(@_);
208 =head2 connect_call_blob_setup
212 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
214 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
215 instead of as a hex string.
219 Also sets the C<log_on_update> value for blob write operations. The default is
220 C<1>, but C<0> is better if your database is configured for it.
223 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
227 sub connect_call_blob_setup {
230 my $dbh = $self->_dbh;
231 $dbh->{syb_binary_images} = 1;
233 $self->_blob_log_on_update($args{log_on_update})
234 if exists $args{log_on_update};
238 my ($self, $source, $column) = @_;
240 return $self->_is_lob_type($source->column_info($column)->{data_type});
243 sub _prep_for_execute {
245 my ($op, $ident, $args) = @_;
247 my ($sql, $bind) = $self->next::method (@_);
249 my $table = blessed $ident ? $ident->from : $ident;
251 my $bind_info = $self->_resolve_column_info(
252 $ident, [map { $_->[0]{dbic_colname} || () } @{$bind}]
254 my $bound_identity_col =
255 first { $bind_info->{$_}{is_auto_increment} }
259 my $columns_info = blessed $ident && $ident->columns_info;
263 first { $columns_info->{$_}{is_auto_increment} }
267 if (($op eq 'insert' && $bound_identity_col) ||
268 ($op eq 'update' && exists $args->[0]{$identity_col})) {
270 $self->_set_table_identity_sql($op => $table, 'on'),
272 $self->_set_table_identity_sql($op => $table, 'off'),
276 if ($op eq 'insert' && (not $bound_identity_col) && $identity_col &&
277 (not $self->{insert_bulk})) {
280 $self->_fetch_identity_sql($ident, $identity_col);
283 return ($sql, $bind);
286 sub _set_table_identity_sql {
287 my ($self, $op, $table, $on_off) = @_;
289 return sprintf 'SET IDENTITY_%s %s %s',
290 uc($op), $self->sql_maker->_quote($table), uc($on_off);
293 # Stolen from SQLT, with some modifications. This is a makeshift
294 # solution before a sane type-mapping library is available, thus
295 # the 'our' for easy overrides.
296 our %TYPE_MAPPING = (
299 varchar => 'varchar',
300 varchar2 => 'varchar',
301 timestamp => 'datetime',
303 real => 'double precision',
306 tinyint => 'smallint',
307 float => 'double precision',
309 bigserial => 'numeric',
310 boolean => 'varchar',
314 sub _native_data_type {
315 my ($self, $type) = @_;
318 $type =~ s/\s* identity//x;
320 return uc($TYPE_MAPPING{$type} || $type);
323 sub _fetch_identity_sql {
324 my ($self, $source, $col) = @_;
326 return sprintf ("SELECT MAX(%s) FROM %s",
327 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
335 my ($rv, $sth, @bind) = $self->next::method(@_);
337 if ($op eq 'insert') {
338 $self->_identity($sth->fetchrow_array);
342 return wantarray ? ($rv, $sth, @bind) : $rv;
345 sub last_insert_id { shift->_identity }
347 # handles TEXT/IMAGE and transaction for last_insert_id
350 my ($source, $to_insert) = @_;
352 my $columns_info = $source->columns_info;
355 (first { $columns_info->{$_}{is_auto_increment} }
356 keys %$columns_info )
359 # check for empty insert
360 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
361 # try to insert explicit 'DEFAULT's instead (except for identity, timestamp
362 # and computed columns)
363 if (not %$to_insert) {
364 for my $col ($source->columns) {
365 next if $col eq $identity_col;
367 my $info = $source->column_info($col);
369 next if ref $info->{default_value} eq 'SCALAR'
370 || (exists $info->{data_type} && (not defined $info->{data_type}));
372 next if $info->{data_type} && $info->{data_type} =~ /^timestamp\z/i;
374 $to_insert->{$col} = \'DEFAULT';
378 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
380 # do we need the horrific SELECT MAX(COL) hack?
381 my $dumb_last_insert_id =
383 && (not exists $to_insert->{$identity_col})
384 && ($self->_identity_method||'') ne '@@IDENTITY';
386 my $next = $self->next::can;
388 # we are already in a transaction, or there are no blobs
389 # and we don't need the PK - just (try to) do it
390 if ($self->{transaction_depth}
391 || (!$blob_cols && !$dumb_last_insert_id)
393 return $self->_insert (
394 $next, $source, $to_insert, $blob_cols, $identity_col
398 # otherwise use the _writer_storage to do the insert+transaction on another
400 my $guard = $self->_writer_storage->txn_scope_guard;
402 my $updated_cols = $self->_writer_storage->_insert (
403 $next, $source, $to_insert, $blob_cols, $identity_col
406 $self->_identity($self->_writer_storage->_identity);
410 return $updated_cols;
414 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
416 my $updated_cols = $self->$next ($source, $to_insert);
420 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
425 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
427 return $updated_cols;
432 my ($source, $fields, $where, @rest) = @_;
434 my $blob_cols = $self->_remove_blob_cols($source, $fields);
436 my $table = $source->name;
438 my $columns_info = $source->columns_info;
441 first { $columns_info->{$_}{is_auto_increment} }
444 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
446 return $self->next::method(@_) unless $blob_cols;
448 # If there are any blobs in $where, Sybase will return a descriptive error
450 # XXX blobs can still be used with a LIKE query, and this should be handled.
452 # update+blob update(s) done atomically on separate connection
453 $self = $self->_writer_storage;
455 my $guard = $self->txn_scope_guard;
457 # First update the blob columns to be updated to '' (taken from $fields, where
458 # it is originally put by _remove_blob_cols .)
459 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
461 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
463 $self->next::method($source, \%blobs_to_empty, $where, @rest);
465 # Now update the blobs before the other columns in case the update of other
466 # columns makes the search condition invalid.
467 $self->_update_blobs($source, $blob_cols, $where);
472 @res = $self->next::method(@_);
474 elsif (defined wantarray) {
475 $res[0] = $self->next::method(@_);
478 $self->next::method(@_);
484 return wantarray ? @res : $res[0];
489 my ($source, $cols, $data) = @_;
491 my $columns_info = $source->columns_info;
494 first { $columns_info->{$_}{is_auto_increment} }
497 my $is_identity_insert = (first { $_ eq $identity_col } @{$cols}) ? 1 : 0;
499 my @source_columns = $source->columns;
502 $self->_bulk_storage &&
503 $self->_get_dbh->{syb_has_blk};
505 if ((not $use_bulk_api)
507 (ref($self->_dbi_connect_info->[0]) eq 'CODE')
509 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
511 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
512 regular array inserts.
514 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
517 if (not $use_bulk_api) {
518 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
520 # _execute_array uses a txn anyway, but it ends too early in case we need to
521 # select max(col) to get the identity for inserting blobs.
522 ($self, my $guard) = $self->{transaction_depth} == 0 ?
523 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
527 local $self->{insert_bulk} = 1;
529 $self->next::method(@_);
532 if ($is_identity_insert) {
533 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
536 my @cols_with_identities = (@$cols, $identity_col);
538 ## calculate identities
539 # XXX This assumes identities always increase by 1, which may or may not
541 my ($last_identity) =
542 $self->_dbh->selectrow_array (
543 $self->_fetch_identity_sql($source, $identity_col)
545 my @identities = (($last_identity - @$data + 1) .. $last_identity);
547 my @data_with_identities = map [@$_, shift @identities], @$data;
549 $self->_insert_blobs_array (
550 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
555 $guard->commit if $guard;
560 # otherwise, use the bulk API
562 # rearrange @$data so that columns are in database order
564 @orig_idx{@$cols} = 0..$#$cols;
567 @new_idx{@source_columns} = 0..$#source_columns;
570 for my $datum (@$data) {
572 for my $col (@source_columns) {
573 # identity data will be 'undef' if not $is_identity_insert
574 # columns with defaults will also be 'undef'
575 $new_datum->[ $new_idx{$col} ] =
576 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
578 push @new_data, $new_datum;
581 # bcp identity index is 1-based
582 my $identity_idx = exists $new_idx{$identity_col} ?
583 $new_idx{$identity_col} + 1 : 0;
585 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
586 # This ignores any data conversion errors detected by the client side libs, as
587 # they are usually harmless.
588 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
589 Sub::Name::subname insert_bulk => sub {
590 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
592 return 1 if $errno == 36;
595 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
596 ($errmsg ? "\n$errmsg" : '') .
597 ($osmsg ? "\n$osmsg" : '') .
598 ($blkmsg ? "\n$blkmsg" : '');
605 my $bulk = $self->_bulk_storage;
607 my $guard = $bulk->txn_scope_guard;
609 ## XXX get this to work instead of our own $sth
610 ## will require SQLA or *Hacks changes for ordered columns
611 # $bulk->next::method($source, \@source_columns, \@new_data, {
612 # syb_bcp_attribs => {
613 # identity_flag => $is_identity_insert,
614 # identity_column => $identity_idx,
617 my $sql = 'INSERT INTO ' .
618 $bulk->sql_maker->_quote($source->name) . ' (' .
619 # colname list is ignored for BCP, but does no harm
620 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
621 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
623 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
624 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
625 ## better yet the version above. Should be fixed in DBD::Sybase .
626 my $sth = $bulk->_get_dbh->prepare($sql,
630 identity_flag => $is_identity_insert,
631 identity_column => $identity_idx,
636 my @bind = map { [ $source_columns[$_] => $_ ] } (0 .. $#source_columns);
638 $self->_execute_array(
639 $source, $sth, \@bind, \@source_columns, \@new_data, sub {
644 $bulk->_query_end($sql);
649 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
651 if ($exception =~ /-Y option/) {
652 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
653 . 'reverting to regular array inserts. Try unsetting the LANG environment variable'
655 $w .= "\n$exception" if $self->debug;
658 $self->_bulk_storage(undef);
663 # rollback makes the bulkLogin connection unusable
664 $self->_bulk_storage->disconnect;
665 $self->throw_exception($exception);
669 sub _dbh_execute_array {
670 my ($self, $sth, $tuple_status, $cb) = @_;
672 my $rv = $self->next::method($sth, $tuple_status);
678 # Make sure blobs are not bound as placeholders, and return any non-empty ones
680 sub _remove_blob_cols {
681 my ($self, $source, $fields) = @_;
685 for my $col (keys %$fields) {
686 if ($self->_is_lob_column($source, $col)) {
687 my $blob_val = delete $fields->{$col};
688 if (not defined $blob_val) {
689 $fields->{$col} = \'NULL';
692 $fields->{$col} = \"''";
693 $blob_cols{$col} = $blob_val unless $blob_val eq '';
698 return %blob_cols ? \%blob_cols : undef;
701 # same for insert_bulk
702 sub _remove_blob_cols_array {
703 my ($self, $source, $cols, $data) = @_;
707 for my $i (0..$#$cols) {
708 my $col = $cols->[$i];
710 if ($self->_is_lob_column($source, $col)) {
711 for my $j (0..$#$data) {
712 my $blob_val = delete $data->[$j][$i];
713 if (not defined $blob_val) {
714 $data->[$j][$i] = \'NULL';
717 $data->[$j][$i] = \"''";
718 $blob_cols[$j][$i] = $blob_val
719 unless $blob_val eq '';
725 return @blob_cols ? \@blob_cols : undef;
729 my ($self, $source, $blob_cols, $where) = @_;
731 my @primary_cols = try
732 { $source->_pri_cols }
734 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
741 @primary_cols == grep { defined $where->{$_} } @primary_cols
744 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
745 @pks_to_update = \%row_to_update;
748 my $cursor = $self->select ($source, \@primary_cols, $where, {});
749 @pks_to_update = map {
750 my %row; @row{@primary_cols} = @$_; \%row
754 for my $ident (@pks_to_update) {
755 $self->_insert_blobs($source, $blob_cols, $ident);
760 my ($self, $source, $blob_cols, $row) = @_;
761 my $dbh = $self->_get_dbh;
763 my $table = $source->name;
766 my @primary_cols = try
767 { $source->_pri_cols }
769 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
772 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
773 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
775 for my $col (keys %$blob_cols) {
776 my $blob = $blob_cols->{$col};
778 my %where = map { ($_, $row{$_}) } @primary_cols;
780 my $cursor = $self->select ($source, [$col], \%where, {});
782 my $sth = $cursor->sth;
785 $self->throw_exception(
786 "Could not find row in table '$table' for blob update:\n"
793 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
796 $sth->func('ct_prepare_send') or die $sth->errstr;
798 my $log_on_update = $self->_blob_log_on_update;
799 $log_on_update = 1 if not defined $log_on_update;
801 $sth->func('CS_SET', 1, {
802 total_txtlen => length($blob),
803 log_on_update => $log_on_update
804 }, 'ct_data_info') or die $sth->errstr;
806 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
808 $sth->func('ct_finish_send') or die $sth->errstr;
811 if ($self->using_freetds) {
812 $self->throw_exception (
813 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
817 $self->throw_exception($_);
821 $sth->finish if $sth;
826 sub _insert_blobs_array {
827 my ($self, $source, $blob_cols, $cols, $data) = @_;
829 for my $i (0..$#$data) {
830 my $datum = $data->[$i];
833 @row{ @$cols } = @$datum;
836 for my $j (0..$#$cols) {
837 if (exists $blob_cols->[$i][$j]) {
838 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
842 $self->_insert_blobs ($source, \%blob_vals, \%row);
846 =head2 connect_call_datetime_setup
850 on_connect_call => 'datetime_setup'
852 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
854 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
855 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
857 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
858 L<DateTime::Format::Sybase>, which you will need to install.
860 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
861 C<SMALLDATETIME> columns only have minute precision.
865 sub connect_call_datetime_setup {
867 my $dbh = $self->_get_dbh;
869 if ($dbh->can('syb_date_fmt')) {
870 # amazingly, this works with FreeTDS
871 $dbh->syb_date_fmt('ISO_strict');
875 'Your DBD::Sybase is too old to support '
876 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
878 $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 check C<< $schema->storage->using_freetds >>, or 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 $row = $rs->next) {
1014 $schema->resultset('MetaData')->create({
1015 book_id => $row->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 TEXT/IMAGE COLUMNS
1062 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1063 C<TEXT/IMAGE> columns.
1065 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1067 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1071 $schema->storage->set_textsize($bytes);
1075 However, the C<LongReadLen> you pass in
1076 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1077 equivalent C<SET TEXTSIZE> command on connection.
1079 See L</connect_call_blob_setup> for a
1080 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1081 with C<IMAGE> columns.
1085 The experimental L<DBD::Sybase> Bulk API support is used for
1086 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1087 on a separate connection.
1089 To use this feature effectively, use a large number of rows for each
1090 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1092 while (my $rows = $data_source->get_100_rows()) {
1093 $rs->populate($rows);
1096 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1097 calls in your C<Result> classes B<must> list columns in database order for this
1098 to work. Also, you may have to unset the C<LANG> environment variable before
1099 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1101 When inserting IMAGE columns using this method, you'll need to use
1102 L</connect_call_blob_setup> as well.
1104 =head1 COMPUTED COLUMNS
1106 If you have columns such as:
1108 created_dtm AS getdate()
1110 represent them in your Result classes as:
1114 default_value => \'getdate()',
1116 inflate_datetime => 1,
1119 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1120 on tables with such columns.
1122 =head1 TIMESTAMP COLUMNS
1124 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1125 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1127 They should be defined in your Result classes as:
1130 data_type => 'timestamp',
1132 inflate_datetime => 0,
1135 The C<<inflate_datetime => 0>> is necessary if you use
1136 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1137 be able to read these values.
1139 The values will come back as hexadecimal.
1147 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1148 any active cursors, using eager cursors.
1152 Real limits and limited counts using stored procedures deployed on startup.
1156 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1160 bulk_insert using prepare_cached (see comments.)
1166 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
1170 You may distribute this code under the same terms as Perl itself.