[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / Sybase.pm

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
/;
use Carp::Clan qw/^DBIx::Class/;

=head1 NAME

DBIx::Class::Storage::DBI::Sybase - Storage::DBI subclass for Sybase

=head1 SYNOPSIS

This subclass supports L<DBD::Sybase> for real Sybase databases.  If you are
using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.

=head1 DESCRIPTION

If your version of Sybase does not support placeholders, then your storage
will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. 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<last_insert_id>
without doing a C<select max(col)>.

But your queries will be cached.

A recommended L<DBIx::Class::Storage::DBI/connect_info> settings:

  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]
    } || '';

    my $exception = $@;
    $dbtype =~ s/\W/_/gi;
    my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";

    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';
        $self->_rebless;
      }
    }
  }
}

=head2 connect_call_blob_setup

Used as:

  on_connect_call => [ [ blob_setup => log_on_update => 0 ] ]

Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
instead of as a hex string.

Recommended.

Also sets the C<log_on_update> value for blob write operations. The default is
C<1>, but C<0> is better if your database is configured for it.

See
L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.

=cut

sub connect_call_blob_setup {
  my $self = shift;
  my %args = @_;
  my $dbh = $self->_dbh;
  $dbh->{syb_binary_images} = 1;

  $self->_blob_log_on_update($args{log_on_update})
    if exists $args{log_on_update};
}

sub _is_lob_type {
  my $self = shift;
  shift =~ /(?:text|image|lob|bytea|binary)/i;
}

sub insert {
  my ($self, $source, $to_insert) = splice @_, 0, 3;

  my $blob_cols = $self->_remove_blob_cols($source, $to_insert);

  my $updated_cols = $self->next::method($source, $to_insert, @_);

  $self->_update_blobs($source, $blob_cols, $to_insert) if %$blob_cols;

  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 _remove_blob_cols {
  my ($self, $source, $fields) = @_;

  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});
  }

  return \%blob_cols;
}

sub _update_blobs {
  my ($self, $source, $blob_cols, $inserted) = @_;
  my $dbh = $self->dbh;

  my $table = $source->from;

  my (@primary_cols) = $source->primary_columns;

  croak "Cannot update TEXT/IMAGE without a primary key!"
    unless @primary_cols;

  my $search_cond = join ',' => map "$_ = ?", @primary_cols;

  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);

    eval {
      while ($sth->fetch) {
        $sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
      }
      $sth->func('ct_prepare_send') or die $sth->errstr;

      my $log_on_update = $self->_blob_log_on_update;
      $log_on_update    = 1 if not defined $log_on_update;

      $sth->func('CS_SET', 1, {
        total_txtlen => length($blob),
        log_on_update => $log_on_update
      }, 'ct_data_info') or die $sth->errstr;

      $sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;

      $sth->func('ct_finish_send') or die $sth->errstr;
    };
    my $exception = $@;
    $sth->finish;
    croak $exception if $exception;
  }
}

=head2 connect_call_datetime_setup

Used as:

  on_connect_call => 'datetime_setup'

In L<DBIx::Class::Storage::DBI/connect_info> to set:

  $dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
  $dbh->do('set dateformat mdy');   # input fmt:  08/13/1979 18:08:55.080

On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
L<DateTime::Format::Sybase>, which you will need to install.

This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
C<SMALLDATETIME> columns only have minute precision.

=cut

{
  my $old_dbd_warned = 0;

  sub connect_call_datetime_setup {
    my $self = shift;
    my $dbh = $self->_dbh;

    if ($dbh->can('syb_date_fmt')) {
      $dbh->syb_date_fmt('ISO_strict');
    } elsif (not $old_dbd_warned) {
      carp "Your DBD::Sybase is too old to support ".
      "DBIx::Class::InflateColumn::DateTime, please upgrade!";
      $old_dbd_warned = 1;
    }

    $dbh->do('set dateformat mdy');

    1;
  }
}

sub datetime_parser_type { "DateTime::Format::Sybase" }

sub _dbh_last_insert_id {
  my ($self, $dbh, $source, $col) = @_;

  # sorry, there's no other way!
  my $sth = $dbh->prepare_cached("select max($col) from ".$source->from);
  return ($dbh->selectrow_array($sth))[0];
}

