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, 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 # This is reset to 0 in ::NoBindVars, only necessary because we use max(col) to
72 if ($self->using_freetds) {
73 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
75 You are using FreeTDS with Sybase.
77 We will do our best to support this configuration, but please consider this
80 TEXT/IMAGE columns will definitely not work.
82 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
85 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
87 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
90 if (not $self->_typeless_placeholders_supported) {
91 if ($self->_placeholders_supported) {
94 $self->ensure_class_loaded($no_bind_vars);
95 bless $self, $no_bind_vars;
100 $self->set_textsize; # based on LongReadLen in connect_info
103 elsif (not $self->_get_dbh->{syb_dynamic_supported}) {
104 # not necessarily FreeTDS, but no placeholders nevertheless
105 $self->ensure_class_loaded($no_bind_vars);
106 bless $self, $no_bind_vars;
108 } elsif (not $self->_typeless_placeholders_supported) {
109 # this is highly unlikely, but we check just in case
113 $self->_set_max_connect(256);
118 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
119 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
120 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
121 # only want when AutoCommit is off.
125 $self->next::method(@_);
127 if (not $self->using_freetds) {
128 $self->_dbh->{syb_chained_txn} = 1;
130 if ($self->_dbh_autocommit) {
131 $self->_dbh->do('SET CHAINED OFF');
133 $self->_dbh->do('SET CHAINED ON');
138 =head2 connect_call_blob_setup
142 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
144 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
145 instead of as a hex string.
149 Also sets the C<log_on_update> value for blob write operations. The default is
150 C<1>, but C<0> is better if your database is configured for it.
153 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
157 sub connect_call_blob_setup {
160 my $dbh = $self->_dbh;
161 $dbh->{syb_binary_images} = 1;
163 $self->_blob_log_on_update($args{log_on_update})
164 if exists $args{log_on_update};
167 =head2 connect_call_unsafe_insert
169 With placeholders enabled, inserts are done in a transaction so that there are
170 no concurrency issues with getting the inserted identity value using
171 C<SELECT MAX(col)> when placeholders are enabled.
173 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
176 To turn off transactions for inserts (for an application that doesn't need
177 concurrency, or a loader, for example) use this setting in
178 L<DBIx::Class::Storage::DBI/connect_info>,
180 on_connect_call => ['unsafe_insert']
182 To manipulate this setting at runtime, use:
184 $schema->storage->insert_txn(0); # 1 to re-enable
188 sub connect_call_unsafe_insert {
190 $self->insert_txn(0);
196 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
199 sub _prep_for_execute {
201 my ($op, $extra_bind, $ident, $args) = @_;
203 my ($sql, $bind) = $self->next::method (@_);
205 if ($op eq 'insert') {
206 my $table = $ident->from;
208 my $bind_info = $self->_resolve_column_info(
209 $ident, [map $_->[0], @{$bind}]
211 my $identity_col = List::Util::first
212 { $bind_info->{$_}{is_auto_increment} }
218 "SET IDENTITY_INSERT $table ON",
220 "SET IDENTITY_INSERT $table OFF",
224 $identity_col = List::Util::first
225 { $ident->column_info($_)->{is_auto_increment} }
233 $self->_fetch_identity_sql($ident, $identity_col);
237 return ($sql, $bind);
240 # Stolen from SQLT, with some modifications. This is a makeshift
241 # solution before a sane type-mapping library is available, thus
242 # the 'our' for easy overrides.
243 our %TYPE_MAPPING = (
246 varchar => 'varchar',
247 varchar2 => 'varchar',
248 timestamp => 'datetime',
250 real => 'double precision',
253 tinyint => 'smallint',
254 float => 'double precision',
256 bigserial => 'numeric',
257 boolean => 'varchar',
261 sub _native_data_type {
262 my ($self, $type) = @_;
265 $type =~ s/ identity//;
267 return uc($TYPE_MAPPING{$type} || $type);
270 sub _fetch_identity_sql {
271 my ($self, $source, $col) = @_;
273 return "SELECT MAX($col) FROM ".$source->from;
280 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
282 if ($op eq 'insert') {
283 $self->_identity($sth->fetchrow_array);
287 return wantarray ? ($rv, $sth, @bind) : $rv;
290 sub last_insert_id { shift->_identity }
292 # handles TEXT/IMAGE and transaction for last_insert_id
295 my ($source, $to_insert) = @_;
297 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
299 # insert+blob insert done atomically
300 my $guard = $self->txn_scope_guard if %$blob_cols;
302 my $need_last_insert_id = 0;
306 grep $_->[1]{is_auto_increment},
307 map [ $_, $source->column_info($_) ],
310 $need_last_insert_id = 1
311 if $identity_col && (not exists $to_insert->{$identity_col});
313 # We have to do the insert in a transaction to avoid race conditions with the
314 # SELECT MAX(COL) identity method used when placeholders are enabled.
315 my $updated_cols = do {
316 if ($need_last_insert_id && $self->insert_txn &&
317 (not $self->{transaction_depth})) {
318 my $guard = $self->txn_scope_guard;
319 my $upd_cols = $self->next::method (@_);
324 $self->next::method(@_);
328 $self->_insert_blobs($source, $blob_cols, $to_insert) if %$blob_cols;
330 $guard->commit if $guard;
332 return $updated_cols;
337 my ($source, $fields, $where) = @_;
339 my $wantarray = wantarray;
341 my $blob_cols = $self->_remove_blob_cols($source, $fields);
343 # update+blob update(s) done atomically
344 my $guard = $self->txn_scope_guard if %$blob_cols;
348 @res = $self->next::method(@_);
350 elsif (defined $wantarray) {
351 $res[0] = $self->next::method(@_);
354 $self->next::method(@_);
357 $self->_update_blobs($source, $blob_cols, $where) if %$blob_cols;
359 $guard->commit if %$blob_cols;
361 return $wantarray ? @res : $res[0];
364 sub _remove_blob_cols {
365 my ($self, $source, $fields) = @_;
369 for my $col (keys %$fields) {
370 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
371 $blob_cols{$col} = delete $fields->{$col};
372 $fields->{$col} = \"''";
380 my ($self, $source, $blob_cols, $where) = @_;
382 my (@primary_cols) = $source->primary_columns;
384 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
385 unless @primary_cols;
387 # check if we're updating a single row by PK
388 my $pk_cols_in_where = 0;
389 for my $col (@primary_cols) {
390 $pk_cols_in_where++ if defined $where->{$col};
394 if ($pk_cols_in_where == @primary_cols) {
396 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
397 @rows = \%row_to_update;
399 my $rs = $source->resultset->search(
402 result_class => 'DBIx::Class::ResultClass::HashRefInflator',
403 select => \@primary_cols
406 @rows = $rs->all; # statement must finish
409 for my $row (@rows) {
410 $self->_insert_blobs($source, $blob_cols, $row);
415 my ($self, $source, $blob_cols, $row) = @_;
416 my $dbh = $self->_get_dbh;
418 my $table = $source->from;
421 my (@primary_cols) = $source->primary_columns;
423 croak "Cannot update TEXT/IMAGE column(s) without a primary key"
424 unless @primary_cols;
426 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) {
427 if (@primary_cols == 1) {
428 my $col = $primary_cols[0];
429 $row{$col} = $self->last_insert_id($source, $col);
431 croak "Cannot update TEXT/IMAGE column(s) without primary key values";
435 for my $col (keys %$blob_cols) {
436 my $blob = $blob_cols->{$col};
438 my %where = map { ($_, $row{$_}) } @primary_cols;
439 my $cursor = $source->resultset->search(\%where, {
443 my $sth = $cursor->sth;
447 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
450 $sth->func('ct_prepare_send') or die $sth->errstr;
452 my $log_on_update = $self->_blob_log_on_update;
453 $log_on_update = 1 if not defined $log_on_update;
455 $sth->func('CS_SET', 1, {
456 total_txtlen => length($blob),
457 log_on_update => $log_on_update
458 }, 'ct_data_info') or die $sth->errstr;
460 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
462 $sth->func('ct_finish_send') or die $sth->errstr;
465 $sth->finish if $sth;
467 if ($self->using_freetds) {
469 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
479 =head2 connect_call_datetime_setup
483 on_connect_call => 'datetime_setup'
485 In L<DBIx::Class::Storage::DBI/connect_info> to set:
487 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
488 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
490 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
491 L<DateTime::Format::Sybase>, which you will need to install.
493 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
494 C<SMALLDATETIME> columns only have minute precision.
499 my $old_dbd_warned = 0;
501 sub connect_call_datetime_setup {
503 my $dbh = $self->_dbh;
505 if ($dbh->can('syb_date_fmt')) {
506 # amazingly, this works with FreeTDS
507 $dbh->syb_date_fmt('ISO_strict');
508 } elsif (not $old_dbd_warned) {
509 carp "Your DBD::Sybase is too old to support ".
510 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
514 $dbh->do('SET DATEFORMAT mdy');
520 sub datetime_parser_type { "DateTime::Format::Sybase" }
522 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
523 # let the DBD keep any state it needs to.
525 # If they ever do start working, the extra statements will do no harm (because
526 # Sybase supports nested transactions.)
528 sub _dbh_begin_work {
530 $self->next::method(@_);
531 if ($self->using_freetds) {
532 $self->_get_dbh->do('BEGIN TRAN');
538 if ($self->using_freetds) {
539 $self->_dbh->do('COMMIT');
541 return $self->next::method(@_);
546 if ($self->using_freetds) {
547 $self->_dbh->do('ROLLBACK');
549 return $self->next::method(@_);
552 # savepoint support using ASE syntax
555 my ($self, $name) = @_;
557 $self->_get_dbh->do("SAVE TRANSACTION $name");
560 # A new SAVE TRANSACTION with the same name releases the previous one.
561 sub _svp_release { 1 }
564 my ($self, $name) = @_;
566 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
571 =head1 Schema::Loader Support
573 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
574 allow you to dump a schema from most (if not all) versions of Sybase.
576 It is available via subversion from:
578 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
582 This driver supports L<DBD::Sybase> compiled against FreeTDS
583 (L<http://www.freetds.org/>) to the best of our ability, however it is
584 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
585 libraries. They are a part of the Sybase ASE distribution:
587 The Open Client FAQ is here:
588 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
590 Sybase ASE for Linux (which comes with the Open Client libraries) may be
591 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
593 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
595 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
597 Some versions of the libraries involved will not support placeholders, in which
598 case the storage will be reblessed to
599 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
601 In some configurations, placeholders will work but will throw implicit type
602 conversion errors for anything that's not expecting a string. In such a case,
603 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
604 automatically set, which you may enable on connection with
605 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
606 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
607 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
608 already) using a mapping based on L<SQL::Translator>.
610 In other configurations, placeholers will work just as they do with the Sybase
611 Open Client libraries.
613 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
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 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
624 are also affected, so this won't work:
626 while (my $row = $rs1->next) {
627 $rs2->create({ foo => $row->foo });
634 =item * set C<< $schema->storage->insert_txn(0) >> temporarily (see
635 L</connect_call_unsafe_insert>)
637 =item * use L<DBIx::Class::Storage::DBI::Replicated>
639 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
641 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
643 =item * enlarge the scope of the transaction
647 =head1 MAXIMUM CONNECTIONS
649 The TDS protocol makes separate connections to the server for active statements
650 in the background. By default the number of such connections is limited to 25,
651 on both the client side and the server side.
653 This is a bit too low for a complex L<DBIx::Class> application, so on connection
654 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
655 can override it to whatever setting you like in the DSN.
658 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
659 for information on changing the setting on the server side.
663 See L</connect_call_datetime_setup> to setup date formats
664 for L<DBIx::Class::InflateColumn::DateTime>.
666 =head1 TEXT/IMAGE COLUMNS
668 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
669 C<TEXT/IMAGE> columns.
671 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
673 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
677 $schema->storage->set_textsize($bytes);
681 However, the C<LongReadLen> you pass in
682 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
683 C<SET TEXTSIZE> command on connection.
685 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
686 setting you need to work with C<IMAGE> columns.
690 See L<DBIx::Class/CONTRIBUTORS>.
694 You may distribute this code under the same terms as Perl itself.