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 unsafe_insert/
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, or you don't need the C<IDENTITY> value, see
38 L<DBIx::Class::Storage::DBI::Sybase/connect_call_unsafe_insert>.
40 But your queries will be cached.
42 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
44 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
53 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
55 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
60 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
62 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
63 bless $self, $subclass;
65 } else { # real Sybase
66 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
68 if ($self->using_freetds) {
69 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
71 You are using FreeTDS with Sybase.
73 We will do our best to support this configuration, but please consider this
76 TEXT/IMAGE columns will definitely not work.
78 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
81 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
83 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
86 if (not $self->_typeless_placeholders_supported) {
87 if ($self->_placeholders_supported) {
90 $self->ensure_class_loaded($no_bind_vars);
91 bless $self, $no_bind_vars;
96 $self->set_textsize; # based on LongReadLen in connect_info
99 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
100 # not necessarily FreeTDS, but no placeholders nevertheless
101 $self->ensure_class_loaded($no_bind_vars);
102 bless $self, $no_bind_vars;
104 } elsif (not $self->_typeless_placeholders_supported) {
105 # this is highly unlikely, but we check just in case
109 $self->_set_max_connect(256);
114 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
115 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
116 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
117 # only want when AutoCommit is off.
121 $self->next::method(@_);
123 if (not $self->using_freetds) {
124 $self->_dbh->{syb_chained_txn} = 1;
126 if ($self->_dbh_autocommit) {
127 $self->_dbh->do('SET CHAINED OFF');
129 $self->_dbh->do('SET CHAINED ON');
134 =head2 connect_call_blob_setup
138 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
140 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
141 instead of as a hex string.
145 Also sets the C<log_on_update> value for blob write operations. The default is
146 C<1>, but C<0> is better if your database is configured for it.
149 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
153 sub connect_call_blob_setup {
156 my $dbh = $self->_dbh;
157 $dbh->{syb_binary_images} = 1;
159 $self->_blob_log_on_update($args{log_on_update})
160 if exists $args{log_on_update};
163 =head2 connect_call_unsafe_insert
165 With placeholders enabled, inserts are done in a transaction so that there are
166 no concurrency issues with getting the inserted identity value using
167 C<SELECT MAX(col)> when placeholders are enabled.
169 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
172 To turn off transactions for inserts (for an application that doesn't need
173 concurrency, or a loader, for example) use this setting in
174 L<DBIx::Class::Storage::DBI/connect_info>,
176 on_connect_call => ['unsafe_insert']
178 To manipulate this setting at runtime, use:
180 $schema->storage->unsafe_insert(0|1);
184 sub connect_call_unsafe_insert {
186 $self->unsafe_insert(1);
192 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
195 sub _prep_for_execute {
197 my ($op, $extra_bind, $ident, $args) = @_;
199 my ($sql, $bind) = $self->next::method (@_);
201 if ($op eq 'insert') {
202 my $table = $ident->from;
204 my $bind_info = $self->_resolve_column_info(
205 $ident, [map $_->[0], @{$bind}]
207 my $identity_col = List::Util::first
208 { $bind_info->{$_}{is_auto_increment} }
214 "SET IDENTITY_INSERT $table ON",
216 "SET IDENTITY_INSERT $table OFF",
220 $identity_col = List::Util::first
221 { $ident->column_info($_)->{is_auto_increment} }
229 $self->_fetch_identity_sql($ident, $identity_col);
233 return ($sql, $bind);
236 # Stolen from SQLT, with some modifications. This is a makeshift
237 # solution before a sane type-mapping library is available, thus
238 # the 'our' for easy overrides.
239 our %TYPE_MAPPING = (
242 varchar => 'varchar',
243 varchar2 => 'varchar',
244 timestamp => 'datetime',
246 real => 'double precision',
249 tinyint => 'smallint',
250 float => 'double precision',
252 bigserial => 'numeric',
253 boolean => 'varchar',
257 sub _native_data_type {
258 my ($self, $type) = @_;
261 $type =~ s/ identity//;
263 return uc($TYPE_MAPPING{$type} || $type);
266 sub _fetch_identity_sql {
267 my ($self, $source, $col) = @_;
269 return "SELECT MAX($col) FROM ".$source->from;
276 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
278 if ($op eq 'insert') {
279 $self->_identity($sth->fetchrow_array);
283 return wantarray ? ($rv, $sth, @bind) : $rv;
286 sub last_insert_id { shift->_identity }
288 # handles TEXT/IMAGE and transaction for last_insert_id
291 my ($source, $to_insert) = @_;
293 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
295 # insert+blob insert done atomically
296 my $guard = $self->txn_scope_guard if $blob_cols;
298 my $need_last_insert_id = 0;
302 grep $_->[1]{is_auto_increment},
303 map [ $_, $source->column_info($_) ],
306 $need_last_insert_id = 1
307 if $identity_col && (not exists $to_insert->{$identity_col});
309 # We have to do the insert in a transaction to avoid race conditions with the
310 # SELECT MAX(COL) identity method used when placeholders are enabled.
311 my $updated_cols = do {
313 $need_last_insert_id && !$self->unsafe_insert && !$self->{transaction_depth}
315 my $guard = $self->txn_scope_guard;
316 my $upd_cols = $self->next::method (@_);
321 $self->next::method(@_);
325 $self->_insert_blobs($source, $blob_cols, $to_insert) if $blob_cols;
327 $guard->commit if $guard;
329 return $updated_cols;
334 my ($source, $fields, $where) = @_;
336 my $wantarray = wantarray;
338 my $blob_cols = $self->_remove_blob_cols($source, $fields);
340 # update+blob update(s) done atomically
341 my $guard = $self->txn_scope_guard if $blob_cols;
345 @res = $self->next::method(@_);
347 elsif (defined $wantarray) {
348 $res[0] = $self->next::method(@_);
351 $self->next::method(@_);
354 $self->_update_blobs($source, $blob_cols, $where) if $blob_cols;
356 $guard->commit if $guard;
358 return $wantarray ? @res : $res[0];
361 sub _remove_blob_cols {
362 my ($self, $source, $fields) = @_;
366 for my $col (keys %$fields) {
367 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
368 $blob_cols{$col} = delete $fields->{$col};
369 $fields->{$col} = \"''";
373 return keys %blob_cols ? \%blob_cols : undef;
377 my ($self, $source, $blob_cols, $where) = @_;
379 my (@primary_cols) = $source->primary_columns;
381 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
382 unless @primary_cols;
384 # check if we're updating a single row by PK
385 my $pk_cols_in_where = 0;
386 for my $col (@primary_cols) {
387 $pk_cols_in_where++ if defined $where->{$col};
391 if ($pk_cols_in_where == @primary_cols) {
393 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
394 @rows = \%row_to_update;
396 my $rs = $source->resultset->search(
399 result_class => 'DBIx::Class::ResultClass::HashRefInflator',
400 select => \@primary_cols
403 @rows = $rs->all; # statement must finish
406 for my $row (@rows) {
407 $self->_insert_blobs($source, $blob_cols, $row);
412 my ($self, $source, $blob_cols, $row) = @_;
413 my $dbh = $self->_get_dbh;
415 my $table = $source->from;
418 my (@primary_cols) = $source->primary_columns;
420 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
421 unless @primary_cols;
423 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
424 if (@primary_cols == 1) {
425 my $col = $primary_cols[0];
426 $row{$col} = $self->last_insert_id($source, $col);
428 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
432 for my $col (keys %$blob_cols) {
433 my $blob = $blob_cols->{$col};
435 my %where = map { ($_, $row{$_}) } @primary_cols;
436 my $cursor = $source->resultset->search(\%where, {
440 my $sth = $cursor->sth;
444 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
447 $sth->func('ct_prepare_send') or die $sth->errstr;
449 my $log_on_update = $self->_blob_log_on_update;
450 $log_on_update = 1 if not defined $log_on_update;
452 $sth->func('CS_SET', 1, {
453 total_txtlen => length($blob),
454 log_on_update => $log_on_update
455 }, 'ct_data_info') or die $sth->errstr;
457 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
459 $sth->func('ct_finish_send') or die $sth->errstr;
462 $sth->finish if $sth;
464 if ($self->using_freetds) {
466 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
476 =head2 connect_call_datetime_setup
480 on_connect_call => 'datetime_setup'
482 In L<DBIx::Class::Storage::DBI/connect_info> to set:
484 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
485 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
487 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
488 L<DateTime::Format::Sybase>, which you will need to install.
490 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
491 C<SMALLDATETIME> columns only have minute precision.
496 my $old_dbd_warned = 0;
498 sub connect_call_datetime_setup {
500 my $dbh = $self->_dbh;
502 if ($dbh->can('syb_date_fmt')) {
503 # amazingly, this works with FreeTDS
504 $dbh->syb_date_fmt('ISO_strict');
505 } elsif (not $old_dbd_warned) {
506 carp "Your DBD::Sybase is too old to support ".
507 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
511 $dbh->do('SET DATEFORMAT mdy');
517 sub datetime_parser_type { "DateTime::Format::Sybase" }
519 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
520 # let the DBD keep any state it needs to.
522 # If they ever do start working, the extra statements will do no harm (because
523 # Sybase supports nested transactions.)
525 sub _dbh_begin_work {
527 $self->next::method(@_);
528 if ($self->using_freetds) {
529 $self->_get_dbh->do('BEGIN TRAN');
535 if ($self->using_freetds) {
536 $self->_dbh->do('COMMIT');
538 return $self->next::method(@_);
543 if ($self->using_freetds) {
544 $self->_dbh->do('ROLLBACK');
546 return $self->next::method(@_);
549 # savepoint support using ASE syntax
552 my ($self, $name) = @_;
554 $self->_get_dbh->do("SAVE TRANSACTION $name");
557 # A new SAVE TRANSACTION with the same name releases the previous one.
558 sub _svp_release { 1 }
561 my ($self, $name) = @_;
563 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
568 =head1 Schema::Loader Support
570 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
571 allow you to dump a schema from most (if not all) versions of Sybase.
573 It is available via subversion from:
575 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
579 This driver supports L<DBD::Sybase> compiled against FreeTDS
580 (L<http://www.freetds.org/>) to the best of our ability, however it is
581 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
582 libraries. They are a part of the Sybase ASE distribution:
584 The Open Client FAQ is here:
585 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
587 Sybase ASE for Linux (which comes with the Open Client libraries) may be
588 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
590 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
592 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
594 Some versions of the libraries involved will not support placeholders, in which
595 case the storage will be reblessed to
596 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
598 In some configurations, placeholders will work but will throw implicit type
599 conversion errors for anything that's not expecting a string. In such a case,
600 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
601 automatically set, which you may enable on connection with
602 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
603 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
604 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
605 already) using a mapping based on L<SQL::Translator>.
607 In other configurations, placeholers will work just as they do with the Sybase
608 Open Client libraries.
610 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
614 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
615 begin a transaction while there are active cursors. An active cursor is, for
616 example, a L<ResultSet|DBIx::Class::ResultSet> that has been executed using
617 C<next> or C<first> but has not been exhausted or
618 L<reset|DBIx::Class::ResultSet/reset>.
620 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
621 are also affected, so this won't work:
623 while (my $row = $rs1->next) {
624 $rs2->create({ foo => $row->foo });
631 =item * set C<< $schema->storage->unsafe_insert(1) >> temporarily (see
632 L</connect_call_unsafe_insert>)
634 =item * use L<DBIx::Class::Storage::DBI::Replicated>
636 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
638 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
640 =item * enlarge the scope of the transaction
644 =head1 MAXIMUM CONNECTIONS
646 The TDS protocol makes separate connections to the server for active statements
647 in the background. By default the number of such connections is limited to 25,
648 on both the client side and the server side.
650 This is a bit too low for a complex L<DBIx::Class> application, so on connection
651 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
652 can override it to whatever setting you like in the DSN.
655 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
656 for information on changing the setting on the server side.
660 See L</connect_call_datetime_setup> to setup date formats
661 for L<DBIx::Class::InflateColumn::DateTime>.
663 =head1 TEXT/IMAGE COLUMNS
665 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
666 C<TEXT/IMAGE> columns.
668 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
670 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
674 $schema->storage->set_textsize($bytes);
678 However, the C<LongReadLen> you pass in
679 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
680 C<SET TEXTSIZE> command on connection.
682 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
683 setting you need to work with C<IMAGE> columns.
687 See L<DBIx::Class/CONTRIBUTORS>.
691 You may distribute this code under the same terms as Perl itself.