# previous implementation of limited count for Sybase, does not include
# count_grouped.

#sub _copy_attributes_for_count {
#  my ($self, $source, $attrs) = @_;
#  my %attrs = %$attrs;
#
#  # take off any column specs, any pagers, record_filter is cdbi, and no point of ordering a count
#  delete @attrs{qw/select as rows offset page order_by record_filter/};
#
#  return \%attrs;
#}
#
#=head2 count
#
#Counts for limited queries are emulated by executing select queries and
#returning the number of successful executions minus the offset.
#
#This is necessary due to the limitations of Sybase.
#
#=cut
#
#sub count {
#  my $self = shift;
#  my ($source, $attrs) = @_;
#
#  my $new_attrs = $self->_copy_attributes_for_count($source, $attrs);
#
#  if (exists $attrs->{rows}) {
#    my $offset = $attrs->{offset} || 0;
#    my $total  = $attrs->{rows} + $offset;
#
#    my $first_pk = ($source->primary_columns)[0];
#
#    $new_attrs->{select} = $first_pk ? "me.$first_pk" : 1;
#
#    my $tmp_rs = $source->resultset_class->new($source, $new_attrs);
#
#    $self->dbh->{syb_rowcount} = $total;
#
#    my $count = 0;
#    $count++ while $tmp_rs->cursor->next;
#
#    $self->dbh->{syb_rowcount} = 0;
#
#    return $count - $offset;
#  } else {
#    # overwrite the selector
#    $new_attrs->{select} = { count => '*' };
#
#    my $tmp_rs = $source->resultset_class->new($source, $new_attrs);
#    my ($count) = $tmp_rs->cursor->next;
#
#    # if the offset/rows attributes are still present, we did not use
#    # a subquery, so we need to make the calculations in software
#    $count -= $attrs->{offset} if $attrs->{offset};
#    $count = $attrs->{rows} if $attrs->{rows} and $attrs->{rows} < $count;
#    $count = 0 if ($count < 0);
#
#    return $count;
#  }
#}

1;

=head1 DATES

See L</connect_call_datetime_setup> to setup date formats
for L<DBIx::Class::InflateColumn::DateTime>.

=head1 IMAGE AND TEXT COLUMNS

See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
setting you need to work with C<IMAGE> columns.

Due to limitations in L<DBD::Sybase> and this driver, it is only possible to
select one C<TEXT> or C<IMAGE> column at a time.

=head1 AUTHORS

See L<DBIx::Class/CONTRIBUTORS>.

=head1 LICENSE

You may distribute this code under the same terms as Perl itself.

=cut
# vim:sts=2 sw=2:
Commit	Line	Data
3885cff6	1	package DBIx::Class::Storage::DBI::Sybase;
	2
	3	use strict;
	4	use warnings;
eabab5d0	5	use mro 'c3';
	6	use base qw/
	7	DBIx::Class::Storage::DBI::Sybase::Base
fd423205	8	DBIx::Class::Storage::DBI
eabab5d0	9	/;
6b1f5ef7	10	use Carp::Clan qw/^DBIx::Class/;
6b1f5ef7	11
98259fe4	12	=head1 NAME
	13
	14	DBIx::Class::Storage::DBI::Sybase - Storage::DBI subclass for Sybase
	15
	16	=head1 SYNOPSIS
	17
	18	This subclass supports L<DBD::Sybase> for real Sybase databases. If you are
	19	using an MSSQL database via L<DBD::Sybase>, your storage will be reblessed to
	20	L<DBIx::Class::Storage::DBI::Sybase::Microsoft_SQL_Server>.
	21
	22	=head1 DESCRIPTION
	23
	24	If your version of Sybase does not support placeholders, then your storage
	25	will be reblessed to L<DBIx::Class::Storage::DBI::Sybase::NoBindVars>. You can
	26	also enable that driver explicitly, see the documentation for more details.
	27
	28	With this driver there is unfortunately no way to get the C<last_insert_id>
	29	without doing a C<select max(col)>.
	30
	31	But your queries will be cached.
	32
