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/;
14 __PACKAGE__->mk_group_accessors('simple' =>
15 qw/_identity _blob_log_on_update insert_txn/
20 DBIx::Class::Storage::DBI::Sybase - Sybase support for DBIx::Class
24 This subclass supports L<DBD::Sybase> for real Sybase databases. If you are
25 using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
26 L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
30 If your version of Sybase does not support placeholders, then your storage
31 will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
32 also enable that driver explicitly, see the documentation for more details.
34 With this driver there is unfortunately no way to get the C<last_insert_id>
35 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
36 (locking the table.) The transaction can be turned off if concurrency is not an
37 issue, see L<DBIx::Class::Storage::DBI::Sybase/connect_call_unsafe_insert>.
39 But your queries will be cached.
41 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
43 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
52 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
54 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
59 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
61 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
62 bless $self, $subclass;
64 } else { # real Sybase
65 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
67 # This is reset to 0 in ::NoBindVars, only necessary because we use max(col) to
71 if ($self->using_freetds) {
72 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
74 You are using FreeTDS with Sybase.
76 We will do our best to support this configuration, but please consider this
79 TEXT/IMAGE columns will definitely not work.
81 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
84 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
86 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
89 if (not $self->_typeless_placeholders_supported) {
90 if ($self->_placeholders_supported) {
93 $self->ensure_class_loaded($no_bind_vars);
94 bless $self, $no_bind_vars;
99 $self->set_textsize; # based on LongReadLen in connect_info
101 } elsif (not $self->dbh->{syb_dynamic_supported}) {
102 # not necessarily FreeTDS, but no placeholders nevertheless
103 $self->ensure_class_loaded($no_bind_vars);
104 bless $self, $no_bind_vars;
106 } elsif (not $self->_typeless_placeholders_supported) {
107 # this is highly unlikely, but we check just in case
111 $self->_set_max_connect(256);
116 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
117 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
118 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
119 # only want when AutoCommit is off.
123 $self->next::method(@_);
125 if (not $self->using_freetds) {
126 $self->_dbh->{syb_chained_txn} = 1;
128 if ($self->_dbh_autocommit) {
129 $self->_dbh->do('SET CHAINED OFF');
131 $self->_dbh->do('SET CHAINED ON');
136 =head2 connect_call_blob_setup
140 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
142 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
143 instead of as a hex string.
147 Also sets the C<log_on_update> value for blob write operations. The default is
148 C<1>, but C<0> is better if your database is configured for it.
151 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
155 sub connect_call_blob_setup {
158 my $dbh = $self->_dbh;
159 $dbh->{syb_binary_images} = 1;
161 $self->_blob_log_on_update($args{log_on_update})
162 if exists $args{log_on_update};
165 =head2 connect_call_unsafe_insert
167 With placeholders enabled, inserts are done in a transaction so that there are
168 no concurrency issues with getting the inserted identity value using
169 C<SELECT MAX(col)> when placeholders are enabled.
171 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
174 To turn off transactions for inserts (for an application that doesn't need
175 concurrency, or a loader, for example) use this setting in
176 L<DBIx::Class::Storage::DBI/connect_info>,
178 on_connect_call => ['unsafe_insert']
180 To manipulate this setting at runtime, use:
182 $schema->storage->insert_txn(0); # 1 to re-enable
186 sub connect_call_unsafe_insert {
188 $self->insert_txn(0);
194 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
197 # The select-piggybacking-on-insert trick stolen from mssql
198 sub _prep_for_execute {
200 my ($op, $extra_bind, $ident, $args) = @_;
202 my ($sql, $bind) = $self->next::method (@_);
204 if ($op eq 'insert') {
205 my $table = $ident->from;
207 my $bind_info = $self->_resolve_column_info(
208 $ident, [map $_->[0], @{$bind}]
211 List::Util::first { $bind_info->{$_}{is_auto_increment} } (keys %$bind_info);
215 "SET IDENTITY_INSERT $table ON\n" .
217 "SET IDENTITY_INSERT $table OFF"
219 $identity_col = List::Util::first {
220 $ident->column_info($_)->{is_auto_increment}
227 $self->_fetch_identity_sql($ident, $identity_col);
231 return ($sql, $bind);
234 # Stolen from SQLT, with some modifications. This will likely change when the
235 # SQLT Sybase stuff is redone/fixed-up.
239 varchar => 'varchar',
240 varchar2 => 'varchar',
241 timestamp => 'datetime',
243 real => 'double precision',
246 tinyint => 'smallint',
247 float => 'double precision',
249 bigserial => 'numeric',
250 boolean => 'varchar',
254 sub _native_data_type {
255 my ($self, $type) = @_;
258 $type =~ s/ identity//;
260 return uc($TYPE_MAPPING{$type} || $type);
263 sub _fetch_identity_sql {
264 my ($self, $source, $col) = @_;
266 return "SELECT MAX($col) FROM ".$source->from;
273 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
275 if ($op eq 'insert') {
276 $self->_identity($sth->fetchrow_array);
280 return wantarray ? ($rv, $sth, @bind) : $rv;
283 sub last_insert_id { shift->_identity }
285 # override to handle TEXT/IMAGE and to do a transaction if necessary
287 my ($self, $source, $to_insert) = splice @_, 0, 3;
288 my $dbh = $self->_dbh;
290 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
292 my $need_last_insert_id = 0;
296 grep $_->[1]{is_auto_increment},
297 map [ $_, $source->column_info($_) ],
300 $need_last_insert_id = 1
301 if $identity_col && (not exists $to_insert->{$identity_col});
303 # We have to do the insert in a transaction to avoid race conditions with the
304 # SELECT MAX(COL) identity method used when placeholders are enabled.
305 my $updated_cols = do {
306 if ($need_last_insert_id && $self->insert_txn &&
307 (not $self->{transaction_depth})) {
309 my $method = $self->next::can;
311 sub { $self->$method($source, $to_insert, @$args) }
314 $self->next::method($source, $to_insert, @_);
318 $self->_insert_blobs($source, $blob_cols, $to_insert) if %$blob_cols;
320 return $updated_cols;
324 my ($self, $source) = splice @_, 0, 2;
325 my ($fields, $where) = @_;
326 my $wantarray = wantarray;
328 my $blob_cols = $self->_remove_blob_cols($source, $fields);
332 @res = $self->next::method($source, @_);
334 $res[0] = $self->next::method($source, @_);
337 $self->_update_blobs($source, $blob_cols, $where) if %$blob_cols;
339 return $wantarray ? @res : $res[0];
342 sub _remove_blob_cols {
343 my ($self, $source, $fields) = @_;
347 for my $col (keys %$fields) {
348 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
349 $blob_cols{$col} = delete $fields->{$col};
350 $fields->{$col} = \"''";
358 my ($self, $source, $blob_cols, $where) = @_;
360 my (@primary_cols) = $source->primary_columns;
362 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
363 unless @primary_cols;
365 # check if we're updating a single row by PK
366 my $pk_cols_in_where = 0;
367 for my $col (@primary_cols) {
368 $pk_cols_in_where++ if defined $where->{$col};
372 if ($pk_cols_in_where == @primary_cols) {
374 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
375 @rows = \%row_to_update;
377 my $rs = $source->resultset->search(
380 result_class => 'DBIx::Class::ResultClass::HashRefInflator',
381 select => \@primary_cols
384 @rows = $rs->all; # statement must finish
387 for my $row (@rows) {
388 $self->_insert_blobs($source, $blob_cols, $row);
393 my ($self, $source, $blob_cols, $row) = @_;
394 my $dbh = $self->dbh;
396 my $table = $source->from;
399 my (@primary_cols) = $source->primary_columns;
401 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
402 unless @primary_cols;
404 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
405 if (@primary_cols == 1) {
406 my $col = $primary_cols[0];
407 $row{$col} = $self->last_insert_id($source, $col);
409 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
413 for my $col (keys %$blob_cols) {
414 my $blob = $blob_cols->{$col};
416 my %where = map { ($_, $row{$_}) } @primary_cols;
417 my $cursor = $source->resultset->search(\%where, {
421 my $sth = $cursor->sth;
425 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
428 $sth->func('ct_prepare_send') or die $sth->errstr;
430 my $log_on_update = $self->_blob_log_on_update;
431 $log_on_update = 1 if not defined $log_on_update;
433 $sth->func('CS_SET', 1, {
434 total_txtlen => length($blob),
435 log_on_update => $log_on_update
436 }, 'ct_data_info') or die $sth->errstr;
438 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
440 $sth->func('ct_finish_send') or die $sth->errstr;
443 $sth->finish if $sth;
445 if ($self->using_freetds) {
447 "TEXT/IMAGE operation failed, probably because you're using FreeTDS: " .
456 =head2 connect_call_datetime_setup
460 on_connect_call => 'datetime_setup'
462 In L<DBIx::Class::Storage::DBI/connect_info> to set:
464 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
465 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
467 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
468 L<DateTime::Format::Sybase>, which you will need to install.
470 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
471 C<SMALLDATETIME> columns only have minute precision.
476 my $old_dbd_warned = 0;
478 sub connect_call_datetime_setup {
480 my $dbh = $self->_dbh;
482 if ($dbh->can('syb_date_fmt')) {
483 # amazingly, this works with FreeTDS
484 $dbh->syb_date_fmt('ISO_strict');
485 } elsif (not $old_dbd_warned) {
486 carp "Your DBD::Sybase is too old to support ".
487 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
491 $dbh->do('SET DATEFORMAT mdy');
497 sub datetime_parser_type { "DateTime::Format::Sybase" }
499 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
500 # let the DBD keep any state it needs to.
502 # If they ever do start working, the extra statements will do no harm (because
503 # Sybase supports nested transactions.)
505 sub _dbh_begin_work {
507 $self->next::method(@_);
508 if ($self->using_freetds) {
509 $self->dbh->do('BEGIN TRAN');
515 if ($self->using_freetds) {
516 $self->_dbh->do('COMMIT');
518 return $self->next::method(@_);
523 if ($self->using_freetds) {
524 $self->_dbh->do('ROLLBACK');
526 return $self->next::method(@_);
529 # savepoint support using ASE syntax
532 my ($self, $name) = @_;
534 $self->dbh->do("SAVE TRANSACTION $name");
537 # A new SAVE TRANSACTION with the same name releases the previous one.
538 sub _svp_release { 1 }
541 my ($self, $name) = @_;
543 $self->dbh->do("ROLLBACK TRANSACTION $name");
548 =head1 Schema::Loader Support
550 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
551 allow you to dump a schema from most (if not all) versions of Sybase.
553 It is available via subversion from:
555 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
559 This driver supports L<DBD::Sybase> compiled against FreeTDS
560 (L<http://www.freetds.org/>) to the best of our ability, however it is
561 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
562 libraries. They are a part of the Sybase ASE distribution:
564 The Open Client FAQ is here:
565 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
567 Sybase ASE for Linux (which comes with the Open Client libraries) may be
568 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
570 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
572 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
574 Some versions of the libraries involved will not support placeholders, in which
575 case the storage will be reblessed to
576 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
578 In some configurations, placeholders will work but will throw implicit type
579 conversion errors for anything that's not expecting a string. In such a case,
580 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
581 automatically set, which you may enable on connection with
582 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
583 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
584 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
585 already) using a mapping based on L<SQL::Translator>.
587 In other configurations, placeholers will work just as they do with the Sybase
588 Open Client libraries.
590 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
592 =head1 MAXIMUM CONNECTIONS
594 The TDS protocol makes separate connections to the server for active statements
595 in the background. By default the number of such connections is limited to 25,
596 on both the client side and the server side.
598 This is a bit too low for a complex L<DBIx::Class> application, so on connection
599 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
600 can override it to whatever setting you like in the DSN.
603 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
604 for information on changing the setting on the server side.
608 See L</connect_call_datetime_setup> to setup date formats
609 for L<DBIx::Class::InflateColumn::DateTime>.
611 =head1 TEXT/IMAGE COLUMNS
613 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
614 C<TEXT/IMAGE> columns.
616 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
618 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
622 $schema->storage->set_textsize($bytes);
626 However, the C<LongReadLen> you pass in
627 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
628 C<SET TEXTSIZE> command on connection.
630 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
631 setting you need to work with C<IMAGE> columns.
635 See L<DBIx::Class/CONTRIBUTORS>.
639 You may distribute this code under the same terms as Perl itself.