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 Context::Preserve 'preserve_context';
15 use DBIx::Class::_Util qw(
16 sigwarn_silencer dbic_internal_try dbic_internal_catch
17 dump_value scope_guard set_subname
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} = set_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(
253 $source->columns_info([$column])->{$column}{data_type}
257 sub _prep_for_execute {
258 my ($self, $op, $ident, $args) = @_;
260 my $limit; # extract and use shortcut on limit without offset
261 if ($op eq 'select' and ! $args->[4] and $limit = $args->[3]) {
266 my ($sql, $bind) = $self->next::method($op, $ident, $args);
268 # $limit is already sanitized by now
270 "SET ROWCOUNT $limit",
275 if (my $identity_col = $self->_perform_autoinc_retrieval) {
276 $sql .= "\n" . $self->_fetch_identity_sql($ident, $identity_col)
279 return ($sql, $bind);
282 sub _fetch_identity_sql {
283 my ($self, $source, $col) = @_;
285 return sprintf ("SELECT MAX(%s) FROM %s",
286 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
290 # Stolen from SQLT, with some modifications. This is a makeshift
291 # solution before a sane type-mapping library is available, thus
292 # the 'our' for easy overrides.
293 our %TYPE_MAPPING = (
296 varchar => 'varchar',
297 varchar2 => 'varchar',
298 timestamp => 'datetime',
300 real => 'double precision',
303 tinyint => 'smallint',
304 float => 'double precision',
306 bigserial => 'numeric',
307 boolean => 'varchar',
311 sub _native_data_type {
312 my ($self, $type) = @_;
315 $type =~ s/\s* identity//x;
317 return uc($TYPE_MAPPING{$type} || $type);
323 my ($rv, $sth, @bind) = $self->next::method(@_);
325 $self->_identity( ($sth->fetchall_arrayref)->[0][0] )
326 if $self->_perform_autoinc_retrieval;
328 return wantarray ? ($rv, $sth, @bind) : $rv;
331 sub last_insert_id { shift->_identity }
333 # handles TEXT/IMAGE and transaction for last_insert_id
336 my ($source, $to_insert) = @_;
338 my $columns_info = $source->columns_info;
340 my ($identity_col) = grep
341 { $columns_info->{$_}{is_auto_increment} }
345 $identity_col = '' if ! defined $identity_col;
347 # FIXME - this is duplication from DBI.pm. When refactored towards
348 # the LobWriter this can be folded back where it belongs.
349 local $self->{_autoinc_supplied_for_op} = exists $to_insert->{$identity_col}
354 local $self->{_perform_autoinc_retrieval} = $self->{_autoinc_supplied_for_op}
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) {
366 # same order as add_columns
367 for my $col ($source->columns) {
368 next if $col eq $identity_col;
370 my $info = ( $ci ||= $source->columns_info )->{$col};
373 ref $info->{default_value} eq 'SCALAR'
376 exists $info->{data_type}
378 ! defined $info->{data_type}
382 ( $info->{data_type} || '' )
387 $to_insert->{$col} = \'DEFAULT';
391 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
393 # if a new txn is needed - it must happen on the _writer/new connection (for now)
396 ! $self->transaction_depth
401 # do we need the horrific SELECT MAX(COL) hack?
403 $self->_perform_autoinc_retrieval
405 ( ($self->_identity_method||'') ne '@@IDENTITY' )
409 $self = $self->_writer_storage;
410 $guard = $self->txn_scope_guard;
413 my $updated_cols = $self->next::method ($source, $to_insert);
415 $self->_insert_blobs (
420 ? ( $identity_col => $self->last_insert_id($source, $identity_col) )
428 $guard->commit if $guard;
430 return $updated_cols;
435 my ($source, $fields, $where, @rest) = @_;
438 # When *updating* identities, ASE requires SET IDENTITY_UPDATE called
440 if (my $blob_cols = $self->_remove_blob_cols($source, $fields)) {
442 # If there are any blobs in $where, Sybase will return a descriptive error
444 # XXX blobs can still be used with a LIKE query, and this should be handled.
446 # update+blob update(s) done atomically on separate connection
447 $self = $self->_writer_storage;
449 my $guard = $self->txn_scope_guard;
451 # First update the blob columns to be updated to '' (taken from $fields, where
452 # it is originally put by _remove_blob_cols .)
453 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
455 # We can't only update NULL blobs, because blobs cannot be in the WHERE clause.
456 $self->next::method($source, \%blobs_to_empty, $where, @rest);
458 # Now update the blobs before the other columns in case the update of other
459 # columns makes the search condition invalid.
460 my $rv = $self->_update_blobs($source, $blob_cols, $where);
464 # Now set the identity update flags for the actual update
465 local $self->{_autoinc_supplied_for_op} = grep
466 { $_->{is_auto_increment} }
467 values %{ $source->columns_info([ keys %$fields ]) }
470 my $next = $self->next::can;
472 return preserve_context {
473 $self->$next(@$args);
474 } after => sub { $guard->commit };
482 # Set the identity update flags for the actual update
483 local $self->{_autoinc_supplied_for_op} = grep
484 { $_->{is_auto_increment} }
485 values %{ $source->columns_info([ keys %$fields ]) }
488 return $self->next::method(@_);
494 my ($source, $cols, $data) = @_;
496 my $columns_info = $source->columns_info;
499 grep { $columns_info->{$_}{is_auto_increment} }
502 # FIXME - this is duplication from DBI.pm. When refactored towards
503 # the LobWriter this can be folded back where it belongs.
504 local $self->{_autoinc_supplied_for_op}
505 = grep { $_ eq $identity_col } @$cols;
508 $self->_bulk_storage &&
509 $self->_get_dbh->{syb_has_blk};
511 if (! $use_bulk_api and ref($self->_dbi_connect_info->[0]) eq 'CODE') {
512 carp_unique( join ' ',
513 'Bulk API support disabled due to use of a CODEREF connect_info.',
514 'Reverting to regular array inserts.',
518 if (not $use_bulk_api) {
519 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
521 # next::method uses a txn anyway, but it ends too early in case we need to
522 # select max(col) to get the identity for inserting blobs.
523 ($self, my $guard) = $self->transaction_depth
525 : ($self->_writer_storage, $self->_writer_storage->txn_scope_guard)
528 $self->next::method(@_);
531 if ($self->_autoinc_supplied_for_op) {
532 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
535 my @cols_with_identities = (@$cols, $identity_col);
537 ## calculate identities
538 # XXX This assumes identities always increase by 1, which may or may not
540 my ($last_identity) =
541 $self->_dbh->selectrow_array (
542 $self->_fetch_identity_sql($source, $identity_col)
544 my @identities = (($last_identity - @$data + 1) .. $last_identity);
546 my @data_with_identities = map [@$_, shift @identities], @$data;
548 $self->_insert_blobs_array (
549 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
554 $guard->commit if $guard;
559 # otherwise, use the bulk API
561 # rearrange @$data so that columns are in database order
562 # and so we submit a full column list
563 my %orig_order = map { $cols->[$_] => $_ } 0..$#$cols;
565 my @source_columns = $source->columns;
567 # bcp identity index is 1-based
568 my ($identity_idx) = grep { $source_columns[$_] eq $identity_col } (0..$#source_columns);
569 $identity_idx = defined $identity_idx ? $identity_idx + 1 : 0;
572 for my $slice_idx (0..$#$data) {
573 push @new_data, [map {
574 # identity data will be 'undef' if not _autoinc_supplied_for_op()
575 # columns with defaults will also be 'undef'
576 exists $orig_order{$_}
577 ? $data->[$slice_idx][$orig_order{$_}]
582 my $proto_bind = $self->_resolve_bindattrs(
585 [ { dbic_colname => $source_columns[$_], _bind_data_slice_idx => $_ }
586 => $new_data[0][$_] ]
587 } (0 ..$#source_columns) ],
591 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
592 # This ignores any data conversion errors detected by the client side libs, as
593 # they are usually harmless.
594 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
595 set_subname _insert_bulk_cslib_errhandler => sub {
596 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
598 return 1 if $errno == 36;
601 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
602 ($errmsg ? "\n$errmsg" : '') .
603 ($osmsg ? "\n$osmsg" : '') .
604 ($blkmsg ? "\n$blkmsg" : '');
611 my $bulk = $self->_bulk_storage;
613 my $guard = $bulk->txn_scope_guard;
615 ## FIXME - once this is done - address the FIXME on finish() below
616 ## XXX get this to work instead of our own $sth
617 ## will require SQLA or *Hacks changes for ordered columns
618 # $bulk->next::method($source, \@source_columns, \@new_data, {
619 # syb_bcp_attribs => {
620 # identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
621 # identity_column => $identity_idx,
624 my $sql = 'INSERT INTO ' .
625 $bulk->sql_maker->_quote($source->name) . ' (' .
626 # colname list is ignored for BCP, but does no harm
627 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
628 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
630 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
631 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
632 ## better yet the version above. Should be fixed in DBD::Sybase .
633 my $sth = $bulk->_get_dbh->prepare($sql,
637 identity_flag => $self->_autoinc_supplied_for_op ? 1 : 0,
638 identity_column => $identity_idx,
644 # FIXME the $sth->finish in _execute_array does a rollback for some
645 # reason. Disable it temporarily until we fix the SQLMaker thing above
646 no warnings 'redefine';
648 local *{ref($sth).'::finish'} = sub {};
650 $self->_dbh_execute_for_fetch(
651 $source, $sth, $proto_bind, \@source_columns, \@new_data
657 $bulk->_query_end($sql);
659 dbic_internal_catch {
663 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
665 if ($exception =~ /-Y option/) {
666 my $w = 'Sybase bulk API operation failed due to character set incompatibility, '
667 . 'reverting to regular array inserts. Try unsetting the LC_ALL environment variable'
669 $w .= "\n$exception" if $self->debug;
672 $self->_bulk_storage(undef);
677 # rollback makes the bulkLogin connection unusable
678 $self->_bulk_storage->disconnect;
679 $self->throw_exception($exception);
683 # Make sure blobs are not bound as placeholders, and return any non-empty ones
685 sub _remove_blob_cols {
686 my ($self, $source, $fields) = @_;
690 for my $col (keys %$fields) {
691 if ($self->_is_lob_column($source, $col)) {
692 my $blob_val = delete $fields->{$col};
693 if (not defined $blob_val) {
694 $fields->{$col} = \'NULL';
697 $fields->{$col} = \"''";
698 $blob_cols{$col} = $blob_val
704 return %blob_cols ? \%blob_cols : undef;
707 # same for _insert_bulk
708 sub _remove_blob_cols_array {
709 my ($self, $source, $cols, $data) = @_;
713 for my $i (0..$#$cols) {
714 my $col = $cols->[$i];
716 if ($self->_is_lob_column($source, $col)) {
717 for my $j (0..$#$data) {
718 my $blob_val = delete $data->[$j][$i];
719 if (not defined $blob_val) {
720 $data->[$j][$i] = \'NULL';
723 $data->[$j][$i] = \"''";
724 $blob_cols[$j][$i] = $blob_val
731 return @blob_cols ? \@blob_cols : undef;
735 my ($self, $source, $blob_cols, $where) = @_;
739 $source->_pri_cols_or_die
741 dbic_internal_catch {
742 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
750 ! grep { ! defined $where->{$_} } @primary_cols
753 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
754 @pks_to_update = \%row_to_update;
757 my $cursor = $self->select ($source, \@primary_cols, $where, {});
758 @pks_to_update = map {
759 my %row; @row{@primary_cols} = @$_; \%row
763 for my $ident (@pks_to_update) {
764 $self->_insert_blobs($source, $blob_cols, $ident);
769 my ($self, $source, $blob_cols, $row_data) = @_;
771 my $table = $source->name;
773 my @primary_cols = dbic_internal_try
774 { $source->_pri_cols_or_die }
775 dbic_internal_catch {
776 $self->throw_exception("Cannot update TEXT/IMAGE column(s): $_")
779 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
780 if grep { ! defined $row_data->{$_} } @primary_cols;
782 # if we are 2-phase inserting a blob - there is nothing to retrieve anymore,
783 # regardless of the previous state of the flag
784 local $self->{_perform_autoinc_retrieval}
785 if $self->_perform_autoinc_retrieval;
787 my %where = map {( $_ => $row_data->{$_} )} @primary_cols;
789 for my $col (keys %$blob_cols) {
790 my $blob = $blob_cols->{$col};
792 my $cursor = $self->select ($source, [$col], \%where, {});
794 my $sth = $cursor->sth;
797 $self->throw_exception(
798 "Could not find row in table '$table' for blob update:\n"
803 # FIXME - it is not clear if this is needed at all. But it's been
804 # there since 2009 ( d867eedaa ), might as well let sleeping dogs
806 weaken( my $wsth = $sth );
807 my $g = scope_guard { $wsth->finish if $wsth };
811 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
814 $sth->func('ct_prepare_send') or die $sth->errstr;
816 my $log_on_update = $self->_blob_log_on_update;
817 $log_on_update = 1 if not defined $log_on_update;
819 $sth->func('CS_SET', 1, {
820 total_txtlen => length($blob),
821 log_on_update => $log_on_update
822 }, 'ct_data_info') or die $sth->errstr;
824 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
826 $sth->func('ct_finish_send') or die $sth->errstr;
828 dbic_internal_catch {
829 if ($self->_using_freetds) {
830 $self->throw_exception (
831 "TEXT/IMAGE operation failed, probably because you are using FreeTDS: $_"
835 $self->throw_exception($_);
841 sub _insert_blobs_array {
842 my ($self, $source, $blob_cols, $cols, $data) = @_;
844 for my $i (0..$#$data) {
845 my $datum = $data->[$i];
848 @row{ @$cols } = @$datum;
851 for my $j (0..$#$cols) {
852 if (exists $blob_cols->[$i][$j]) {
853 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
857 $self->_insert_blobs ($source, \%blob_vals, \%row);
861 =head2 connect_call_datetime_setup
865 on_connect_call => 'datetime_setup'
867 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set:
869 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
870 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
872 This works for both C<DATETIME> and C<SMALLDATETIME> columns, note that
873 C<SMALLDATETIME> columns only have minute precision.
877 sub connect_call_datetime_setup {
879 my $dbh = $self->_get_dbh;
881 if ($dbh->can('syb_date_fmt')) {
882 # amazingly, this works with FreeTDS
883 $dbh->syb_date_fmt('ISO_strict');
887 'Your DBD::Sybase is too old to support '
888 .'DBIx::Class::InflateColumn::DateTime, please upgrade!';
890 # FIXME - in retrospect this is a rather bad US-centric choice
891 # of format. Not changing as a bugwards compat, though in reality
892 # the only piece that sees the results of $dt object formatting
893 # (as opposed to parsing) is the database itself, so theoretically
894 # changing both this SET command and the formatter definition of
895 # ::S::D::Sybase::ASE::DateTime::Format below should be safe and
898 $dbh->do('SET DATEFORMAT mdy');
903 sub _exec_txn_begin {
906 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
907 # TRAN once. However, we need to make sure there's a $dbh.
908 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
910 $self->next::method(@_);
912 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
915 # savepoint support using ASE syntax
917 sub _exec_svp_begin {
918 my ($self, $name) = @_;
920 $self->_dbh->do("SAVE TRANSACTION $name");
923 # A new SAVE TRANSACTION with the same name releases the previous one.
924 sub _exec_svp_release { 1 }
926 sub _exec_svp_rollback {
927 my ($self, $name) = @_;
929 $self->_dbh->do("ROLLBACK TRANSACTION $name");
932 package # hide from PAUSE
933 DBIx::Class::Storage::DBI::Sybase::ASE::DateTime::Format;
935 my $datetime_parse_format = '%Y-%m-%dT%H:%M:%S.%3NZ';
936 my $datetime_format_format = '%m/%d/%Y %H:%M:%S.%3N';
938 my ($datetime_parser, $datetime_formatter);
942 require DateTime::Format::Strptime;
943 $datetime_parser ||= DateTime::Format::Strptime->new(
944 pattern => $datetime_parse_format,
947 return $datetime_parser->parse_datetime(shift);
950 sub format_datetime {
952 require DateTime::Format::Strptime;
953 $datetime_formatter ||= DateTime::Format::Strptime->new(
954 pattern => $datetime_format_format,
957 return $datetime_formatter->format_datetime(shift);
962 =head1 Schema::Loader Support
964 As of version C<0.05000>, L<DBIx::Class::Schema::Loader> should work well with
965 most versions of Sybase ASE.
969 This driver supports L<DBD::Sybase> compiled against FreeTDS
970 (L<http://www.freetds.org/>) to the best of our ability, however it is
971 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
972 libraries. They are a part of the Sybase ASE distribution:
974 The Open Client FAQ is here:
975 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
977 Sybase ASE for Linux (which comes with the Open Client libraries) may be
978 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
980 To see if you're using FreeTDS run:
982 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
984 It is recommended to set C<tds version> for your ASE server to C<5.0> in
985 C</etc/freetds/freetds.conf>.
987 Some versions or configurations of the libraries involved will not support
988 placeholders, in which case the storage will be reblessed to
989 L<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars>.
991 In some configurations, placeholders will work but will throw implicit type
992 conversion errors for anything that's not expecting a string. In such a case,
993 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
994 automatically set, which you may enable on connection with
995 L<connect_call_set_auto_cast|DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>.
996 The type info for the C<CAST>s is taken from the
997 L<DBIx::Class::ResultSource/data_type> definitions in your Result classes, and
998 are mapped to a Sybase type (if it isn't already) using a mapping based on
1001 In other configurations, placeholders will work just as they do with the Sybase
1002 Open Client libraries.
1004 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
1006 =head1 INSERTS WITH PLACEHOLDERS
1008 With placeholders enabled, inserts are done in a transaction so that there are
1009 no concurrency issues with getting the inserted identity value using
1010 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
1013 In addition, they are done on a separate connection so that it's possible to
1014 have active cursors when doing an insert.
1016 When using C<DBIx::Class::Storage::DBI::Sybase::ASE::NoBindVars> transactions
1017 are unnecessary and not used, as there are no concurrency issues with C<SELECT
1018 @@IDENTITY> which is a session variable.
1022 Due to limitations of the TDS protocol and L<DBD::Sybase>, you cannot begin a
1023 transaction while there are active cursors, nor can you use multiple active
1024 cursors within a transaction. An active cursor is, for example, a
1025 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1026 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1028 For example, this will not work:
1030 $schema->txn_do(sub {
1031 my $rs = $schema->resultset('Book');
1032 while (my $result = $rs->next) {
1033 $schema->resultset('MetaData')->create({
1034 book_id => $result->id,
1042 my $first_row = $large_rs->first;
1043 $schema->txn_do(sub { ... });
1045 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1046 are not affected, as they are done on an extra database handle.
1052 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1054 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1056 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1060 =head1 MAXIMUM CONNECTIONS
1062 The TDS protocol makes separate connections to the server for active statements
1063 in the background. By default the number of such connections is limited to 25,
1064 on both the client side and the server side.
1066 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1067 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1068 can override it to whatever setting you like in the DSN.
1071 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1072 for information on changing the setting on the server side.
1076 See L</connect_call_datetime_setup> to setup date formats
1077 for L<DBIx::Class::InflateColumn::DateTime>.
1079 =head1 LIMITED QUERIES
1081 Because ASE does not have a good way to limit results in SQL that works for
1082 all types of queries, the limit dialect is set to
1083 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ>.
1085 Fortunately, ASE and L<DBD::Sybase> support cursors properly, so when
1086 L<GenericSubQ|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> is too slow
1087 you can use the L<software_limit|DBIx::Class::ResultSet/software_limit>
1088 L<DBIx::Class::ResultSet> attribute to simulate limited queries by skipping
1091 =head1 TEXT/IMAGE COLUMNS
1093 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1094 C<TEXT/IMAGE> columns.
1096 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1098 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1102 $schema->storage->set_textsize($bytes);
1106 However, the C<LongReadLen> you pass in
1107 L<connect_info|DBIx::Class::Storage::DBI/connect_info> is used to execute the
1108 equivalent C<SET TEXTSIZE> command on connection.
1110 See L</connect_call_blob_setup> for a
1111 L<connect_info|DBIx::Class::Storage::DBI/connect_info> setting you need to work
1112 with C<IMAGE> columns.
1116 The experimental L<DBD::Sybase> Bulk API support is used for
1117 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1118 on a separate connection.
1120 To use this feature effectively, use a large number of rows for each
1121 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1123 while (my $rows = $data_source->get_100_rows()) {
1124 $rs->populate($rows);
1127 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1128 calls in your C<Result> classes B<must> list columns in database order for this
1129 to work. Also, you may have to unset the C<LC_ALL> environment variable before
1130 loading your app, as C<BCP -Y> is not yet supported in DBD::Sybase .
1132 When inserting IMAGE columns using this method, you'll need to use
1133 L</connect_call_blob_setup> as well.
1135 =head1 COMPUTED COLUMNS
1137 If you have columns such as:
1139 created_dtm AS getdate()
1141 represent them in your Result classes as:
1145 default_value => \'getdate()',
1147 inflate_datetime => 1,
1150 The C<data_type> must exist and must be C<undef>. Then empty inserts will work
1151 on tables with such columns.
1153 =head1 TIMESTAMP COLUMNS
1155 C<timestamp> columns in Sybase ASE are not really timestamps, see:
1156 L<http://dba.fyicenter.com/Interview-Questions/SYBASE/The_timestamp_datatype_in_Sybase_.html>.
1158 They should be defined in your Result classes as:
1161 data_type => 'timestamp',
1163 inflate_datetime => 0,
1166 The C<<inflate_datetime => 0>> is necessary if you use
1167 L<DBIx::Class::InflateColumn::DateTime>, and most people do, and still want to
1168 be able to read these values.
1170 The values will come back as hexadecimal.
1178 Transitions to AutoCommit=0 (starting a transaction) mode by exhausting
1179 any active cursors, using eager cursors.
1183 Real limits and limited counts using stored procedures deployed on startup.
1187 Blob update with a LIKE query on a blob, without invalidating the WHERE condition.
1191 bulk_insert using prepare_cached (see comments.)
1195 =head1 FURTHER QUESTIONS?
1197 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
1199 =head1 COPYRIGHT AND LICENSE
1201 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
1202 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
1203 redistribute it and/or modify it under the same terms as the
1204 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.