fd5a07e4	33	A recommended L<DBIx::Class::Storage::DBI/connect_info> settings:
98259fe4	34
fd5a07e4	35	on_connect_call => [['datetime_setup'], [blob_setup => log_on_update => 0]]
98259fe4	36
	37	=head1 METHODS
	38
	39	=cut
	40
fd5a07e4	41	__PACKAGE__->mk_group_accessors('simple' =>
	42	qw/_blob_log_on_update/
	43	);
	44
47d9646a	45	sub _rebless {
b50a5275	46	my $self = shift;
c5ce7cd6	47
	48	if (ref($self) eq 'DBIx::Class::Storage::DBI::Sybase') {
	49	my $dbtype = eval {
	50	@{$self->dbh->selectrow_arrayref(qq{sp_server_info \@attribute_id=1})}[2]
	51	} \|\| '';
	52
	53	my $exception = $@;
	54	$dbtype =~ s/\W/_/gi;
	55	my $subclass = "DBIx::Class::Storage::DBI::Sybase::${dbtype}";
	56
	57	if (!$exception && $dbtype && $self->load_optional_class($subclass)) {
	58	bless $self, $subclass;
	59	$self->_rebless;
683f73ec	60	} else {
	61	# real Sybase
	62	if (not $self->dbh->{syb_dynamic_supported}) {
	63	bless $self, 'DBIx::Class::Storage:DBI::Sybase::NoBindVars';
	64	$self->_rebless;
	65	}
47d9646a	66	}
c5ce7cd6	67	}
b50a5275	68	}
b50a5275	69
63d46bb3	70	=head2 connect_call_blob_setup
	71
	72	Used as:
	73
fd5a07e4	74	on_connect_call => [ [ blob_setup => log_on_update => 0 ] ]
63d46bb3	75
	76	Does C<< $dbh->{syb_binary_images} = 1; >> to return C<IMAGE> data as raw binary
	77	instead of as a hex string.
	78
6636ad53	79	Recommended.
6636ad53	80
fd5a07e4	81	Also sets the C<log_on_update> value for blob write operations. The default is
	82	C<1>, but C<0> is better if your database is configured for it.
	83
	84	See
	85	L<DBD::Sybase/Handling_IMAGE/TEXT_data_with_syb_ct_get_data()/syb_ct_send_data()>.
	86
