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 _insert_dbh _identity_method/
21 DBIx::Class::Storage::DBI::Sybase - Sybase support for DBIx::Class
25 This subclass supports L<DBD::Sybase> for real Sybase databases. If you are
26 using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
27 L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
31 If your version of Sybase does not support placeholders, then your storage
32 will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
33 also enable that driver explicitly, see the documentation for more details.
35 With this driver there is unfortunately no way to get the C<last_insert_id>
36 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
37 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
39 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
41 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
50 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
52 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
57 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
59 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
60 bless $self, $subclass;
62 } else { # real Sybase
63 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
65 if ($self->using_freetds) {
66 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
68 You are using FreeTDS with Sybase.
70 We will do our best to support this configuration, but please consider this
73 TEXT/IMAGE columns will definitely not work.
75 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
78 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
80 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
83 if (not $self->_typeless_placeholders_supported) {
84 if ($self->_placeholders_supported) {
87 $self->ensure_class_loaded($no_bind_vars);
88 bless $self, $no_bind_vars;
93 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
94 # not necessarily FreeTDS, but no placeholders nevertheless
95 $self->ensure_class_loaded($no_bind_vars);
96 bless $self, $no_bind_vars;
98 } elsif (not $self->_typeless_placeholders_supported) {
99 # this is highly unlikely, but we check just in case
108 $self->_set_max_connect(256);
110 # based on LongReadLen in connect_info
111 $self->set_textsize if $self->using_freetds;
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};
166 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
169 sub _prep_for_execute {
171 my ($op, $extra_bind, $ident, $args) = @_;
173 my ($sql, $bind) = $self->next::method (@_);
175 if ($op eq 'insert') {
176 my $table = $ident->from;
178 my $bind_info = $self->_resolve_column_info(
179 $ident, [map $_->[0], @{$bind}]
181 my $identity_col = List::Util::first
182 { $bind_info->{$_}{is_auto_increment} }
188 "SET IDENTITY_INSERT $table ON",
190 "SET IDENTITY_INSERT $table OFF",
194 $identity_col = List::Util::first
195 { $ident->column_info($_)->{is_auto_increment} }
203 $self->_fetch_identity_sql($ident, $identity_col);
207 return ($sql, $bind);
210 # Stolen from SQLT, with some modifications. This is a makeshift
211 # solution before a sane type-mapping library is available, thus
212 # the 'our' for easy overrides.
213 our %TYPE_MAPPING = (
216 varchar => 'varchar',
217 varchar2 => 'varchar',
218 timestamp => 'datetime',
220 real => 'double precision',
223 tinyint => 'smallint',
224 float => 'double precision',
226 bigserial => 'numeric',
227 boolean => 'varchar',
231 sub _native_data_type {
232 my ($self, $type) = @_;
235 $type =~ s/\s* identity//x;
237 return uc($TYPE_MAPPING{$type} || $type);
240 sub _fetch_identity_sql {
241 my ($self, $source, $col) = @_;
243 return sprintf ("SELECT MAX(%s) FROM %s",
244 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
252 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
254 if ($op eq 'insert') {
255 $self->_identity($sth->fetchrow_array);
259 return wantarray ? ($rv, $sth, @bind) : $rv;
262 sub last_insert_id { shift->_identity }
264 # handles TEXT/IMAGE and transaction for last_insert_id
267 my ($source, $to_insert) = @_;
269 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
271 my $identity_col = List::Util::first
272 { $source->column_info($_)->{is_auto_increment} }
275 # do we need the horrific SELECT MAX(COL) hack?
276 my $dumb_last_insert_id =
278 && (not exists $to_insert->{$identity_col})
279 && ($self->_identity_method||'') ne '@@IDENTITY'
282 # we are already in a transaction, or there are no blobs
283 # and we don't need the PK - just (try to) do it
284 if ($self->{transaction_depth}
285 || (!$blob_cols && !$dumb_last_insert_id)
287 return $self->_insert ($source, $to_insert, $blob_cols, $identity_col);
290 # this is tricky: a transaction needs to take place if we need
291 # either a last_insert_id or we will be doing blob insert.
292 # This will happen on a *seperate* connection, thus the local()
297 # localize so it appears right if we blow out with an exception
298 local $self->{transaction_depth} = 0;
300 $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info }))
301 unless $self->_insert_dbh;
303 $self->{_dbh} = $self->_insert_dbh;
304 my $guard = $self->txn_scope_guard;
306 # _dbh_begin_work in the guard may reconnect,
307 # so we update the accessor just in case
308 $self->_insert_dbh($self->_dbh);
310 my $updated_cols = $self->_insert ($source, $to_insert, $blob_cols, $identity_col);
314 return $updated_cols;
319 my ($self, $source, $to_insert, $blob_cols, $identity_col) = @_;
322 (Sub::Name::subname insert =>
323 sub { $self->next::method ($source, $to_insert) })->();
326 $identity_col => $self->last_insert_id($source, $identity_col),
331 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
333 return $updated_cols;
338 my ($source, $fields, $where) = @_;
340 my $wantarray = wantarray;
342 my $blob_cols = $self->_remove_blob_cols($source, $fields);
344 # update+blob update(s) done atomically
345 my $guard = $self->txn_scope_guard if $blob_cols;
349 @res = $self->next::method(@_);
351 elsif (defined $wantarray) {
352 $res[0] = $self->next::method(@_);
355 $self->next::method(@_);
358 $self->_update_blobs($source, $blob_cols, $where) if $blob_cols;
360 $guard->commit if $guard;
362 return $wantarray ? @res : $res[0];
365 sub _remove_blob_cols {
366 my ($self, $source, $fields) = @_;
370 for my $col (keys %$fields) {
371 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
372 $blob_cols{$col} = delete $fields->{$col};
373 $fields->{$col} = \"''";
377 return keys %blob_cols ? \%blob_cols : undef;
381 my ($self, $source, $blob_cols, $where) = @_;
383 my (@primary_cols) = $source->primary_columns;
385 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
386 unless @primary_cols;
388 # check if we're updating a single row by PK
389 my $pk_cols_in_where = 0;
390 for my $col (@primary_cols) {
391 $pk_cols_in_where++ if defined $where->{$col};
395 if ($pk_cols_in_where == @primary_cols) {
397 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
398 @rows = \%row_to_update;
400 my $rs = $source->resultset->search(
403 result_class => 'DBIx::Class::ResultClass::HashRefInflator',
404 columns => \@primary_cols
407 @rows = $rs->all; # statement must finish
410 for my $row (@rows) {
411 $self->_insert_blobs($source, $blob_cols, $row);
416 my ($self, $source, $blob_cols, $row) = @_;
417 my $dbh = $self->_get_dbh;
419 my $table = $source->from;
422 my (@primary_cols) = $source->primary_columns;
424 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
425 unless @primary_cols;
427 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
428 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
431 for my $col (keys %$blob_cols) {
432 my $blob = $blob_cols->{$col};
434 my %where = map { ($_, $row{$_}) } @primary_cols;
435 my $cursor = $source->resultset->search(\%where, {
439 my $sth = $cursor->sth;
443 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
446 $sth->func('ct_prepare_send') or die $sth->errstr;
448 my $log_on_update = $self->_blob_log_on_update;
449 $log_on_update = 1 if not defined $log_on_update;
451 $sth->func('CS_SET', 1, {
452 total_txtlen => length($blob),
453 log_on_update => $log_on_update
454 }, 'ct_data_info') or die $sth->errstr;
456 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
458 $sth->func('ct_finish_send') or die $sth->errstr;
461 $sth->finish if $sth;
463 if ($self->using_freetds) {
465 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
475 =head2 connect_call_datetime_setup
479 on_connect_call => 'datetime_setup'
481 In L<DBIx::Class::Storage::DBI/connect_info> to set:
483 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
484 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
486 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
487 L<DateTime::Format::Sybase>, which you will need to install.
489 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
490 C<SMALLDATETIME> columns only have minute precision.
495 my $old_dbd_warned = 0;
497 sub connect_call_datetime_setup {
499 my $dbh = $self->_dbh;
501 if ($dbh->can('syb_date_fmt')) {
502 # amazingly, this works with FreeTDS
503 $dbh->syb_date_fmt('ISO_strict');
504 } elsif (not $old_dbd_warned) {
505 carp "Your DBD::Sybase is too old to support ".
506 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
510 $dbh->do('SET DATEFORMAT mdy');
516 sub datetime_parser_type { "DateTime::Format::Sybase" }
518 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
519 # let the DBD keep any state it needs to.
521 # If they ever do start working, the extra statements will do no harm (because
522 # Sybase supports nested transactions.)
524 sub _dbh_begin_work {
526 $self->next::method(@_);
527 if ($self->using_freetds) {
528 $self->_get_dbh->do('BEGIN TRAN');
534 if ($self->using_freetds) {
535 $self->_dbh->do('COMMIT');
537 return $self->next::method(@_);
542 if ($self->using_freetds) {
543 $self->_dbh->do('ROLLBACK');
545 return $self->next::method(@_);
548 # savepoint support using ASE syntax
551 my ($self, $name) = @_;
553 $self->_get_dbh->do("SAVE TRANSACTION $name");
556 # A new SAVE TRANSACTION with the same name releases the previous one.
557 sub _svp_release { 1 }
560 my ($self, $name) = @_;
562 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
567 =head1 Schema::Loader Support
569 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
570 allow you to dump a schema from most (if not all) versions of Sybase.
572 It is available via subversion from:
574 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
578 This driver supports L<DBD::Sybase> compiled against FreeTDS
579 (L<http://www.freetds.org/>) to the best of our ability, however it is
580 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
581 libraries. They are a part of the Sybase ASE distribution:
583 The Open Client FAQ is here:
584 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
586 Sybase ASE for Linux (which comes with the Open Client libraries) may be
587 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
589 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
591 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
593 Some versions of the libraries involved will not support placeholders, in which
594 case the storage will be reblessed to
595 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
597 In some configurations, placeholders will work but will throw implicit type
598 conversion errors for anything that's not expecting a string. In such a case,
599 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
600 automatically set, which you may enable on connection with
601 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
602 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
603 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
604 already) using a mapping based on L<SQL::Translator>.
606 In other configurations, placeholers will work just as they do with the Sybase
607 Open Client libraries.
609 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
611 =head1 INSERTS WITH PLACEHOLDERS
613 With placeholders enabled, inserts are done in a transaction so that there are
614 no concurrency issues with getting the inserted identity value using
615 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
618 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
619 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
624 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
625 begin a transaction while there are active cursors. An active cursor is, for
626 example, a L<ResultSet|DBIx::Class::ResultSet> that has been executed using
627 C<next> or C<first> but has not been exhausted or
628 L<reset|DBIx::Class::ResultSet/reset>.
630 For example, this will not work:
632 $schema->txn_do(sub {
633 my $rs = $schema->resultset('Book');
634 while (my $row = $rs->next) {
635 $schema->resultset('MetaData')->create({
642 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
643 are not affected, as they use an extra database handle to do the insert.
649 =item * use L<DBIx::Class::Storage::DBI::Replicated>
651 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
653 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
657 =head1 MAXIMUM CONNECTIONS
659 The TDS protocol makes separate connections to the server for active statements
660 in the background. By default the number of such connections is limited to 25,
661 on both the client side and the server side.
663 This is a bit too low for a complex L<DBIx::Class> application, so on connection
664 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
665 can override it to whatever setting you like in the DSN.
668 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
669 for information on changing the setting on the server side.
673 See L</connect_call_datetime_setup> to setup date formats
674 for L<DBIx::Class::InflateColumn::DateTime>.
676 =head1 TEXT/IMAGE COLUMNS
678 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
679 C<TEXT/IMAGE> columns.
681 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
683 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
687 $schema->storage->set_textsize($bytes);
691 However, the C<LongReadLen> you pass in
692 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
693 C<SET TEXTSIZE> command on connection.
695 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
696 setting you need to work with C<IMAGE> columns.
700 See L<DBIx::Class/CONTRIBUTORS>.
704 You may distribute this code under the same terms as Perl itself.