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_dbh _identity_method/
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.) See L</INSERTS WITH PLACEHOLDERS>.
38 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
40 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
49 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
51 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
56 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
58 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
59 bless $self, $subclass;
61 } else { # real Sybase
62 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
64 if ($self->using_freetds) {
65 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
67 You are using FreeTDS with Sybase.
69 We will do our best to support this configuration, but please consider this
72 TEXT/IMAGE columns will definitely not work.
74 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
77 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
79 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
82 if (not $self->_typeless_placeholders_supported) {
83 if ($self->_placeholders_supported) {
86 $self->ensure_class_loaded($no_bind_vars);
87 bless $self, $no_bind_vars;
92 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
93 # not necessarily FreeTDS, but no placeholders nevertheless
94 $self->ensure_class_loaded($no_bind_vars);
95 bless $self, $no_bind_vars;
97 } elsif (not $self->_typeless_placeholders_supported) {
98 # this is highly unlikely, but we check just in case
107 $self->_set_max_connect(256);
109 # based on LongReadLen in connect_info
110 $self->set_textsize if $self->using_freetds;
113 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
114 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
115 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
116 # only want when AutoCommit is off.
120 $self->next::method(@_);
122 if (not $self->using_freetds) {
123 $self->_dbh->{syb_chained_txn} = 1;
125 if ($self->_dbh_autocommit) {
126 $self->_dbh->do('SET CHAINED OFF');
128 $self->_dbh->do('SET CHAINED ON');
133 =head2 connect_call_blob_setup
137 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
139 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
140 instead of as a hex string.
144 Also sets the C<log_on_update> value for blob write operations. The default is
145 C<1>, but C<0> is better if your database is configured for it.
148 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
152 sub connect_call_blob_setup {
155 my $dbh = $self->_dbh;
156 $dbh->{syb_binary_images} = 1;
158 $self->_blob_log_on_update($args{log_on_update})
159 if exists $args{log_on_update};
165 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
168 sub _prep_for_execute {
170 my ($op, $extra_bind, $ident, $args) = @_;
172 my ($sql, $bind) = $self->next::method (@_);
174 if ($op eq 'insert') {
175 my $table = $ident->from;
177 my $bind_info = $self->_resolve_column_info(
178 $ident, [map $_->[0], @{$bind}]
180 my $identity_col = List::Util::first
181 { $bind_info->{$_}{is_auto_increment} }
187 "SET IDENTITY_INSERT $table ON",
189 "SET IDENTITY_INSERT $table OFF",
193 $identity_col = List::Util::first
194 { $ident->column_info($_)->{is_auto_increment} }
202 $self->_fetch_identity_sql($ident, $identity_col);
206 return ($sql, $bind);
209 # Stolen from SQLT, with some modifications. This is a makeshift
210 # solution before a sane type-mapping library is available, thus
211 # the 'our' for easy overrides.
212 our %TYPE_MAPPING = (
215 varchar => 'varchar',
216 varchar2 => 'varchar',
217 timestamp => 'datetime',
219 real => 'double precision',
222 tinyint => 'smallint',
223 float => 'double precision',
225 bigserial => 'numeric',
226 boolean => 'varchar',
230 sub _native_data_type {
231 my ($self, $type) = @_;
234 $type =~ s/\s* identity//x;
236 return uc($TYPE_MAPPING{$type} || $type);
239 sub _fetch_identity_sql {
240 my ($self, $source, $col) = @_;
242 return sprintf ("SELECT MAX(%s) FROM %s",
243 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
251 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
253 if ($op eq 'insert') {
254 $self->_identity($sth->fetchrow_array);
258 return wantarray ? ($rv, $sth, @bind) : $rv;
261 sub last_insert_id { shift->_identity }
263 # handles TEXT/IMAGE and transaction for last_insert_id
266 my ($source, $to_insert) = @_;
268 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
270 my $identity_col = List::Util::first
271 { $source->column_info($_)->{is_auto_increment} }
274 # do we need the horrific SELECT MAX(COL) hack?
275 my $dumb_last_insert_id =
277 && (not exists $to_insert->{$identity_col})
278 && ($self->_identity_method||'') ne '@@IDENTITY'
281 my $next = $self->next::can;
283 # we are already in a transaction, or there are no blobs
284 # and we don't need the PK - just (try to) do it
285 if ($self->{transaction_depth}
286 || (!$blob_cols && !$dumb_last_insert_id)
288 return $self->_insert (
289 $source, $to_insert, $blob_cols, $identity_col, $next
293 # this is tricky: a transaction needs to take place if we need
294 # either a last_insert_id or we will be doing blob insert.
295 # This will happen on a *seperate* connection, thus the local()
300 # localize so it appears right if we blow out with an exception
301 local $self->{transaction_depth} = 0;
303 $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info }))
304 unless $self->_insert_dbh;
306 $self->{_dbh} = $self->_insert_dbh;
307 my $guard = $self->txn_scope_guard;
309 # _dbh_begin_work in the guard may reconnect,
310 # so we update the accessor just in case
311 $self->_insert_dbh($self->_dbh);
313 my $updated_cols = $self->_insert (
314 $source, $to_insert, $blob_cols, $identity_col, $next
319 return $updated_cols;
324 my ($self, $source, $to_insert, $blob_cols, $identity_col, $next) = @_;
326 my $updated_cols = $self->$next ($source, $to_insert);
329 $identity_col => $self->last_insert_id($source, $identity_col),
334 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
336 return $updated_cols;
341 my ($source, $fields, $where) = @_;
343 my $wantarray = wantarray;
345 my $blob_cols = $self->_remove_blob_cols($source, $fields);
347 # update+blob update(s) done atomically
348 my $guard = $self->txn_scope_guard if $blob_cols;
352 @res = $self->next::method(@_);
354 elsif (defined $wantarray) {
355 $res[0] = $self->next::method(@_);
358 $self->next::method(@_);
361 $self->_update_blobs($source, $blob_cols, $where) if $blob_cols;
363 $guard->commit if $guard;
365 return $wantarray ? @res : $res[0];
368 sub _remove_blob_cols {
369 my ($self, $source, $fields) = @_;
373 for my $col (keys %$fields) {
374 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
375 $blob_cols{$col} = delete $fields->{$col};
376 $fields->{$col} = \"''";
380 return keys %blob_cols ? \%blob_cols : undef;
384 my ($self, $source, $blob_cols, $where) = @_;
386 my (@primary_cols) = $source->primary_columns;
388 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
389 unless @primary_cols;
391 # check if we're updating a single row by PK
392 my $pk_cols_in_where = 0;
393 for my $col (@primary_cols) {
394 $pk_cols_in_where++ if defined $where->{$col};
398 if ($pk_cols_in_where == @primary_cols) {
400 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
401 @rows = \%row_to_update;
403 my $rs = $source->resultset->search(
406 result_class => 'DBIx::Class::ResultClass::HashRefInflator',
407 columns => \@primary_cols
410 @rows = $rs->all; # statement must finish
413 for my $row (@rows) {
414 $self->_insert_blobs($source, $blob_cols, $row);
419 my ($self, $source, $blob_cols, $row) = @_;
420 my $dbh = $self->_get_dbh;
422 my $table = $source->from;
425 my (@primary_cols) = $source->primary_columns;
427 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
428 unless @primary_cols;
430 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
431 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
434 for my $col (keys %$blob_cols) {
435 my $blob = $blob_cols->{$col};
437 my %where = map { ($_, $row{$_}) } @primary_cols;
438 my $cursor = $source->resultset->search(\%where, {
442 my $sth = $cursor->sth;
446 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
449 $sth->func('ct_prepare_send') or die $sth->errstr;
451 my $log_on_update = $self->_blob_log_on_update;
452 $log_on_update = 1 if not defined $log_on_update;
454 $sth->func('CS_SET', 1, {
455 total_txtlen => length($blob),
456 log_on_update => $log_on_update
457 }, 'ct_data_info') or die $sth->errstr;
459 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
461 $sth->func('ct_finish_send') or die $sth->errstr;
464 $sth->finish if $sth;
466 if ($self->using_freetds) {
468 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
478 =head2 connect_call_datetime_setup
482 on_connect_call => 'datetime_setup'
484 In L<DBIx::Class::Storage::DBI/connect_info> to set:
486 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
487 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
489 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
490 L<DateTime::Format::Sybase>, which you will need to install.
492 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
493 C<SMALLDATETIME> columns only have minute precision.
498 my $old_dbd_warned = 0;
500 sub connect_call_datetime_setup {
502 my $dbh = $self->_dbh;
504 if ($dbh->can('syb_date_fmt')) {
505 # amazingly, this works with FreeTDS
506 $dbh->syb_date_fmt('ISO_strict');
507 } elsif (not $old_dbd_warned) {
508 carp "Your DBD::Sybase is too old to support ".
509 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
513 $dbh->do('SET DATEFORMAT mdy');
519 sub datetime_parser_type { "DateTime::Format::Sybase" }
521 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
522 # let the DBD keep any state it needs to.
524 # If they ever do start working, the extra statements will do no harm (because
525 # Sybase supports nested transactions.)
527 sub _dbh_begin_work {
529 $self->next::method(@_);
530 if ($self->using_freetds) {
531 $self->_get_dbh->do('BEGIN TRAN');
537 if ($self->using_freetds) {
538 $self->_dbh->do('COMMIT');
540 return $self->next::method(@_);
545 if ($self->using_freetds) {
546 $self->_dbh->do('ROLLBACK');
548 return $self->next::method(@_);
551 # savepoint support using ASE syntax
554 my ($self, $name) = @_;
556 $self->_get_dbh->do("SAVE TRANSACTION $name");
559 # A new SAVE TRANSACTION with the same name releases the previous one.
560 sub _svp_release { 1 }
563 my ($self, $name) = @_;
565 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
570 =head1 Schema::Loader Support
572 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
573 allow you to dump a schema from most (if not all) versions of Sybase.
575 It is available via subversion from:
577 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
581 This driver supports L<DBD::Sybase> compiled against FreeTDS
582 (L<http://www.freetds.org/>) to the best of our ability, however it is
583 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
584 libraries. They are a part of the Sybase ASE distribution:
586 The Open Client FAQ is here:
587 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
589 Sybase ASE for Linux (which comes with the Open Client libraries) may be
590 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
592 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
594 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
596 Some versions of the libraries involved will not support placeholders, in which
597 case the storage will be reblessed to
598 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
600 In some configurations, placeholders will work but will throw implicit type
601 conversion errors for anything that's not expecting a string. In such a case,
602 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
603 automatically set, which you may enable on connection with
604 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
605 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
606 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
607 already) using a mapping based on L<SQL::Translator>.
609 In other configurations, placeholers will work just as they do with the Sybase
610 Open Client libraries.
612 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
614 =head1 INSERTS WITH PLACEHOLDERS
616 With placeholders enabled, inserts are done in a transaction so that there are
617 no concurrency issues with getting the inserted identity value using
618 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
621 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
622 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
627 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
628 begin a transaction while there are active cursors. An active cursor is, for
629 example, a L<ResultSet|DBIx::Class::ResultSet> that has been executed using
630 C<next> or C<first> but has not been exhausted or
631 L<reset|DBIx::Class::ResultSet/reset>.
633 For example, this will not work:
635 $schema->txn_do(sub {
636 my $rs = $schema->resultset('Book');
637 while (my $row = $rs->next) {
638 $schema->resultset('MetaData')->create({
645 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
646 are not affected, as they use an extra database handle to do the insert.
652 =item * use L<DBIx::Class::Storage::DBI::Replicated>
654 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
656 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
660 =head1 MAXIMUM CONNECTIONS
662 The TDS protocol makes separate connections to the server for active statements
663 in the background. By default the number of such connections is limited to 25,
664 on both the client side and the server side.
666 This is a bit too low for a complex L<DBIx::Class> application, so on connection
667 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
668 can override it to whatever setting you like in the DSN.
671 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
672 for information on changing the setting on the server side.
676 See L</connect_call_datetime_setup> to setup date formats
677 for L<DBIx::Class::InflateColumn::DateTime>.
679 =head1 TEXT/IMAGE COLUMNS
681 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
682 C<TEXT/IMAGE> columns.
684 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
686 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
690 $schema->storage->set_textsize($bytes);
694 However, the C<LongReadLen> you pass in
695 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
696 C<SET TEXTSIZE> command on connection.
698 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
699 setting you need to work with C<IMAGE> columns.
703 See L<DBIx::Class/CONTRIBUTORS>.
707 You may distribute this code under the same terms as Perl itself.