63d46bb3	87	=cut
	88
	89	sub connect_call_blob_setup {
	90	my $self = shift;
fd5a07e4	91	my %args = @_;
63d46bb3	92	my $dbh = $self->_dbh;
63d46bb3	93	$dbh->{syb_binary_images} = 1;
fd5a07e4	94
	95	$self->_blob_log_on_update($args{log_on_update})
	96	if exists $args{log_on_update};
	97	}
	98
	99	sub _is_lob_type {
	100	my $self = shift;
	101	shift =~ /(?:text\|image\|lob\|bytea\|binary)/i;
	102	}
	103
	104	sub insert {
7d17f469	105	my ($self, $source, $to_insert) = splice @_, 0, 3;
	106
	107	my $blob_cols = $self->_remove_blob_cols($source, $to_insert);
	108
	109	my $updated_cols = $self->next::method($source, $to_insert, @_);
	110
	111	$self->_update_blobs($source, $blob_cols, $to_insert) if %$blob_cols;
	112
	113	return $updated_cols;
	114	}
	115
	116	#sub update {
	117	# my ($self, $source) = splice @_, 0, 2;
	118	# my ($fields) = @_;
	119	#
	120	# my $blob_cols = $self->_remove_blob_cols($source, $fields);
	121	#
	122	# my @res = 1;
	123	#
	124	# if (%$fields) {
	125	# if (wantarray) {
	126	# @res = $self->next::method($source, @_);
	127	# } else {
	128	# $res[0] = $self->next::method($source, @_);
	129	# }
	130	# }
	131	#
	132	# $self->_update_blobs($source, $blob_cols, $fields) if %$blob_cols;
	133	#
	134	# return wantarray ? @res : $res[0];
	135	#}
	136
	137	sub _remove_blob_cols {
	138	my ($self, $source, $fields) = @_;
fd5a07e4	139
	140	my %blob_cols;
	141
7d17f469	142	for my $col (keys %$fields) {
7d17f469	143	$blob_cols{$col} = delete $fields->{$col}
fd5a07e4	144	if $self->_is_lob_type($source->column_info($col)->{data_type});
	145	}
	146
7d17f469	147	return \%blob_cols;
fd5a07e4	148	}
	149
	150	sub _update_blobs {
	151	my ($self, $source, $blob_cols, $inserted) = @_;
	152	my $dbh = $self->dbh;
	153
	154	my $table = $source->from;
	155
	156	my (@primary_cols) = $source->primary_columns;
	157
	158	croak "Cannot update TEXT/IMAGE without a primary key!"
	159	unless @primary_cols;
	160
	161	my $search_cond = join ',' => map "$_ = ?", @primary_cols;
	162
	163	for my $col (keys %$blob_cols) {
	164	my $blob = $blob_cols->{$col};
	165
	166	# First update to empty string in case it's NULL, can't update a NULL blob using
	167	# the API.
	168	my $sth = $dbh->prepare_cached(
	169	qq{update $table set $col = '' where $search_cond}
	170	);
	171	$sth->execute(map $inserted->{$_}, @primary_cols) or die $sth->errstr;
	172	$sth->finish;
	173
	174	$sth = $dbh->prepare_cached(
	175	"select $col from $table where $search_cond"
	176	);
	177	$sth->execute(map $inserted->{$_}, @primary_cols);
	178
	179	eval {
	180	while ($sth->fetch) {
	181	$sth->func('CS_GET', 1, 'ct_data_info') or die $sth->errstr;
	182	}
	183	$sth->func('ct_prepare_send') or die $sth->errstr;
	184
	185	my $log_on_update = $self->_blob_log_on_update;
	186	$log_on_update = 1 if not defined $log_on_update;
	187
	188	$sth->func('CS_SET', 1, {
	189	total_txtlen => length($blob),
	190	log_on_update => $log_on_update
	191	}, 'ct_data_info') or die $sth->errstr;
	192
	193	$sth->func($blob, length($blob), 'ct_send_data') or die $sth->errstr;
	194
	195	$sth->func('ct_finish_send') or die $sth->errstr;
	196	};
	197	my $exception = $@;
	198	$sth->finish;
	199	croak $exception if $exception;
	200	}
63d46bb3	201	}
63d46bb3	202
9539eeb1	203	=head2 connect_call_datetime_setup
	204
	205	Used as:
	206
	207	on_connect_call => 'datetime_setup'
	208
	209	In L<DBIx::Class::Storage::DBI/connect_info> to set:
	210
3abafb11	211	$dbh->syb_date_fmt('ISO_strict'); # output fmt: 2004-08-21T14:36:48.080Z
3abafb11	212	$dbh->do('set dateformat mdy'); # input fmt: 08/13/1979 18:08:55.080
9539eeb1	213
9539eeb1	214	On connection for use with L<DBIx::Class::InflateColumn::DateTime>, using
3abafb11	215	L<DateTime::Format::Sybase>, which you will need to install.
	216
	217	This works for both C<DATETIME> and C<SMALLDATETIME> columns, although
	218	C<SMALLDATETIME> columns only have minute precision.
9539eeb1	219
	220	=cut
	221
