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 $self->set_textsize; # based on LongReadLen in connect_info
95 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
96 # not necessarily FreeTDS, but no placeholders nevertheless
97 $self->ensure_class_loaded($no_bind_vars);
98 bless $self, $no_bind_vars;
100 } elsif (not $self->_typeless_placeholders_supported) {
101 # this is highly unlikely, but we check just in case
105 $self->_set_max_connect(256);
110 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
111 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
112 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
113 # only want when AutoCommit is off.
117 $self->next::method(@_);
119 if (not $self->using_freetds) {
120 $self->_dbh->{syb_chained_txn} = 1;
122 if ($self->_dbh_autocommit) {
123 $self->_dbh->do('SET CHAINED OFF');
125 $self->_dbh->do('SET CHAINED ON');
130 =head2 connect_call_blob_setup
134 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
136 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
137 instead of as a hex string.
141 Also sets the C<log_on_update> value for blob write operations. The default is
142 C<1>, but C<0> is better if your database is configured for it.
145 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
149 sub connect_call_blob_setup {
152 my $dbh = $self->_dbh;
153 $dbh->{syb_binary_images} = 1;
155 $self->_blob_log_on_update($args{log_on_update})
156 if exists $args{log_on_update};
162 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
165 sub _prep_for_execute {
167 my ($op, $extra_bind, $ident, $args) = @_;
169 my ($sql, $bind) = $self->next::method (@_);
171 if ($op eq 'insert') {
172 my $table = $ident->from;
174 my $bind_info = $self->_resolve_column_info(
175 $ident, [map $_->[0], @{$bind}]
177 my $identity_col = List::Util::first
178 { $bind_info->{$_}{is_auto_increment} }
184 "SET IDENTITY_INSERT $table ON",
186 "SET IDENTITY_INSERT $table OFF",
190 $identity_col = List::Util::first
191 { $ident->column_info($_)->{is_auto_increment} }
199 $self->_fetch_identity_sql($ident, $identity_col);
203 return ($sql, $bind);
206 # Stolen from SQLT, with some modifications. This is a makeshift
207 # solution before a sane type-mapping library is available, thus
208 # the 'our' for easy overrides.
209 our %TYPE_MAPPING = (
212 varchar => 'varchar',
213 varchar2 => 'varchar',
214 timestamp => 'datetime',
216 real => 'double precision',
219 tinyint => 'smallint',
220 float => 'double precision',
222 bigserial => 'numeric',
223 boolean => 'varchar',
227 sub _native_data_type {
228 my ($self, $type) = @_;
231 $type =~ s/\s* identity//x;
233 return uc($TYPE_MAPPING{$type} || $type);
236 sub _fetch_identity_sql {
237 my ($self, $source, $col) = @_;
239 return "SELECT MAX($col) FROM ".$source->from;
246 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
248 if ($op eq 'insert') {
249 $self->_identity($sth->fetchrow_array);
253 return wantarray ? ($rv, $sth, @bind) : $rv;
256 sub last_insert_id { shift->_identity }
258 # handles TEXT/IMAGE and transaction for last_insert_id
261 my ($source, $to_insert) = @_;
263 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
265 # insert+blob insert done atomically, on _insert_dbh
266 (my ($guard), local ($self->{_dbh})) = do {
267 $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info }))
268 unless $self->_insert_dbh;
270 my $new_guard = $self->txn_scope_guard;
272 # _dbh_begin_work may reconnect, if so we need to update _insert_dbh
273 $self->_insert_dbh($self->_dbh);
275 ($new_guard, $self->_insert_dbh)
278 my $need_last_insert_id = 0;
282 grep $_->[1]{is_auto_increment},
283 map [ $_, $source->column_info($_) ],
286 $need_last_insert_id = 1
287 if $identity_col && (not exists $to_insert->{$identity_col});
289 # We have to do the insert in a transaction to avoid race conditions with the
290 # SELECT MAX(COL) identity method used when placeholders are enabled.
291 my $updated_cols = do {
292 no warnings 'uninitialized';
294 $need_last_insert_id &&
295 $self->_identity_method ne '@@IDENTITY' &&
296 !$self->{transaction_depth}
298 $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info }))
299 unless $self->_insert_dbh;
300 local $self->{_dbh} = $self->_insert_dbh;
302 my $guard = $self->txn_scope_guard;
304 # _dbh_begin_work may reconnect, if so we need to update _insert_dbh
305 $self->_insert_dbh($self->_dbh);
307 my $upd_cols = $self->next::method (@_);
313 $self->next::method(@_);
317 $self->_insert_blobs($source, $blob_cols, $to_insert) if $blob_cols;
319 $guard->commit if $guard;
321 return $updated_cols;
326 my ($source, $fields, $where) = @_;
328 my $wantarray = wantarray;
330 my $blob_cols = $self->_remove_blob_cols($source, $fields);
332 # update+blob update(s) done atomically
333 my $guard = $self->txn_scope_guard if $blob_cols;
337 @res = $self->next::method(@_);
339 elsif (defined $wantarray) {
340 $res[0] = $self->next::method(@_);
343 $self->next::method(@_);
346 $self->_update_blobs($source, $blob_cols, $where) if $blob_cols;
348 $guard->commit if $guard;
350 return $wantarray ? @res : $res[0];
353 sub _remove_blob_cols {
354 my ($self, $source, $fields) = @_;
358 for my $col (keys %$fields) {
359 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
360 $blob_cols{$col} = delete $fields->{$col};
361 $fields->{$col} = \"''";
365 return keys %blob_cols ? \%blob_cols : undef;
369 my ($self, $source, $blob_cols, $where) = @_;
371 my (@primary_cols) = $source->primary_columns;
373 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
374 unless @primary_cols;
376 # check if we're updating a single row by PK
377 my $pk_cols_in_where = 0;
378 for my $col (@primary_cols) {
379 $pk_cols_in_where++ if defined $where->{$col};
383 if ($pk_cols_in_where == @primary_cols) {
385 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
386 @rows = \%row_to_update;
388 my $rs = $source->resultset->search(
391 result_class => 'DBIx::Class::ResultClass::HashRefInflator',
392 select => \@primary_cols
395 @rows = $rs->all; # statement must finish
398 for my $row (@rows) {
399 $self->_insert_blobs($source, $blob_cols, $row);
404 my ($self, $source, $blob_cols, $row) = @_;
405 my $dbh = $self->_get_dbh;
407 my $table = $source->from;
410 my (@primary_cols) = $source->primary_columns;
412 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
413 unless @primary_cols;
415 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
416 if (@primary_cols == 1) {
417 my $col = $primary_cols[0];
418 $row{$col} = $self->last_insert_id($source, $col);
420 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
424 for my $col (keys %$blob_cols) {
425 my $blob = $blob_cols->{$col};
427 my %where = map { ($_, $row{$_}) } @primary_cols;
428 my $cursor = $source->resultset->search(\%where, {
432 my $sth = $cursor->sth;
436 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
439 $sth->func('ct_prepare_send') or die $sth->errstr;
441 my $log_on_update = $self->_blob_log_on_update;
442 $log_on_update = 1 if not defined $log_on_update;
444 $sth->func('CS_SET', 1, {
445 total_txtlen => length($blob),
446 log_on_update => $log_on_update
447 }, 'ct_data_info') or die $sth->errstr;
449 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
451 $sth->func('ct_finish_send') or die $sth->errstr;
454 $sth->finish if $sth;
456 if ($self->using_freetds) {
458 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
468 =head2 connect_call_datetime_setup
472 on_connect_call => 'datetime_setup'
474 In L<DBIx::Class::Storage::DBI/connect_info> to set:
476 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
477 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
479 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
480 L<DateTime::Format::Sybase>, which you will need to install.
482 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
483 C<SMALLDATETIME> columns only have minute precision.
488 my $old_dbd_warned = 0;
490 sub connect_call_datetime_setup {
492 my $dbh = $self->_dbh;
494 if ($dbh->can('syb_date_fmt')) {
495 # amazingly, this works with FreeTDS
496 $dbh->syb_date_fmt('ISO_strict');
497 } elsif (not $old_dbd_warned) {
498 carp "Your DBD::Sybase is too old to support ".
499 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
503 $dbh->do('SET DATEFORMAT mdy');
509 sub datetime_parser_type { "DateTime::Format::Sybase" }
511 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
512 # let the DBD keep any state it needs to.
514 # If they ever do start working, the extra statements will do no harm (because
515 # Sybase supports nested transactions.)
517 sub _dbh_begin_work {
519 $self->next::method(@_);
520 if ($self->using_freetds) {
521 $self->_get_dbh->do('BEGIN TRAN');
527 if ($self->using_freetds) {
528 $self->_dbh->do('COMMIT');
530 return $self->next::method(@_);
535 if ($self->using_freetds) {
536 $self->_dbh->do('ROLLBACK');
538 return $self->next::method(@_);
541 # savepoint support using ASE syntax
544 my ($self, $name) = @_;
546 $self->_get_dbh->do("SAVE TRANSACTION $name");
549 # A new SAVE TRANSACTION with the same name releases the previous one.
550 sub _svp_release { 1 }
553 my ($self, $name) = @_;
555 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
560 =head1 Schema::Loader Support
562 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
563 allow you to dump a schema from most (if not all) versions of Sybase.
565 It is available via subversion from:
567 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
571 This driver supports L<DBD::Sybase> compiled against FreeTDS
572 (L<http://www.freetds.org/>) to the best of our ability, however it is
573 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
574 libraries. They are a part of the Sybase ASE distribution:
576 The Open Client FAQ is here:
577 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
579 Sybase ASE for Linux (which comes with the Open Client libraries) may be
580 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
582 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
584 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
586 Some versions of the libraries involved will not support placeholders, in which
587 case the storage will be reblessed to
588 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
590 In some configurations, placeholders will work but will throw implicit type
591 conversion errors for anything that's not expecting a string. In such a case,
592 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
593 automatically set, which you may enable on connection with
594 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
595 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
596 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
597 already) using a mapping based on L<SQL::Translator>.
599 In other configurations, placeholers will work just as they do with the Sybase
600 Open Client libraries.
602 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
604 =head1 INSERTS WITH PLACEHOLDERS
606 With placeholders enabled, inserts are done in a transaction so that there are
607 no concurrency issues with getting the inserted identity value using
608 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
611 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
612 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
617 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
618 begin a transaction while there are active cursors. An active cursor is, for
619 example, a L<ResultSet|DBIx::Class::ResultSet> that has been executed using
620 C<next> or C<first> but has not been exhausted or
621 L<reset|DBIx::Class::ResultSet/reset>.
623 For example, this will not work:
625 $schema->txn_do(sub {
626 my $rs = $schema->resultset('Book');
627 while (my $row = $rs->next) {
628 $schema->resultset('MetaData')->create({
635 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
636 are not affected, as they use an extra database handle to do the insert.
642 =item * use L<DBIx::Class::Storage::DBI::Replicated>
644 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
646 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
650 =head1 MAXIMUM CONNECTIONS
652 The TDS protocol makes separate connections to the server for active statements
653 in the background. By default the number of such connections is limited to 25,
654 on both the client side and the server side.
656 This is a bit too low for a complex L<DBIx::Class> application, so on connection
657 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
658 can override it to whatever setting you like in the DSN.
661 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
662 for information on changing the setting on the server side.
666 See L</connect_call_datetime_setup> to setup date formats
667 for L<DBIx::Class::InflateColumn::DateTime>.
669 =head1 TEXT/IMAGE COLUMNS
671 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
672 C<TEXT/IMAGE> columns.
674 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
676 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
680 $schema->storage->set_textsize($bytes);
684 However, the C<LongReadLen> you pass in
685 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
686 C<SET TEXTSIZE> command on connection.
688 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
689 setting you need to work with C<IMAGE> columns.
693 See L<DBIx::Class/CONTRIBUTORS>.
697 You may distribute this code under the same terms as Perl itself.