1 package DBIx::Class::Storage::DBI::Sybase;
7 DBIx::Class::Storage::DBI::Sybase::Common
8 DBIx::Class::Storage::DBI::AutoCast
11 use Carp::Clan qw/^DBIx::Class/;
15 __PACKAGE__->mk_group_accessors('simple' =>
16 qw/_identity _blob_log_on_update _writer_storage _is_extra_storage
17 _bulk_storage _is_bulk_storage _began_bulk_work
18 _bulk_disabled_due_to_coderef_connect_info_warned
22 my @also_proxy_to_extra_storages = qw/
23 connect_call_set_auto_cast auto_cast connect_call_blob_setup
24 connect_call_datetime_setup
26 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
27 auto_savepoint unsafe cursor_class debug debugobj schema
32 DBIx::Class::Storage::DBI::Sybase - Sybase support for DBIx::Class
36 This subclass supports L<DBD::Sybase> for real Sybase databases. If you are
37 using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
38 L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
42 If your version of Sybase does not support placeholders, then your storage
43 will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
44 also enable that driver explicitly, see the documentation for more details.
46 With this driver there is unfortunately no way to get the C<last_insert_id>
47 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
48 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
50 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
52 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
61 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
63 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
68 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
70 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
71 bless $self, $subclass;
73 } else { # real Sybase
74 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
76 if ($self->using_freetds) {
77 carp <<'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 for more details.
91 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
94 if (not $self->_typeless_placeholders_supported) {
95 if ($self->_placeholders_supported) {
98 $self->ensure_class_loaded($no_bind_vars);
99 bless $self, $no_bind_vars;
104 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
105 # not necessarily FreeTDS, but no placeholders nevertheless
106 $self->ensure_class_loaded($no_bind_vars);
107 bless $self, $no_bind_vars;
109 } elsif (not $self->_typeless_placeholders_supported) {
110 # this is highly unlikely, but we check just in case
119 $self->_set_max_connect(256);
121 # based on LongReadLen in connect_info
122 $self->set_textsize if $self->using_freetds;
124 # create storage for insert/(update blob) transactions,
125 # unless this is that storage
126 return if $self->_is_extra_storage;
128 my $writer_storage = (ref $self)->new;
130 $writer_storage->_is_extra_storage(1);
131 $writer_storage->connect_info($self->connect_info);
132 $writer_storage->auto_cast($self->auto_cast);
134 $self->_writer_storage($writer_storage);
136 # create a bulk storage unless connect_info is a coderef
138 if (Scalar::Util::reftype($self->_dbi_connect_info->[0])||'') eq 'CODE';
140 my $bulk_storage = (ref $self)->new;
142 $bulk_storage->_is_extra_storage(1);
143 $bulk_storage->_is_bulk_storage(1); # for special ->disconnect acrobatics
144 $bulk_storage->connect_info($self->connect_info);
147 $bulk_storage->_dbi_connect_info->[0] .= ';bulkLogin=1';
149 $self->_bulk_storage($bulk_storage);
152 for my $method (@also_proxy_to_extra_storages) {
154 no warnings 'redefine';
156 my $replaced = __PACKAGE__->can($method);
158 *{$method} = Sub::Name::subname $method => sub {
160 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
161 $self->_bulk_storage->$replaced(@_) if $self->_bulk_storage;
162 return $self->$replaced(@_);
169 # Even though we call $sth->finish for uses off the bulk API, there's still an
170 # "active statement" warning on disconnect, which we throw away here.
171 # This is due to the bug described in insert_bulk.
172 # Currently a noop because 'prepare' is used instead of 'prepare_cached'.
173 local $SIG{__WARN__} = sub {
174 warn $_[0] unless $_[0] =~ /active statement/i;
175 } if $self->_is_bulk_storage;
177 # so that next transaction gets a dbh
178 $self->_began_bulk_work(0) if $self->_is_bulk_storage;
183 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
184 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
185 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
186 # only want when AutoCommit is off.
190 $self->next::method(@_);
192 if ($self->_is_bulk_storage) {
193 # this should be cleared on every reconnect
194 $self->_began_bulk_work(0);
198 if (not $self->using_freetds) {
199 $self->_dbh->{syb_chained_txn} = 1;
201 if ($self->_dbh_autocommit) {
202 $self->_dbh->do('SET CHAINED OFF');
204 $self->_dbh->do('SET CHAINED ON');
209 =head2 connect_call_blob_setup
213 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
215 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
216 instead of as a hex string.
220 Also sets the C<log_on_update> value for blob write operations. The default is
221 C<1>, but C<0> is better if your database is configured for it.
224 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
228 sub connect_call_blob_setup {
231 my $dbh = $self->_dbh;
232 $dbh->{syb_binary_images} = 1;
234 $self->_blob_log_on_update($args{log_on_update})
235 if exists $args{log_on_update};
241 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
245 my ($self, $source, $column) = @_;
247 return $self->_is_lob_type($source->column_info($column)->{data_type});
250 sub _prep_for_execute {
252 my ($op, $extra_bind, $ident, $args) = @_;
254 my ($sql, $bind) = $self->next::method (@_);
256 if ($op eq 'insert') {
257 my $table = $ident->from;
259 my $bind_info = $self->_resolve_column_info(
260 $ident, [map $_->[0], @{$bind}]
262 my $identity_col = List::Util::first
263 { $bind_info->{$_}{is_auto_increment} }
269 "SET IDENTITY_INSERT $table ON",
271 "SET IDENTITY_INSERT $table OFF",
275 $identity_col = List::Util::first
276 { $ident->column_info($_)->{is_auto_increment} }
284 $self->_fetch_identity_sql($ident, $identity_col);
288 return ($sql, $bind);
291 # Stolen from SQLT, with some modifications. This is a makeshift
292 # solution before a sane type-mapping library is available, thus
293 # the 'our' for easy overrides.
294 our %TYPE_MAPPING = (
297 varchar => 'varchar',
298 varchar2 => 'varchar',
299 timestamp => 'datetime',
301 real => 'double precision',
304 tinyint => 'smallint',
305 float => 'double precision',
307 bigserial => 'numeric',
308 boolean => 'varchar',
312 sub _native_data_type {
313 my ($self, $type) = @_;
316 $type =~ s/\s* identity//x;
318 return uc($TYPE_MAPPING{$type} || $type);
321 sub _fetch_identity_sql {
322 my ($self, $source, $col) = @_;
324 return sprintf ("SELECT MAX(%s) FROM %s",
325 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
333 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
335 if ($op eq 'insert') {
336 $self->_identity($sth->fetchrow_array);
340 return wantarray ? ($rv, $sth, @bind) : $rv;
343 sub last_insert_id { shift->_identity }
345 # handles TEXT/IMAGE and transaction for last_insert_id
348 my ($source, $to_insert) = @_;
350 my $identity_col = (List::Util::first
351 { $source->column_info($_)->{is_auto_increment} }
352 $source->columns) || '';
354 # check for empty insert
355 # INSERT INTO foo DEFAULT VALUES -- does not work with Sybase
356 # try to insert explicit 'DEFAULT's instead (except for identity)
357 if (not %$to_insert) {
358 for my $col ($source->columns) {
359 next if $col eq $identity_col;
360 $to_insert->{$col} = \'DEFAULT';
364 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
366 # do we need the horrific SELECT MAX(COL) hack?
367 my $dumb_last_insert_id =
369 && (not exists $to_insert->{$identity_col})
370 && ($self->_identity_method||'') ne '@@IDENTITY';
372 my $next = $self->next::can;
374 # we are already in a transaction, or there are no blobs
375 # and we don't need the PK - just (try to) do it
376 if ($self->{transaction_depth}
377 || (!$blob_cols && !$dumb_last_insert_id)
379 return $self->_insert (
380 $next, $source, $to_insert, $blob_cols, $identity_col
384 # otherwise use the _writer_storage to do the insert+transaction on another
386 my $guard = $self->_writer_storage->txn_scope_guard;
388 my $updated_cols = $self->_writer_storage->_insert (
389 $next, $source, $to_insert, $blob_cols, $identity_col
392 $self->_identity($self->_writer_storage->_identity);
396 return $updated_cols;
400 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
402 my $updated_cols = $self->$next ($source, $to_insert);
406 ($identity_col => $self->last_insert_id($source, $identity_col)) : ()),
411 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
413 return $updated_cols;
418 my ($source, $fields, $where, @rest) = @_;
420 my $wantarray = wantarray;
422 my $blob_cols = $self->_remove_blob_cols($source, $fields);
424 my $table = $source->name;
426 my $identity_col = List::Util::first
427 { $source->column_info($_)->{is_auto_increment} }
430 my $is_identity_update = $identity_col && defined $fields->{$identity_col};
432 if (not $blob_cols) {
433 $self->_set_session_identity(UPDATE => $table, 'ON')
434 if $is_identity_update;
436 return $self->next::method(@_);
438 $self->_set_session_identity(UPDATE => $table, 'OFF')
439 if $is_identity_update;
442 # If there are any blobs in $where, Sybase will return a descriptive error
445 # update+blob update(s) done atomically on separate connection
446 $self = $self->_writer_storage;
448 my $guard = $self->txn_scope_guard;
450 # First update the blob columns to be updated to '' (taken from $fields, where
451 # it is originally put by _remove_blob_cols .)
452 my %blobs_to_empty = map { ($_ => delete $fields->{$_}) } keys %$blob_cols;
454 $self->next::method($source, \%blobs_to_empty, $where, @rest);
456 # Now update the blobs before the other columns in case the update of other
457 # columns makes the search condition invalid.
458 $self->_update_blobs($source, $blob_cols, $where);
462 $self->_set_session_identity(UPDATE => $table, 'ON')
463 if $is_identity_update;
466 @res = $self->next::method(@_);
468 elsif (defined $wantarray) {
469 $res[0] = $self->next::method(@_);
472 $self->next::method(@_);
475 $self->_set_session_identity(UPDATE => $table, 'OFF')
476 if $is_identity_update;
481 return $wantarray ? @res : $res[0];
484 # for IDENTITY_INSERT / IDENTITY_UPDATE
485 sub _set_session_identity {
486 my ($self, $op, $table, $off_on) = @_;
489 'SET IDENTITY_%s %s %s',
491 $self->sql_maker->_quote($table),
495 $self->_query_start($sql);
497 my $dbh = $self->_get_dbh;
499 local $dbh->{RaiseError} = 1;
500 local $dbh->{PrintError} = 0;
505 $self->_query_end($sql);
508 $self->throw_exception (sprintf "Error executing '%s': %s",
517 my ($source, $cols, $data) = @_;
519 my $identity_col = List::Util::first
520 { $source->column_info($_)->{is_auto_increment} }
523 my $is_identity_insert = (List::Util::first
524 { $_ eq $identity_col }
528 my @source_columns = $source->columns;
531 $self->_bulk_storage &&
532 $self->_get_dbh->{syb_has_blk};
534 if ((not $use_bulk_api) &&
535 (Scalar::Util::reftype($self->_dbi_connect_info->[0])||'') eq 'CODE' &&
536 (not $self->_bulk_disabled_due_to_coderef_connect_info_warned)) {
538 Bulk API support disabled due to use of a CODEREF connect_info. Reverting to
539 regular array inserts.
541 $self->_bulk_disabled_due_to_coderef_connect_info_warned(1);
544 if (not $use_bulk_api) {
545 my $blob_cols = $self->_remove_blob_cols_array($source, $cols, $data);
547 ($self, my ($guard)) = do {
548 if ($self->{transaction_depth} == 0 && $blob_cols) {
549 ($self->_writer_storage, $self->_writer_storage->txn_scope_guard);
556 $self->next::method(@_);
559 if ($is_identity_insert) {
560 $self->_insert_blobs_array ($source, $blob_cols, $cols, $data);
563 my @cols_with_identities = (@$cols, $identity_col);
565 ## calculate identities
566 # XXX This assumes identities always increase by 1, which may or may not
568 my ($last_identity) =
569 $self->_dbh->selectrow_array (
570 $self->_fetch_identity_sql($source, $identity_col)
572 my @identities = (($last_identity - @$data + 1) .. $last_identity);
574 my @data_with_identities = map [@$_, shift @identities], @$data;
576 $self->_insert_blobs_array (
577 $source, $blob_cols, \@cols_with_identities, \@data_with_identities
582 $guard->commit if $guard;
586 # otherwise, use the bulk API
588 # rearrange @$data so that columns are in database order
590 @orig_idx{@$cols} = 0..$#$cols;
593 @new_idx{@source_columns} = 0..$#source_columns;
596 for my $datum (@$data) {
598 for my $col (@source_columns) {
599 # identity data will be 'undef' if not $is_identity_insert
600 # columns with defaults will also be 'undef'
601 $new_datum->[ $new_idx{$col} ] =
602 exists $orig_idx{$col} ? $datum->[ $orig_idx{$col} ] : undef;
604 push @new_data, $new_datum;
607 # bcp identity index is 1-based
608 my $identity_idx = exists $new_idx{$identity_col} ?
609 $new_idx{$identity_col} + 1 : 0;
611 ## Set a client-side conversion error handler, straight from DBD::Sybase docs.
612 # This ignores any data conversion errors detected by the client side libs, as
613 # they are usually harmless.
614 my $orig_cslib_cb = DBD::Sybase::set_cslib_cb(
615 Sub::Name::subname insert_bulk => sub {
616 my ($layer, $origin, $severity, $errno, $errmsg, $osmsg, $blkmsg) = @_;
618 return 1 if $errno == 36;
621 "Layer: $layer, Origin: $origin, Severity: $severity, Error: $errno" .
622 ($errmsg ? "\n$errmsg" : '') .
623 ($osmsg ? "\n$osmsg" : '') .
624 ($blkmsg ? "\n$blkmsg" : '');
630 my $bulk = $self->_bulk_storage;
632 my $guard = $bulk->txn_scope_guard;
634 ## XXX get this to work instead of our own $sth
635 ## will require SQLA or *Hacks changes for ordered columns
636 # $bulk->next::method($source, \@source_columns, \@new_data, {
637 # syb_bcp_attribs => {
638 # identity_flag => $is_identity_insert,
639 # identity_column => $identity_idx,
642 my $sql = 'INSERT INTO ' .
643 $bulk->sql_maker->_quote($source->name) . ' (' .
644 # colname list is ignored for BCP, but does no harm
645 (join ', ', map $bulk->sql_maker->_quote($_), @source_columns) . ') '.
646 ' VALUES ('. (join ', ', ('?') x @source_columns) . ')';
648 ## XXX there's a bug in the DBD::Sybase bulk support that makes $sth->finish for
649 ## a prepare_cached statement ineffective. Replace with ->sth when fixed, or
650 ## better yet the version above. Should be fixed in DBD::Sybase .
651 my $sth = $bulk->_get_dbh->prepare($sql,
655 identity_flag => $is_identity_insert,
656 identity_column => $identity_idx,
663 map [ $_, $idx++ ], @source_columns;
666 $self->_execute_array(
667 $source, $sth, \@bind, \@source_columns, \@new_data, $guard
670 $bulk->_query_end($sql);
673 if ($exception =~ /-Y option/) {
676 Sybase bulk API operation failed due to character set incompatibility, reverting
677 to regular array inserts:
679 *** Try unsetting the LANG environment variable.
683 $self->_bulk_storage(undef);
684 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
689 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
690 # rollback makes the bulkLogin connection unusable
691 $self->_bulk_storage->disconnect;
692 $self->throw_exception($exception);
695 DBD::Sybase::set_cslib_cb($orig_cslib_cb);
698 # Make sure blobs are not bound as placeholders, and return any non-empty ones
700 sub _remove_blob_cols {
701 my ($self, $source, $fields) = @_;
705 for my $col (keys %$fields) {
706 if ($self->_is_lob_column($source, $col)) {
707 my $blob_val = delete $fields->{$col};
708 if (not defined $blob_val) {
709 $fields->{$col} = \'NULL';
712 $fields->{$col} = \"''";
713 $blob_cols{$col} = $blob_val unless $blob_val eq '';
718 return keys %blob_cols ? \%blob_cols : undef;
721 # same for insert_bulk
722 sub _remove_blob_cols_array {
723 my ($self, $source, $cols, $data) = @_;
727 for my $i (0..$#$cols) {
728 my $col = $cols->[$i];
730 if ($self->_is_lob_column($source, $col)) {
731 for my $j (0..$#$data) {
732 my $blob_val = delete $data->[$j][$i];
733 if (not defined $blob_val) {
734 $data->[$j][$i] = \'NULL';
737 $data->[$j][$i] = \"''";
738 $blob_cols[$j][$i] = $blob_val
739 unless $blob_val eq '';
745 return @blob_cols ? \@blob_cols : undef;
749 my ($self, $source, $blob_cols, $where) = @_;
751 my (@primary_cols) = $source->primary_columns;
753 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
754 unless @primary_cols;
756 # check if we're updating a single row by PK
757 my $pk_cols_in_where = 0;
758 for my $col (@primary_cols) {
759 $pk_cols_in_where++ if defined $where->{$col};
763 if ($pk_cols_in_where == @primary_cols) {
765 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
766 @rows = \%row_to_update;
768 my $cursor = $self->select ($source, \@primary_cols, $where, {});
770 my %row; @row{@primary_cols} = @$_; \%row
774 for my $row (@rows) {
775 $self->_insert_blobs($source, $blob_cols, $row);
780 my ($self, $source, $blob_cols, $row) = @_;
781 my $dbh = $self->_get_dbh;
783 my $table = $source->name;
786 my (@primary_cols) = $source->primary_columns;
788 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
789 unless @primary_cols;
791 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
792 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
794 for my $col (keys %$blob_cols) {
795 my $blob = $blob_cols->{$col};
797 my %where = map { ($_, $row{$_}) } @primary_cols;
799 my $cursor = $self->select ($source, [$col], \%where, {});
801 my $sth = $cursor->sth;
805 $self->throw_exception(
806 "Could not find row in table '$table' for blob update:\n"
807 . $self->_pretty_print (\%where)
813 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
816 $sth->func('ct_prepare_send') or die $sth->errstr;
818 my $log_on_update = $self->_blob_log_on_update;
819 $log_on_update = 1 if not defined $log_on_update;
821 $sth->func('CS_SET', 1, {
822 total_txtlen => length($blob),
823 log_on_update => $log_on_update
824 }, 'ct_data_info') or die $sth->errstr;
826 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
828 $sth->func('ct_finish_send') or die $sth->errstr;
831 $sth->finish if $sth;
833 if ($self->using_freetds) {
834 $self->throw_exception (
835 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
839 $self->throw_exception($exception);
845 sub _insert_blobs_array {
846 my ($self, $source, $blob_cols, $cols, $data) = @_;
848 for my $i (0..$#$data) {
849 my $datum = $data->[$i];
852 @row{ @$cols } = @$datum;
855 for my $j (0..$#$cols) {
856 if (exists $blob_cols->[$i][$j]) {
857 $blob_vals{ $cols->[$j] } = $blob_cols->[$i][$j];
861 $self->_insert_blobs ($source, \%blob_vals, \%row);
865 =head2 connect_call_datetime_setup
869 on_connect_call => 'datetime_setup'
871 In L<DBIx::Class::Storage::DBI/connect_info> to set:
873 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
874 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
876 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
877 L<DateTime::Format::Sybase>, which you will need to install.
879 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
880 C<SMALLDATETIME> columns only have minute precision.
885 my $old_dbd_warned = 0;
887 sub connect_call_datetime_setup {
889 my $dbh = $self->_dbh;
891 if ($dbh->can('syb_date_fmt')) {
892 # amazingly, this works with FreeTDS
893 $dbh->syb_date_fmt('ISO_strict');
894 } elsif (not $old_dbd_warned) {
895 carp "Your DBD::Sybase is too old to support ".
896 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
900 $dbh->do('SET DATEFORMAT mdy');
906 sub datetime_parser_type { "DateTime::Format::Sybase" }
908 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
909 # let the DBD keep any state it needs to.
911 # If they ever do start working, the extra statements will do no harm (because
912 # Sybase supports nested transactions.)
914 sub _dbh_begin_work {
917 # bulkLogin=1 connections are always in a transaction, and can only call BEGIN
918 # TRAN once. However, we need to make sure there's a $dbh.
919 return if $self->_is_bulk_storage && $self->_dbh && $self->_began_bulk_work;
921 $self->next::method(@_);
923 if ($self->using_freetds) {
924 $self->_get_dbh->do('BEGIN TRAN');
927 $self->_began_bulk_work(1) if $self->_is_bulk_storage;
932 if ($self->using_freetds) {
933 $self->_dbh->do('COMMIT');
935 return $self->next::method(@_);
940 if ($self->using_freetds) {
941 $self->_dbh->do('ROLLBACK');
943 return $self->next::method(@_);
946 # savepoint support using ASE syntax
949 my ($self, $name) = @_;
951 $self->_get_dbh->do("SAVE TRANSACTION $name");
954 # A new SAVE TRANSACTION with the same name releases the previous one.
955 sub _svp_release { 1 }
958 my ($self, $name) = @_;
960 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
965 =head1 Schema::Loader Support
967 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
968 allow you to dump a schema from most (if not all) versions of Sybase.
970 It is available via subversion from:
972 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
976 This driver supports L<DBD::Sybase> compiled against FreeTDS
977 (L<http://www.freetds.org/>) to the best of our ability, however it is
978 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
979 libraries. They are a part of the Sybase ASE distribution:
981 The Open Client FAQ is here:
982 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
984 Sybase ASE for Linux (which comes with the Open Client libraries) may be
985 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
987 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
989 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
991 Some versions of the libraries involved will not support placeholders, in which
992 case the storage will be reblessed to
993 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
995 In some configurations, placeholders will work but will throw implicit type
996 conversion errors for anything that's not expecting a string. In such a case,
997 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
998 automatically set, which you may enable on connection with
999 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
1000 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
1001 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
1002 already) using a mapping based on L<SQL::Translator>.
1004 In other configurations, placeholers will work just as they do with the Sybase
1005 Open Client libraries.
1007 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
1009 =head1 INSERTS WITH PLACEHOLDERS
1011 With placeholders enabled, inserts are done in a transaction so that there are
1012 no concurrency issues with getting the inserted identity value using
1013 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
1016 In addition, they are done on a separate connection so that it's possible to
1017 have active cursors when doing an insert.
1019 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
1020 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
1025 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
1026 begin a transaction while there are active cursors; nor can you use multiple
1027 active cursors within a transaction. An active cursor is, for example, a
1028 L<ResultSet|DBIx::Class::ResultSet> that has been executed using C<next> or
1029 C<first> but has not been exhausted or L<reset|DBIx::Class::ResultSet/reset>.
1031 For example, this will not work:
1033 $schema->txn_do(sub {
1034 my $rs = $schema->resultset('Book');
1035 while (my $row = $rs->next) {
1036 $schema->resultset('MetaData')->create({
1037 book_id => $row->id,
1045 my $first_row = $large_rs->first;
1046 $schema->txn_do(sub { ... });
1048 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
1049 are not affected, as they are done on an extra database handle.
1055 =item * use L<DBIx::Class::Storage::DBI::Replicated>
1057 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
1059 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
1063 =head1 MAXIMUM CONNECTIONS
1065 The TDS protocol makes separate connections to the server for active statements
1066 in the background. By default the number of such connections is limited to 25,
1067 on both the client side and the server side.
1069 This is a bit too low for a complex L<DBIx::Class> application, so on connection
1070 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
1071 can override it to whatever setting you like in the DSN.
1074 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
1075 for information on changing the setting on the server side.
1079 See L</connect_call_datetime_setup> to setup date formats
1080 for L<DBIx::Class::InflateColumn::DateTime>.
1082 =head1 TEXT/IMAGE COLUMNS
1084 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
1085 C<TEXT/IMAGE> columns.
1087 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
1089 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
1093 $schema->storage->set_textsize($bytes);
1097 However, the C<LongReadLen> you pass in
1098 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
1099 C<SET TEXTSIZE> command on connection.
1101 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
1102 setting you need to work with C<IMAGE> columns.
1106 The experimental L<DBD::Sybase> Bulk API support is used for
1107 L<populate|DBIx::Class::ResultSet/populate> in B<void> context, in a transaction
1108 on a separate connection.
1110 To use this feature effectively, use a large number of rows for each
1111 L<populate|DBIx::Class::ResultSet/populate> call, eg.:
1113 while (my $rows = $data_source->get_100_rows()) {
1114 $rs->populate($rows);
1117 B<NOTE:> the L<add_columns|DBIx::Class::ResultSource/add_columns>
1118 calls in your C<Result> classes B<must> list columns in database order for this
1119 to work. Also, you may have to unset the C<LANG> environment variable before
1120 loading your app, if it doesn't match the character set of your database.
1122 When inserting IMAGE columns using this method, you'll need to use
1123 L</connect_call_blob_setup> as well.
1127 See L<DBIx::Class/CONTRIBUTORS>.
1131 You may distribute this code under the same terms as Perl itself.