9041a97a	222	{
	223	my $old_dbd_warned = 0;
	224
9539eeb1	225	sub connect_call_datetime_setup {
6b1f5ef7	226	my $self = shift;
6b1f5ef7	227	my $dbh = $self->_dbh;
	228
	229	if ($dbh->can('syb_date_fmt')) {
	230	$dbh->syb_date_fmt('ISO_strict');
	231	} elsif (not $old_dbd_warned) {
	232	carp "Your DBD::Sybase is too old to support ".
	233	"DBIx::Class::InflateColumn::DateTime, please upgrade!";
	234	$old_dbd_warned = 1;
	235	}
	236
	237	$dbh->do('set dateformat mdy');
c5ce7cd6	238
6b1f5ef7	239	1;
c5ce7cd6	240	}
6b1f5ef7	241	}
6b1f5ef7	242
6636ad53	243	sub datetime_parser_type { "DateTime::Format::Sybase" }
6636ad53	244
6b1f5ef7	245	sub _dbh_last_insert_id {
6b1f5ef7	246	my ($self, $dbh, $source, $col) = @_;
c5ce7cd6	247
	248	# sorry, there's no other way!
	249	my $sth = $dbh->prepare_cached("select max($col) from ".$source->from);
	250	return ($dbh->selectrow_array($sth))[0];
a964a928	251	}
a964a928	252
98259fe4	253	# previous implementation of limited count for Sybase, does not include
	254	# count_grouped.
	255
	256	#sub _copy_attributes_for_count {
	257	# my ($self, $source, $attrs) = @_;
	258	# my %attrs = %$attrs;
	259	#
	260	# # take off any column specs, any pagers, record_filter is cdbi, and no point of ordering a count
	261	# delete @attrs{qw/select as rows offset page order_by record_filter/};
	262	#
	263	# return \%attrs;
	264	#}
	265	#
	266	#=head2 count
	267	#
	268	#Counts for limited queries are emulated by executing select queries and
	269	#returning the number of successful executions minus the offset.
	270	#
	271	#This is necessary due to the limitations of Sybase.
	272	#
	273	#=cut
	274	#
	275	#sub count {
	276	# my $self = shift;
	277	# my ($source, $attrs) = @_;
	278	#
	279	# my $new_attrs = $self->_copy_attributes_for_count($source, $attrs);
	280	#
	281	# if (exists $attrs->{rows}) {
	282	# my $offset = $attrs->{offset} \|\| 0;
	283	# my $total = $attrs->{rows} + $offset;
	284	#
	285	# my $first_pk = ($source->primary_columns)[0];
	286	#
	287	# $new_attrs->{select} = $first_pk ? "me.$first_pk" : 1;
	288	#
	289	# my $tmp_rs = $source->resultset_class->new($source, $new_attrs);
	290	#
	291	# $self->dbh->{syb_rowcount} = $total;
	292	#
	293	# my $count = 0;
	294	# $count++ while $tmp_rs->cursor->next;
	295	#
	296	# $self->dbh->{syb_rowcount} = 0;
	297	#
	298	# return $count - $offset;
	299	# } else {
	300	# # overwrite the selector
	301	# $new_attrs->{select} = { count => '*' };
	302	#
	303	# my $tmp_rs = $source->resultset_class->new($source, $new_attrs);
	304	# my ($count) = $tmp_rs->cursor->next;
	305	#
	306	# # if the offset/rows attributes are still present, we did not use
	307	# # a subquery, so we need to make the calculations in software
	308	# $count -= $attrs->{offset} if $attrs->{offset};
	309	# $count = $attrs->{rows} if $attrs->{rows} and $attrs->{rows} < $count;
	310	# $count = 0 if ($count < 0);
	311	#
	312	# return $count;
	313	# }
	314	#}
b7505130	315
3885cff6	316	1;
3885cff6	317
c5ce7cd6	318	=head1 DATES
c5ce7cd6	319
3abafb11	320	See L</connect_call_datetime_setup> to setup date formats
3abafb11	321	for L<DBIx::Class::InflateColumn::DateTime>.
c5ce7cd6	322
6636ad53	323	=head1 IMAGE AND TEXT COLUMNS
63d46bb3	324
	325	See L</connect_call_blob_setup> for a L<DBIx::Class::Storage::DBI/connect_info>
	326	setting you need to work with C<IMAGE> columns.
	327
6636ad53	328	Due to limitations in L<DBD::Sybase> and this driver, it is only possible to
9041a97a	329	select one C<TEXT> or C<IMAGE> column at a time.
6636ad53	330
3885cff6	331	=head1 AUTHORS
3885cff6	332
7e8cecc1	333	See L<DBIx::Class/CONTRIBUTORS>.
c5ce7cd6	334
3885cff6	335	=head1 LICENSE
	336
	337	You may distribute this code under the same terms as Perl itself.
	338
	339	=cut
c5ce7cd6	340	# vim:sts=2 sw=2: