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 _writer_storage _is_writer_storage
20 my @also_proxy_to_writer_storage = qw/
21 disconnect _connect_info _sql_maker _sql_maker_opts disable_sth_caching
22 auto_savepoint unsafe cursor_class debug debugobj schema
27 DBIx::Class::Storage::DBI::Sybase - Sybase support for DBIx::Class
31 This subclass supports L<DBD::Sybase> for real Sybase databases. If you are
32 using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
33 L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
37 If your version of Sybase does not support placeholders, then your storage
38 will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
39 also enable that driver explicitly, see the documentation for more details.
41 With this driver there is unfortunately no way to get the C<last_insert_id>
42 without doing a C<SELECT MAX(col)>. This is done safely in a transaction
43 (locking the table.) See L</INSERTS WITH PLACEHOLDERS>.
45 A recommended L<DBIx::Class::Storage::DBI/connect_info> setting:
47 on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]]
56 if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
58 @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
63 my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
65 if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
66 bless $self, $subclass;
68 } else { # real Sybase
69 my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars';
71 if ($self->using_freetds) {
72 carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN};
74 You are using FreeTDS with Sybase.
76 We will do our best to support this configuration, but please consider this
79 TEXT/IMAGE columns will definitely not work.
81 You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries
84 See perldoc DBIx::Class::Storage::DBI::Sybase for more details.
86 To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment
89 if (not $self->_typeless_placeholders_supported) {
90 if ($self->_placeholders_supported) {
93 $self->ensure_class_loaded($no_bind_vars);
94 bless $self, $no_bind_vars;
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
114 $self->_set_max_connect(256);
116 # based on LongReadLen in connect_info
117 $self->set_textsize if $self->using_freetds;
119 # create storage for insert/(update blob) transactions,
120 # unless this is that storage
121 return if $self->_is_writer_storage;
123 my $writer_storage = (ref $self)->new;
125 $writer_storage->_is_writer_storage(1);
126 $writer_storage->connect_info($self->connect_info);
128 $self->_writer_storage($writer_storage);
131 for my $method (@also_proxy_to_writer_storage) {
134 my $replaced = __PACKAGE__->can($method);
136 *{$method} = Sub::Name::subname __PACKAGE__."::$method" => sub {
138 $self->_writer_storage->$replaced(@_) if $self->_writer_storage;
139 return $self->$replaced(@_);
143 # Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS
144 # DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however
145 # we're using FreeTDS, CHAINED mode turns on an implicit transaction which we
146 # only want when AutoCommit is off.
150 $self->next::method(@_);
152 if (not $self->using_freetds) {
153 $self->_dbh->{syb_chained_txn} = 1;
155 if ($self->_dbh_autocommit) {
156 $self->_dbh->do('SET CHAINED OFF');
158 $self->_dbh->do('SET CHAINED ON');
163 =head2 connect_call_blob_setup
167 on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ]
169 Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
170 instead of as a hex string.
174 Also sets the C<log_on_update> value for blob write operations. The default is
175 C<1>, but C<0> is better if your database is configured for it.
178 L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
182 sub connect_call_blob_setup {
185 my $dbh = $self->_dbh;
186 $dbh->{syb_binary_images} = 1;
188 $self->_blob_log_on_update($args{log_on_update})
189 if exists $args{log_on_update};
195 $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i;
198 sub _prep_for_execute {
200 my ($op, $extra_bind, $ident, $args) = @_;
202 my ($sql, $bind) = $self->next::method (@_);
204 if ($op eq 'insert') {
205 my $table = $ident->from;
207 my $bind_info = $self->_resolve_column_info(
208 $ident, [map $_->[0], @{$bind}]
210 my $identity_col = List::Util::first
211 { $bind_info->{$_}{is_auto_increment} }
217 "SET IDENTITY_INSERT $table ON",
219 "SET IDENTITY_INSERT $table OFF",
223 $identity_col = List::Util::first
224 { $ident->column_info($_)->{is_auto_increment} }
232 $self->_fetch_identity_sql($ident, $identity_col);
236 return ($sql, $bind);
239 # Stolen from SQLT, with some modifications. This is a makeshift
240 # solution before a sane type-mapping library is available, thus
241 # the 'our' for easy overrides.
242 our %TYPE_MAPPING = (
245 varchar => 'varchar',
246 varchar2 => 'varchar',
247 timestamp => 'datetime',
249 real => 'double precision',
252 tinyint => 'smallint',
253 float => 'double precision',
255 bigserial => 'numeric',
256 boolean => 'varchar',
260 sub _native_data_type {
261 my ($self, $type) = @_;
264 $type =~ s/\s* identity//x;
266 return uc($TYPE_MAPPING{$type} || $type);
269 sub _fetch_identity_sql {
270 my ($self, $source, $col) = @_;
272 return sprintf ("SELECT MAX(%s) FROM %s",
273 map { $self->sql_maker->_quote ($_) } ($col, $source->from)
281 my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
283 if ($op eq 'insert') {
284 $self->_identity($sth->fetchrow_array);
288 return wantarray ? ($rv, $sth, @bind) : $rv;
291 sub last_insert_id { shift->_identity }
293 # handles TEXT/IMAGE and transaction for last_insert_id
296 my ($source, $to_insert) = @_;
298 my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
300 my $identity_col = List::Util::first
301 { $source->column_info($_)->{is_auto_increment} }
304 # do we need the horrific SELECT MAX(COL) hack?
305 my $dumb_last_insert_id =
307 && (not exists $to_insert->{$identity_col})
308 && ($self->_identity_method||'') ne '@@IDENTITY';
310 my $next = $self->next::can;
312 # we are already in a transaction, or there are no blobs
313 # and we don't need the PK - just (try to) do it
314 if ($self->{transaction_depth}
315 || (!$blob_cols && !$dumb_last_insert_id)
317 return $self->_insert (
318 $next, $source, $to_insert, $blob_cols, $identity_col
322 # otherwise use the _writer_storage to do the insert+transaction on another
324 my $guard = $self->_writer_storage->txn_scope_guard;
326 my $updated_cols = $self->_writer_storage->_insert (
327 $next, $source, $to_insert, $blob_cols, $identity_col
330 $self->_identity($self->_writer_storage->_identity);
334 return $updated_cols;
338 my ($self, $next, $source, $to_insert, $blob_cols, $identity_col) = @_;
340 my $updated_cols = $self->$next ($source, $to_insert);
343 $identity_col => $self->last_insert_id($source, $identity_col),
348 $self->_insert_blobs ($source, $blob_cols, $final_row) if $blob_cols;
350 return $updated_cols;
355 my ($source, $fields, $where) = @_;
357 my $wantarray = wantarray;
358 my $blob_cols = $self->_remove_blob_cols($source, $fields);
360 if (not $blob_cols) {
361 return $self->next::method(@_);
364 # update+blob update(s) done atomically on separate connection
365 $self = $self->_writer_storage;
367 my $guard = $self->txn_scope_guard;
371 @res = $self->next::method(@_);
373 elsif (defined $wantarray) {
374 $res[0] = $self->next::method(@_);
377 $self->next::method(@_);
380 $self->_update_blobs($source, $blob_cols, $where);
384 return $wantarray ? @res : $res[0];
387 ### the insert_bulk stuff stolen from DBI/MSSQL.pm
389 sub _set_identity_insert {
390 my ($self, $table) = @_;
393 'SET IDENTITY_INSERT %s ON',
394 $self->sql_maker->_quote ($table),
397 my $dbh = $self->_get_dbh;
398 eval { $dbh->do ($sql) };
400 $self->throw_exception (sprintf "Error executing '%s': %s",
407 sub _unset_identity_insert {
408 my ($self, $table) = @_;
411 'SET IDENTITY_INSERT %s OFF',
412 $self->sql_maker->_quote ($table),
415 my $dbh = $self->_get_dbh;
419 # XXX this should use the DBD::Sybase bulk API, where possible
422 my ($source, $cols, $data) = @_;
424 my $is_identity_insert = (List::Util::first
425 { $source->column_info ($_)->{is_auto_increment} }
431 if ($is_identity_insert) {
432 $self->_set_identity_insert ($source->name);
435 $self->next::method(@_);
437 if ($is_identity_insert) {
438 $self->_unset_identity_insert ($source->name);
442 ### end of stolen insert_bulk section
444 sub _remove_blob_cols {
445 my ($self, $source, $fields) = @_;
449 for my $col (keys %$fields) {
450 if ($self->_is_lob_type($source->column_info($col)->{data_type})) {
451 $blob_cols{$col} = delete $fields->{$col};
452 $fields->{$col} = \"''";
456 return keys %blob_cols ? \%blob_cols : undef;
460 my ($self, $source, $blob_cols, $where) = @_;
462 my (@primary_cols) = $source->primary_columns;
464 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
465 unless @primary_cols;
467 # check if we're updating a single row by PK
468 my $pk_cols_in_where = 0;
469 for my $col (@primary_cols) {
470 $pk_cols_in_where++ if defined $where->{$col};
474 if ($pk_cols_in_where == @primary_cols) {
476 @row_to_update{@primary_cols} = @{$where}{@primary_cols};
477 @rows = \%row_to_update;
479 my $cursor = $self->select ($source, \@primary_cols, $where, {});
481 my %row; @row{@primary_cols} = @$_; \%row
485 for my $row (@rows) {
486 $self->_insert_blobs($source, $blob_cols, $row);
491 my ($self, $source, $blob_cols, $row) = @_;
492 my $dbh = $self->_get_dbh;
494 my $table = $source->from;
497 my (@primary_cols) = $source->primary_columns;
499 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without a primary key')
500 unless @primary_cols;
502 $self->throw_exception('Cannot update TEXT/IMAGE column(s) without primary key values')
503 if ((grep { defined $row{$_} } @primary_cols) != @primary_cols);
505 for my $col (keys %$blob_cols) {
506 my $blob = $blob_cols->{$col};
508 my %where = map { ($_, $row{$_}) } @primary_cols;
510 my $cursor = $self->select ($source, [$col], \%where, {});
512 my $sth = $cursor->sth;
516 $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
519 $sth->func('ct_prepare_send') or die $sth->errstr;
521 my $log_on_update = $self->_blob_log_on_update;
522 $log_on_update = 1 if not defined $log_on_update;
524 $sth->func('CS_SET', 1, {
525 total_txtlen => length($blob),
526 log_on_update => $log_on_update
527 }, 'ct_data_info') or die $sth->errstr;
529 $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
531 $sth->func('ct_finish_send') or die $sth->errstr;
534 $sth->finish if $sth;
536 if ($self->using_freetds) {
537 $self->throw_exception (
538 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: '
542 $self->throw_exception($exception);
548 =head2 connect_call_datetime_setup
552 on_connect_call => 'datetime_setup'
554 In L<DBIx::Class::Storage::DBI/connect_info> to set:
556 $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
557 $dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
559 On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
560 L<DateTime::Format::Sybase>, which you will need to install.
562 This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
563 C<SMALLDATETIME> columns only have minute precision.
568 my $old_dbd_warned = 0;
570 sub connect_call_datetime_setup {
572 my $dbh = $self->_dbh;
574 if ($dbh->can('syb_date_fmt')) {
575 # amazingly, this works with FreeTDS
576 $dbh->syb_date_fmt('ISO_strict');
577 } elsif (not $old_dbd_warned) {
578 carp "Your DBD::Sybase is too old to support ".
579 "DBIx::Class::InflateColumn::DateTime, please upgrade!";
583 $dbh->do('SET DATEFORMAT mdy');
589 sub datetime_parser_type { "DateTime::Format::Sybase" }
591 # ->begin_work and such have no effect with FreeTDS but we run them anyway to
592 # let the DBD keep any state it needs to.
594 # If they ever do start working, the extra statements will do no harm (because
595 # Sybase supports nested transactions.)
597 sub _dbh_begin_work {
599 $self->next::method(@_);
600 if ($self->using_freetds) {
601 $self->_get_dbh->do('BEGIN TRAN');
607 if ($self->using_freetds) {
608 $self->_dbh->do('COMMIT');
610 return $self->next::method(@_);
615 if ($self->using_freetds) {
616 $self->_dbh->do('ROLLBACK');
618 return $self->next::method(@_);
621 # savepoint support using ASE syntax
624 my ($self, $name) = @_;
626 $self->_get_dbh->do("SAVE TRANSACTION $name");
629 # A new SAVE TRANSACTION with the same name releases the previous one.
630 sub _svp_release { 1 }
633 my ($self, $name) = @_;
635 $self->_get_dbh->do("ROLLBACK TRANSACTION $name");
640 =head1 Schema::Loader Support
642 There is an experimental branch of L<DBIx::Class::Schema::Loader> that will
643 allow you to dump a schema from most (if not all) versions of Sybase.
645 It is available via subversion from:
647 http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/
651 This driver supports L<DBD::Sybase> compiled against FreeTDS
652 (L<http://www.freetds.org/>) to the best of our ability, however it is
653 recommended that you recompile L<DBD::Sybase> against the Sybase Open Client
654 libraries. They are a part of the Sybase ASE distribution:
656 The Open Client FAQ is here:
657 L<http://www.isug.com/Sybase_FAQ/ASE/section7.html>.
659 Sybase ASE for Linux (which comes with the Open Client libraries) may be
660 downloaded here: L<http://response.sybase.com/forms/ASE_Linux_Download>.
662 To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run:
664 perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}'
666 Some versions of the libraries involved will not support placeholders, in which
667 case the storage will be reblessed to
668 L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>.
670 In some configurations, placeholders will work but will throw implicit type
671 conversion errors for anything that's not expecting a string. In such a case,
672 the C<auto_cast> option from L<DBIx::Class::Storage::DBI::AutoCast> is
673 automatically set, which you may enable on connection with
674 L<DBIx::Class::Storage::DBI::AutoCast/connect_call_set_auto_cast>. The type info
675 for the C<CAST>s is taken from the L<DBIx::Class::ResultSource/data_type>
676 definitions in your Result classes, and are mapped to a Sybase type (if it isn't
677 already) using a mapping based on L<SQL::Translator>.
679 In other configurations, placeholers will work just as they do with the Sybase
680 Open Client libraries.
682 Inserts or updates of TEXT/IMAGE columns will B<NOT> work with FreeTDS.
684 =head1 INSERTS WITH PLACEHOLDERS
686 With placeholders enabled, inserts are done in a transaction so that there are
687 no concurrency issues with getting the inserted identity value using
688 C<SELECT MAX(col)>, which is the only way to get the C<IDENTITY> value in this
691 In addition, they are done on a separate connection so that it's possible to
692 have active cursors when doing an insert.
694 When using C<DBIx::Class::Storage::DBI::Sybase::NoBindVars> transactions are
695 disabled, as there are no concurrency issues with C<SELECT @@IDENTITY> as it's a
700 Due to limitations of the TDS protocol, L<DBD::Sybase>, or both; you cannot
701 begin a transaction while there are active cursors. An active cursor is, for
702 example, a L<ResultSet|DBIx::Class::ResultSet> that has been executed using
703 C<next> or C<first> but has not been exhausted or
704 L<reset|DBIx::Class::ResultSet/reset>.
706 For example, this will not work:
708 $schema->txn_do(sub {
709 my $rs = $schema->resultset('Book');
710 while (my $row = $rs->next) {
711 $schema->resultset('MetaData')->create({
718 Transactions done for inserts in C<AutoCommit> mode when placeholders are in use
719 are not affected, as they are done on an extra database handle.
725 =item * use L<DBIx::Class::Storage::DBI::Replicated>
727 =item * L<connect|DBIx::Class::Schema/connect> another L<Schema|DBIx::Class::Schema>
729 =item * load the data from your cursor with L<DBIx::Class::ResultSet/all>
733 =head1 MAXIMUM CONNECTIONS
735 The TDS protocol makes separate connections to the server for active statements
736 in the background. By default the number of such connections is limited to 25,
737 on both the client side and the server side.
739 This is a bit too low for a complex L<DBIx::Class> application, so on connection
740 the client side setting is set to C<256> (see L<DBD::Sybase/maxConnect>.) You
741 can override it to whatever setting you like in the DSN.
744 L<http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.ase_15.0.sag1/html/sag1/sag1272.htm>
745 for information on changing the setting on the server side.
749 See L</connect_call_datetime_setup> to setup date formats
750 for L<DBIx::Class::InflateColumn::DateTime>.
752 =head1 TEXT/IMAGE COLUMNS
754 L<DBD::Sybase> compiled with FreeTDS will B<NOT> allow you to insert or update
755 C<TEXT/IMAGE> columns.
757 Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either:
759 $schema->storage->dbh->do("SET TEXTSIZE $bytes");
763 $schema->storage->set_textsize($bytes);
767 However, the C<LongReadLen> you pass in
768 L<DBIx::Class::Storage::DBI/connect_info> is used to execute the equivalent
769 C<SET TEXTSIZE> command on connection.
771 See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
772 setting you need to work with C<IMAGE> columns.
776 See L<DBIx::Class/CONTRIBUTORS>.
780 You may distribute this code under the same terms as Perl itself.