X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FDBI%2FSybase.pm;h=43932fac8084722eb55840b2e92a1cc890e3309f;hb=322b7a6b;hp=46da4a234e472a60ec167c32b355a420ad50b98c;hpb=b0b44f974ad33fb7e2e899dcd844392eb09287d7;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Storage/DBI/Sybase.pm b/lib/DBIx/Class/Storage/DBI/Sybase.pm index 46da4a2..43932fa 100644 --- a/lib/DBIx/Class/Storage/DBI/Sybase.pm +++ b/lib/DBIx/Class/Storage/DBI/Sybase.pm @@ -2,16 +2,22 @@ package DBIx::Class::Storage::DBI::Sybase; use strict; use warnings; -use mro 'c3'; + use base qw/ - DBIx::Class::Storage::DBI::Sybase::Base - DBIx::Class::Storage::DBI + DBIx::Class::Storage::DBI::Sybase::Common + DBIx::Class::Storage::DBI::AutoCast /; +use mro 'c3'; use Carp::Clan qw/^DBIx::Class/; +use List::Util (); + +__PACKAGE__->mk_group_accessors('simple' => + qw/_identity _blob_log_on_update _insert_dbh _identity_method/ +); =head1 NAME -DBIx::Class::Storage::DBI::Sybase - Storage::DBI subclass for Sybase +DBIx::Class::Storage::DBI::Sybase - Sybase support for DBIx::Class =head1 SYNOPSIS @@ -26,28 +32,23 @@ will be reblessed to L. You can also enable that driver explicitly, see the documentation for more details. With this driver there is unfortunately no way to get the C -without doing a C. This is done safely in a transaction +(locking the table.) See L. -But your queries will be cached. +A recommended L setting: -A recommended L settings: - - on_connect_call => [['datetime_setup'], [blob_setup => log_on_update => 0]] + on_connect_call => [['datetime_setup'], ['blob_setup', log_on_update => 0]] =head1 METHODS =cut -__PACKAGE__->mk_group_accessors('simple' => - qw/_blob_log_on_update/ -); - sub _rebless { my $self = shift; if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') { my $dbtype = eval { - @{$self->dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2] + @{$self->_get_dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2] } || ''; my $exception = $@; @@ -57,12 +58,71 @@ sub _rebless { if (!$exception && $dbtype && $self->load_optional_class($subclass)) { bless $self, $subclass; $self->_rebless; - } else { - # real Sybase - if (not $self->dbh->{syb_dynamic_supported}) { - bless $self, 'DBIx::Class::Storage:DBI::Sybase::NoBindVars'; + } else { # real Sybase + my $no_bind_vars = 'DBIx::Class::Storage::DBI::Sybase::NoBindVars'; + + if ($self->using_freetds) { + carp <<'EOF' unless $ENV{DBIC_SYBASE_FREETDS_NOWARN}; + +You are using FreeTDS with Sybase. + +We will do our best to support this configuration, but please consider this +support experimental. + +TEXT/IMAGE columns will definitely not work. + +You are encouraged to recompile DBD::Sybase with the Sybase Open Client libraries +instead. + +See perldoc DBIx::Class::Storage::DBI::Sybase for more details. + +To turn off this warning set the DBIC_SYBASE_FREETDS_NOWARN environment +variable. +EOF + if (not $self->_typeless_placeholders_supported) { + if ($self->_placeholders_supported) { + $self->auto_cast(1); + } else { + $self->ensure_class_loaded($no_bind_vars); + bless $self, $no_bind_vars; + $self->_rebless; + } + } + + $self->set_textsize; # based on LongReadLen in connect_info + + } + elsif (not $self->_get_dbh->{syb_dynamic_supported}) { + # not necessarily FreeTDS, but no placeholders nevertheless + $self->ensure_class_loaded($no_bind_vars); + bless $self, $no_bind_vars; $self->_rebless; + } elsif (not $self->_typeless_placeholders_supported) { +# this is highly unlikely, but we check just in case + $self->auto_cast(1); } + + $self->_set_max_connect(256); + } + } +} + +# Make sure we have CHAINED mode turned on if AutoCommit is off in non-FreeTDS +# DBD::Sybase (since we don't know how DBD::Sybase was compiled.) If however +# we're using FreeTDS, CHAINED mode turns on an implicit transaction which we +# only want when AutoCommit is off. +sub _populate_dbh { + my $self = shift; + + $self->next::method(@_); + + if (not $self->using_freetds) { + $self->_dbh->{syb_chained_txn} = 1; + } else { + if ($self->_dbh_autocommit) { + $self->_dbh->do('SET CHAINED OFF'); + } else { + $self->_dbh->do('SET CHAINED ON'); } } } @@ -71,7 +131,7 @@ sub _rebless { Used as: - on_connect_call => [ [ blob_setup => log_on_update => 0 ] ] + on_connect_call => [ [ 'blob_setup', log_on_update => 0 ] ] Does C<< $dbh->{syb_binary_images} = 1; >> to return C data as raw binary instead of as a hex string. @@ -98,41 +158,197 @@ sub connect_call_blob_setup { sub _is_lob_type { my $self = shift; - shift =~ /(?:text|image|lob|bytea|binary)/i; + my $type = shift; + $type && $type =~ /(?:text|image|lob|bytea|binary|memo)/i; +} + +sub _prep_for_execute { + my $self = shift; + my ($op, $extra_bind, $ident, $args) = @_; + + my ($sql, $bind) = $self->next::method (@_); + + if ($op eq 'insert') { + my $table = $ident->from; + + my $bind_info = $self->_resolve_column_info( + $ident, [map $_->[0], @{$bind}] + ); + my $identity_col = List::Util::first + { $bind_info->{$_}{is_auto_increment} } + (keys %$bind_info) + ; + + if ($identity_col) { + $sql = join ("\n", + "SET IDENTITY_INSERT $table ON", + $sql, + "SET IDENTITY_INSERT $table OFF", + ); + } + else { + $identity_col = List::Util::first + { $ident->column_info($_)->{is_auto_increment} } + $ident->columns + ; + } + + if ($identity_col) { + $sql = + "$sql\n" . + $self->_fetch_identity_sql($ident, $identity_col); + } + } + + return ($sql, $bind); +} + +# Stolen from SQLT, with some modifications. This is a makeshift +# solution before a sane type-mapping library is available, thus +# the 'our' for easy overrides. +our %TYPE_MAPPING = ( + number => 'numeric', + money => 'money', + varchar => 'varchar', + varchar2 => 'varchar', + timestamp => 'datetime', + text => 'varchar', + real => 'double precision', + comment => 'text', + bit => 'bit', + tinyint => 'smallint', + float => 'double precision', + serial => 'numeric', + bigserial => 'numeric', + boolean => 'varchar', + long => 'varchar', +); + +sub _native_data_type { + my ($self, $type) = @_; + + $type = lc $type; + $type =~ s/\s* identity//x; + + return uc($TYPE_MAPPING{$type} || $type); +} + +sub _fetch_identity_sql { + my ($self, $source, $col) = @_; + + return "SELECT MAX($col) FROM ".$source->from; +} + +sub _execute { + my $self = shift; + my ($op) = @_; + + my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_); + + if ($op eq 'insert') { + $self->_identity($sth->fetchrow_array); + $sth->finish; + } + + return wantarray ? ($rv, $sth, @bind) : $rv; } +sub last_insert_id { shift->_identity } + +# handles TEXT/IMAGE and transaction for last_insert_id sub insert { - my ($self, $source, $to_insert) = splice @_, 0, 3; + my $self = shift; + my ($source, $to_insert) = @_; my $blob_cols = $self->_remove_blob_cols($source, $to_insert); - my $updated_cols = $self->next::method($source, $to_insert, @_); +# insert+blob insert done atomically, on _insert_dbh + (my ($guard), local ($self->{_dbh})) = do { + $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info })) + unless $self->_insert_dbh; + + my $new_guard = $self->txn_scope_guard; + +# _dbh_begin_work may reconnect, if so we need to update _insert_dbh + $self->_insert_dbh($self->_dbh); + + ($new_guard, $self->_insert_dbh) + } if $blob_cols; + + my $need_last_insert_id = 0; + + my ($identity_col) = + map $_->[0], + grep $_->[1]{is_auto_increment}, + map [ $_, $source->column_info($_) ], + $source->columns; + + $need_last_insert_id = 1 + if $identity_col && (not exists $to_insert->{$identity_col}); - $self->_update_blobs($source, $blob_cols, $to_insert) if %$blob_cols; + # We have to do the insert in a transaction to avoid race conditions with the + # SELECT MAX(COL) identity method used when placeholders are enabled. + my $updated_cols = do { + no warnings 'uninitialized'; + if ( + $need_last_insert_id && + $self->_identity_method ne '@@IDENTITY' && + !$self->{transaction_depth} + ) { + $self->_insert_dbh($self->_connect(@{ $self->_dbi_connect_info })) + unless $self->_insert_dbh; + local $self->{_dbh} = $self->_insert_dbh; + + my $guard = $self->txn_scope_guard; + +# _dbh_begin_work may reconnect, if so we need to update _insert_dbh + $self->_insert_dbh($self->_dbh); + + my $upd_cols = $self->next::method (@_); + $guard->commit; + + $upd_cols; + } + else { + $self->next::method(@_); + } + }; + + $self->_insert_blobs($source, $blob_cols, $to_insert) if $blob_cols; + + $guard->commit if $guard; return $updated_cols; } -#sub update { -# my ($self, $source) = splice @_, 0, 2; -# my ($fields) = @_; -# -# my $blob_cols = $self->_remove_blob_cols($source, $fields); -# -# my @res = 1; -# -# if (%$fields) { -# if (wantarray) { -# @res = $self->next::method($source, @_); -# } else { -# $res[0] = $self->next::method($source, @_); -# } -# } -# -# $self->_update_blobs($source, $blob_cols, $fields) if %$blob_cols; -# -# return wantarray ? @res : $res[0]; -#} +sub update { + my $self = shift; + my ($source, $fields, $where) = @_; + + my $wantarray = wantarray; + + my $blob_cols = $self->_remove_blob_cols($source, $fields); + +# update+blob update(s) done atomically + my $guard = $self->txn_scope_guard if $blob_cols; + + my @res; + if ($wantarray) { + @res = $self->next::method(@_); + } + elsif (defined $wantarray) { + $res[0] = $self->next::method(@_); + } + else { + $self->next::method(@_); + } + + $self->_update_blobs($source, $blob_cols, $where) if $blob_cols; + + $guard->commit if $guard; + + return $wantarray ? @res : $res[0]; +} sub _remove_blob_cols { my ($self, $source, $fields) = @_; @@ -140,46 +356,86 @@ sub _remove_blob_cols { my %blob_cols; for my $col (keys %$fields) { - $blob_cols{$col} = delete $fields->{$col} - if $self->_is_lob_type($source->column_info($col)->{data_type}); + if ($self->_is_lob_type($source->column_info($col)->{data_type})) { + $blob_cols{$col} = delete $fields->{$col}; + $fields->{$col} = \"''"; + } } - return \%blob_cols; + return keys %blob_cols ? \%blob_cols : undef; } sub _update_blobs { - my ($self, $source, $blob_cols, $inserted) = @_; - my $dbh = $self->dbh; + my ($self, $source, $blob_cols, $where) = @_; + + my (@primary_cols) = $source->primary_columns; + + croak "Cannot update TEXT/IMAGE column(s) without a primary key" + unless @primary_cols; + +# check if we're updating a single row by PK + my $pk_cols_in_where = 0; + for my $col (@primary_cols) { + $pk_cols_in_where++ if defined $where->{$col}; + } + my @rows; + + if ($pk_cols_in_where == @primary_cols) { + my %row_to_update; + @row_to_update{@primary_cols} = @{$where}{@primary_cols}; + @rows = \%row_to_update; + } else { + my $rs = $source->resultset->search( + $where, + { + result_class => 'DBIx::Class::ResultClass::HashRefInflator', + select => \@primary_cols + } + ); + @rows = $rs->all; # statement must finish + } + + for my $row (@rows) { + $self->_insert_blobs($source, $blob_cols, $row); + } +} + +sub _insert_blobs { + my ($self, $source, $blob_cols, $row) = @_; + my $dbh = $self->_get_dbh; my $table = $source->from; + my %row = %$row; my (@primary_cols) = $source->primary_columns; - croak "Cannot update TEXT/IMAGE without a primary key!" + croak "Cannot update TEXT/IMAGE column(s) without a primary key" unless @primary_cols; - my $search_cond = join ',' => map "$_ = ?", @primary_cols; + if ((grep { defined $row{$_} } @primary_cols) != @primary_cols) { + if (@primary_cols == 1) { + my $col = $primary_cols[0]; + $row{$col} = $self->last_insert_id($source, $col); + } else { + croak "Cannot update TEXT/IMAGE column(s) without primary key values"; + } + } for my $col (keys %$blob_cols) { my $blob = $blob_cols->{$col}; -# First update to empty string in case it's NULL, can't update a NULL blob using -# the API. - my $sth = $dbh->prepare_cached( - qq{update $table set $col = '' where $search_cond} - ); - $sth->execute(map $inserted->{$_}, @primary_cols) or die $sth->errstr; - $sth->finish; - - $sth = $dbh->prepare_cached( - "select $col from $table where $search_cond" - ); - $sth->execute(map $inserted->{$_}, @primary_cols); + my %where = map { ($_, $row{$_}) } @primary_cols; + my $cursor = $source->resultset->search(\%where, { + select => [$col] + })->cursor; + $cursor->next; + my $sth = $cursor->sth; eval { - while ($sth->fetch) { + do { $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr; - } + } while $sth->fetch; + $sth->func('ct_prepare_send') or die $sth->errstr; my $log_on_update = $self->_blob_log_on_update; @@ -195,8 +451,17 @@ sub _update_blobs { $sth->func('ct_finish_send') or die $sth->errstr; }; my $exception = $@; - $sth->finish; - croak $exception if $exception; + $sth->finish if $sth; + if ($exception) { + if ($self->using_freetds) { + croak ( + 'TEXT/IMAGE operation failed, probably because you are using FreeTDS: ' + . $exception + ); + } else { + croak $exception; + } + } } } @@ -227,6 +492,7 @@ C columns only have minute precision. my $dbh = $self->_dbh; if ($dbh->can('syb_date_fmt')) { + # amazingly, this works with FreeTDS $dbh->syb_date_fmt('ISO_strict'); } elsif (not $old_dbd_warned) { carp "Your DBD::Sybase is too old to support ". @@ -234,7 +500,7 @@ C columns only have minute precision. $old_dbd_warned = 1; } - $dbh->do('set dateformat mdy'); + $dbh->do('SET DATEFORMAT mdy'); 1; } @@ -242,30 +508,187 @@ C columns only have minute precision. sub datetime_parser_type { "DateTime::Format::Sybase" } -sub _dbh_last_insert_id { - my ($self, $dbh, $source, $col) = @_; +# ->begin_work and such have no effect with FreeTDS but we run them anyway to +# let the DBD keep any state it needs to. +# +# If they ever do start working, the extra statements will do no harm (because +# Sybase supports nested transactions.) + +sub _dbh_begin_work { + my $self = shift; + $self->next::method(@_); + if ($self->using_freetds) { + $self->_get_dbh->do('BEGIN TRAN'); + } +} + +sub _dbh_commit { + my $self = shift; + if ($self->using_freetds) { + $self->_dbh->do('COMMIT'); + } + return $self->next::method(@_); +} + +sub _dbh_rollback { + my $self = shift; + if ($self->using_freetds) { + $self->_dbh->do('ROLLBACK'); + } + return $self->next::method(@_); +} + +# savepoint support using ASE syntax + +sub _svp_begin { + my ($self, $name) = @_; + + $self->_get_dbh->do("SAVE TRANSACTION $name"); +} + +# A new SAVE TRANSACTION with the same name releases the previous one. +sub _svp_release { 1 } + +sub _svp_rollback { + my ($self, $name) = @_; - # sorry, there's no other way! - my $sth = $dbh->prepare_cached("select max($col) from ".$source->from); - return ($dbh->selectrow_array($sth))[0]; + $self->_get_dbh->do("ROLLBACK TRANSACTION $name"); } 1; +=head1 Schema::Loader Support + +There is an experimental branch of L that will +allow you to dump a schema from most (if not all) versions of Sybase. + +It is available via subversion from: + + http://dev.catalyst.perl.org/repos/bast/branches/DBIx-Class-Schema-Loader/current/ + +=head1 FreeTDS + +This driver supports L compiled against FreeTDS +(L) to the best of our ability, however it is +recommended that you recompile L against the Sybase Open Client +libraries. They are a part of the Sybase ASE distribution: + +The Open Client FAQ is here: +L. + +Sybase ASE for Linux (which comes with the Open Client libraries) may be +downloaded here: L. + +To see if you're using FreeTDS check C<< $schema->storage->using_freetds >>, or run: + + perl -MDBI -le 'my $dbh = DBI->connect($dsn, $user, $pass); print $dbh->{syb_oc_version}' + +Some versions of the libraries involved will not support placeholders, in which +case the storage will be reblessed to +L. + +In some configurations, placeholders will work but will throw implicit type +conversion errors for anything that's not expecting a string. In such a case, +the C option from L is +automatically set, which you may enable on connection with +L. The type info +for the Cs is taken from the L +definitions in your Result classes, and are mapped to a Sybase type (if it isn't +already) using a mapping based on L. + +In other configurations, placeholers will work just as they do with the Sybase +Open Client libraries. + +Inserts or updates of TEXT/IMAGE columns will B work with FreeTDS. + +=head1 INSERTS WITH PLACEHOLDERS + +With placeholders enabled, inserts are done in a transaction so that there are +no concurrency issues with getting the inserted identity value using +C as it's a +session variable. + +=head1 TRANSACTIONS + +Due to limitations of the TDS protocol, L, or both; you cannot +begin a transaction while there are active cursors. An active cursor is, for +example, a L that has been executed using +C or C but has not been exhausted or +L. + +For example, this will not work: + + $schema->txn_do(sub { + my $rs = $schema->resultset('Book'); + while (my $row = $rs->next) { + $schema->resultset('MetaData')->create({ + book_id => $row->id, + ... + }); + } + }); + +Transactions done for inserts in C mode when placeholders are in use +are not affected, as they use an extra database handle to do the insert. + +Some workarounds: + +=over 4 + +=item * use L + +=item * L another L + +=item * load the data from your cursor with L + +=back + +=head1 MAXIMUM CONNECTIONS + +The TDS protocol makes separate connections to the server for active statements +in the background. By default the number of such connections is limited to 25, +on both the client side and the server side. + +This is a bit too low for a complex L application, so on connection +the client side setting is set to C<256> (see L.) You +can override it to whatever setting you like in the DSN. + +See +L +for information on changing the setting on the server side. + =head1 DATES See L to setup date formats for L. -=head1 IMAGE AND TEXT COLUMNS +=head1 TEXT/IMAGE COLUMNS + +L compiled with FreeTDS will B allow you to insert or update +C columns. + +Setting C<< $dbh->{LongReadLen} >> will also not work with FreeTDS use either: + + $schema->storage->dbh->do("SET TEXTSIZE $bytes"); + +or + + $schema->storage->set_textsize($bytes); + +instead. + +However, the C you pass in +L is used to execute the equivalent +C command on connection. See L for a L setting you need to work with C columns. -Due to limitations in L and this driver, it is only possible to -select one C or C column at a time. - -=head1 AUTHORS +=head1 AUTHOR See L.