1 package DBIx::Class::Storage::DBI::Sybase;
7 DBIx::Class::Storage::DBI::Sybase::Common
10 use Carp::Clan qw/^DBIx::Class/;
13 __PACKAGE__->mk_group_accessors('simple' =>
14 qw/_identity _blob_log_on_update auto_cast insert_txn/
19 DBIx::Class::Storage::DBI::Sybase - Sybase support for DBIx::Class
23 This subclass supports L<DBD::Sybase> for real Sybase databases. If you are
24 using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
25 L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
29 If your version of Sybase does not support placeholders, then your storage
30 will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
31 also enable that driver explicitly, see the documentation for more details.
33 With this driver there is unfortunately no way to get the C<last_insert_id>
34 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
35 (locking the table.) The transaction can be turned off if concurrency is not an
36 issue, see L<DBIx::Class::Storage::DBI::Sybase/connect_call_unsafe_insert>.
38 But your queries will be cached.
40 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
42 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
51 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
53 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
58 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
60 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
61 bless $self, $subclass;
63 } else { # real Sybase
64 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
66 # This is reset to 0 in ::NoBindVars, only necessary because we use max(col) to
70 if ($self->using_freetds) {
71 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
73 You are using FreeTDS with Sybase.
75 We will do our best to support this configuration, but please consider this
78 TEXT/IMAGE columns will definitely not work.
80 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
83 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
85 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
88 if (not $self->_typeless_placeholders_supported) {
89 if ($self->_placeholders_supported) {
92 $self->ensure_class_loaded($no_bind_vars);
93 bless $self, $no_bind_vars;
98 $self->set_textsize; # based on LongReadLen in connect_info
100 } elsif (not $self->dbh->{syb_dynamic_supported}) {
101 # not necessarily FreeTDS, but no placeholders nevertheless
102 $self->ensure_class_loaded($no_bind_vars);
103 bless $self, $no_bind_vars;
105 } elsif (not $self->_typeless_placeholders_supported) {
106 # this is highly unlikely, but we check just in case
110 $self->_set_max_connect(256);
115 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
116 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
117 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
118 # only want when AutoCommit is off.
122 $self->next::method(@_);
124 if (not $self->using_freetds) {
125 $self->_dbh->{syb_chained_txn} = 1;
127 if ($self->_dbh_autocommit) {
128 $self->_dbh->do('SET CHAINED OFF');
130 $self->_dbh->do('SET CHAINED ON');
135 =head2 connect_call_blob_setup
139 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
141 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
142 instead of as a hex string.
146 Also sets the C<log_on_update> value for blob write operations. The default is
147 C<1>, but C<0> is better if your database is configured for it.
150 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
154 sub connect_call_blob_setup {
157 my $dbh = $self->_dbh;
158 $dbh->{syb_binary_images} = 1;
160 $self->_blob_log_on_update($args{log_on_update})
161 if exists $args{log_on_update};
164 =head2 connect_call_set_auto_cast
166 In some configurations (usually with L</FreeTDS>) statements with values bound
167 to columns or conditions that are not strings will throw implicit type
168 conversion errors. For L</FreeTDS> this is automatically detected, and this
171 It converts placeholders to:
175 the type is taken from the L<DBIx::Class::ResultSource/data_type> setting from
176 your Result class, and mapped to a Sybase type using a mapping based on
177 L<SQL::Translator> if necessary.
179 This setting can also be set outside of
180 L<DBIx::Class::Storage::DBI/connect_info> at any time using:
182 $schema->storage->auto_cast(1);
186 sub connect_call_set_auto_cast {
191 =head2 connect_call_unsafe_insert
193 With placeholders enabled, inserts are done in a transaction so that there are
194 no concurrency issues with getting the inserted identity value using
195 C<SELECT MAX(col)> when placeholders are enabled.
197 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
200 To turn off transactions for inserts (for an application that doesn't need
201 concurrency, or a loader, for example) use this setting in
202 L<DBIx::Class::Storage::DBI/connect_info>,
204 on_connect_call => ['unsafe_insert']
206 To manipulate this setting at runtime, use:
208 $schema->storage->insert_txn(0); # 1 to re-enable
212 sub connect_call_unsafe_insert {
214 $self->insert_txn(0);
220 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
223 # The select-piggybacking-on-insert trick stolen from odbc/mssql
224 sub _prep_for_execute {
226 my ($op, $extra_bind, $ident, $args) = @_;
228 my ($sql, $bind) = $self->next::method (@_);
230 # Some combinations of FreeTDS and Sybase throw implicit conversion errors for
231 # all placeeholders, so we convert them into CASTs here.
232 # Based on code in ::DBI::NoBindVars .
234 # If we're using ::NoBindVars, there are no binds by this point so this code
236 if ($self->auto_cast && @$bind) {
238 my @sql_part = split /\?/, $sql;
239 my $col_info = $self->_resolve_column_info($ident,[ map $_->[0], @$bind ]);
241 foreach my $bound (@$bind) {
242 my $col = $bound->[0];
243 my $syb_type = $self->_syb_base_type($col_info->{$col}{data_type});
245 foreach my $data (@{$bound}[1..$#$bound]) {
246 $new_sql .= shift(@sql_part) .
247 ($syb_type ? "CAST(? AS $syb_type)" : '?');
250 $new_sql .= join '', @sql_part;
254 if ($op eq 'insert') {
255 my $table = $ident->from;
257 my $bind_info = $self->_resolve_column_info(
258 $ident, [map $_->[0], @{$bind}]
261 List::Util::first { $bind_info->{$_}{is_auto_increment} } (keys %$bind_info);
265 "SET IDENTITY_INSERT $table ON\n" .
267 "SET IDENTITY_INSERT $table OFF"
269 $identity_col = List::Util::first {
270 $ident->column_info($_)->{is_auto_increment}
277 $self->_fetch_identity_sql($ident, $identity_col);
281 return ($sql, $bind);
284 # Stolen from SQLT, with some modifications. This will likely change when the
285 # SQLT Sybase stuff is redone/fixed-up.
289 varchar => 'varchar',
290 varchar2 => 'varchar',
291 timestamp => 'datetime',
293 real => 'double precision',
296 tinyint => 'smallint',
297 float => 'double precision',
299 bigserial => 'numeric',
300 boolean => 'varchar',
305 my ($self, $type) = @_;
308 $type =~ s/ identity//;
310 return uc($TYPE_MAPPING{$type} || $type);
313 sub _fetch_identity_sql {
314 my ($self, $source, $col) = @_;
316 return "SELECT MAX($col) FROM ".$source->from;
323 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
325 if ($op eq 'insert') {
326 $self->_identity($sth->fetchrow_array);
330 return wantarray ? ($rv, $sth, @bind) : $rv;
333 sub last_insert_id { shift->_identity }
335 # override to handle TEXT/IMAGE and to do a transaction if necessary
337 my ($self, $source, $to_insert) = splice @_, 0, 3;
338 my $dbh = $self->_dbh;
340 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
342 my $need_last_insert_id = 0;
346 grep $_->[1]{is_auto_increment},
347 map [ $_, $source->column_info($_) ],
350 $need_last_insert_id = 1
351 if $identity_col && (not exists $to_insert->{$identity_col});
353 # We have to do the insert in a transaction to avoid race conditions with the
354 # SELECT MAX(COL) identity method used when placeholders are enabled.
355 my $updated_cols = do {
356 if ($need_last_insert_id && $self->insert_txn &&
357 (not $self->{transaction_depth})) {
359 my $method = $self->next::can;
361 sub { $self->$method($source, $to_insert, @$args) }
364 $self->next::method($source, $to_insert, @_);
368 $self->_insert_blobs($source, $blob_cols, $to_insert) if %$blob_cols;
370 return $updated_cols;
374 my ($self, $source) = splice @_, 0, 2;
375 my ($fields, $where) = @_;
376 my $wantarray = wantarray;
378 my $blob_cols = $self->_remove_blob_cols($source, $fields);
382 @res = $self->next::method($source, @_);
384 $res[0] = $self->next::method($source, @_);
387 $self->_update_blobs($source, $blob_cols, $where) if %$blob_cols;
389 return $wantarray ? @res : $res[0];
392 sub _remove_blob_cols {
393 my ($self, $source, $fields) = @_;
397 for my $col (keys %$fields) {
398 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
399 $blob_cols{$col} = delete $fields->{$col};
400 $fields->{$col} = \"''";
408 my ($self, $source, $blob_cols, $where) = @_;
410 my (@primary_cols) = $source->primary_columns;
412 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
413 unless @primary_cols;
415 # check if we're updating a single row by PK
416 my $pk_cols_in_where = 0;
417 for my $col (@primary_cols) {
418 $pk_cols_in_where++ if defined $where->{$col};
422 if ($pk_cols_in_where == @primary_cols) {
424 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
425 @rows = \%row_to_update;
427 my $rs = $source->resultset->search(
430 result_class => 'DBIx::Class::ResultClass::HashRefInflator',
431 select => \@primary_cols
434 @rows = $rs->all; # statement must finish
437 for my $row (@rows) {
438 $self->_insert_blobs($source, $blob_cols, $row);
443 my ($self, $source, $blob_cols, $row) = @_;
444 my $dbh = $self->dbh;
446 my $table = $source->from;
449 my (@primary_cols) = $source->primary_columns;
451 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
452 unless @primary_cols;
454 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
455 if (@primary_cols == 1) {
456 my $col = $primary_cols[0];
457 $row{$col} = $self->last_insert_id($source, $col);
459 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
463 for my $col (keys %$blob_cols) {
464 my $blob = $blob_cols->{$col};
466 my %where = map { ($_, $row{$_}) } @primary_cols;
467 my $cursor = $source->resultset->search(\%where, {
471 my $sth = $cursor->sth;
475 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
478 $sth->func('ct_prepare_send') or die $sth->errstr;
480 my $log_on_update = $self->_blob_log_on_update;
481 $log_on_update = 1 if not defined $log_on_update;
483 $sth->func('CS_SET', 1, {
484 total_txtlen => length($blob),
485 log_on_update => $log_on_update
486 }, 'ct_data_info') or die $sth->errstr;
488 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
490 $sth->func('ct_finish_send') or die $sth->errstr;
493 $sth->finish if $sth;
495 if ($self->using_freetds) {
497 "TEXT/IMAGE operation failed, probably because you're using FreeTDS: " .
506 =head2 connect_call_datetime_setup
510 on_connect_call => 'datetime_setup'
512 In L<DBIx::Class::Storage::DBI/connect_info> to set:
514 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
515 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
517 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
518 L<DateTime::Format::Sybase>, which you will need to install.
520 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
521 C<SMALLDATETIME> columns only have minute precision.
526 my $old_dbd_warned = 0;
528 sub connect_call_datetime_setup {
530 my $dbh = $self->_dbh;
532 if ($dbh->can('syb_date_fmt')) {
533 # amazingly, this works with FreeTDS
534 $dbh->syb_date_fmt('ISO_strict');
535 } elsif (not $old_dbd_warned) {
536 carp "Your DBD::Sybase is too old to support ".
537 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
541 $dbh->do('SET DATEFORMAT mdy');
547 sub datetime_parser_type { "DateTime::Format::Sybase" }
549 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
550 # let the DBD keep any state it needs to.
552 # If they ever do start working, the extra statements will do no harm (because
553 # Sybase supports nested transactions.)
555 sub _dbh_begin_work {
557 $self->next::method(@_);
558 if ($self->using_freetds) {
559 $self->dbh->do('BEGIN TRAN');
565 if ($self->using_freetds) {
566 $self->_dbh->do('COMMIT');
568 return $self->next::method(@_);
573 if ($self->using_freetds) {
574 $self->_dbh->do('ROLLBACK');
576 return $self->next::method(@_);
579 # savepoint support using ASE syntax
582 my ($self, $name) = @_;
584 $self->dbh->do("SAVE TRANSACTION $name");
587 # A new SAVE TRANSACTION with the same name releases the previous one.
588 sub _svp_release { 1 }
591 my ($self, $name) = @_;
593 $self->dbh->do("ROLLBACK TRANSACTION $name");
598 =head1 Schema::Loader Support
600 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
601 allow you to dump a schema from most (if not all) versions of Sybase.
603 It is available via subversion from:
605 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/mssql_tweaks
609 This driver supports L<DBD::Sybase> compiled against FreeTDS
610 (L<http://www.freetds.org/>) to the best of our ability, however it is
611 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
612 libraries. They are a part of the Sybase ASE distribution:
614 The Open Client FAQ is here:
615 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
617 Sybase ASE for Linux (which comes with the Open Client libraries) may be
618 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
620 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
622 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
624 Some versions of the libraries involved will not support placeholders, in which
625 case the storage will be reblessed to
626 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
628 In some configurations, placeholders will work but will throw implicit
629 conversion errors for anything that's not expecting a string. In such a case,
630 the C<auto_cast> option is automatically set, which you may enable yourself with
631 L</connect_call_set_auto_cast> (see the description of that method for more
634 In other configurations, placeholers will work just as they do with the Sybase
635 Open Client libraries.
637 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
639 =head1 MAXIMUM CONNECTIONS
641 The TDS protocol makes separate connections to the server for active statements
642 in the background. By default the number of such connections is limited to 25,
643 on both the client side and the server side.
645 This is a bit too low for a complex L<DBIx::Class> application, so on connection
646 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
647 can override it to whatever setting you like in the DSN.
650 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
651 for information on changing the setting on the server side.
655 See L</connect_call_datetime_setup> to setup date formats
656 for L<DBIx::Class::InflateColumn::DateTime>.
658 =head1 TEXT/IMAGE COLUMNS
660 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
661 C<TEXT/IMAGE> columns.
663 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
665 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
669 $schema->storage->set_textsize($bytes);
673 However, the C<LongReadLen> you pass in
674 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
675 C<SET TEXTSIZE> command on connection.
677 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
678 setting you need to work with C<IMAGE> columns.
682 See L<DBIx::Class/CONTRIBUTORS>.
686 You may distribute this code under the same terms as Perl itself.