Fix datetimes in ODBC/Firebird (merge identical code left after a870aa85e)
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / InterBase.pm
index 4baa26c..cb6d8f9 100644 (file)
 package DBIx::Class::Storage::DBI::InterBase;
 
-# partly stolen from DBIx::Class::Storage::DBI::MSSQL
-
 use strict;
 use warnings;
-use base qw/DBIx::Class::Storage::DBI/;
+use base qw/DBIx::Class::Storage::DBI::Firebird::Common/;
 use mro 'c3';
-use List::Util();
-
-__PACKAGE__->mk_group_accessors(simple => qw/
-  _auto_incs
-/);
+use Try::Tiny;
+use namespace::clean;
 
 =head1 NAME
 
-DBIx::Class::Storage::DBI::InterBase - Driver for the Firebird RDBMS
+DBIx::Class::Storage::DBI::InterBase - Driver for the Firebird RDBMS via
+L<DBD::InterBase>
 
 =head1 DESCRIPTION
 
-This class implements autoincrements for Firebird using C<RETURNING>, sets the
-limit dialect to C<FIRST X SKIP X> and provides preliminary
-L<DBIx::Class::InflateColumn::DateTime> support.
-
-For ODBC support, see L<DBIx::Class::Storage::DBI::ODBC::Firebird>.
+This driver is a subclass of L<DBIx::Class::Storage::DBI::Firebird::Common> for
+use with L<DBD::InterBase>, see that driver for general details.
 
-To turn on L<DBIx::Class::InflateColumn::DateTime> support, add:
+You need to use either the
+L<disable_sth_caching|DBIx::Class::Storage::DBI/disable_sth_caching> option or
+L</connect_call_use_softcommit> (see L</CAVEATS>) for your code to function
+correctly with this driver. Otherwise you will likely get bizarre error messages
+such as C<no statement executing>. The alternative is to use the
+L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver, which is more suitable
+for long running processes such as under L<Catalyst>.
 
-    on_connect_call => 'datetime_setup'
-
-to your L<DBIx::Class::Storage::DBI/connect_info>.
+To turn on L<DBIx::Class::InflateColumn::DateTime> support, see
+L</connect_call_datetime_setup>.
 
 =cut
 
-sub _prep_for_execute {
+sub _ping {
   my $self = shift;
-  my ($op, $extra_bind, $ident, $args) = @_;
-
-  if ($op eq 'insert') {
-    my @pk = $ident->primary_columns;
-    my %pk;
-    @pk{@pk} = ();
-
-    my @auto_inc_cols = grep {
-      my $inserting = $args->[0]{$_};
-
-      ($ident->column_info($_)->{is_auto_increment}
-        || exists $pk{$_})
-      && (
-        (not defined $inserting)
-        ||
-        (ref $inserting eq 'SCALAR' && $$inserting =~ /^null\z/i)
-      )
-    } $ident->columns;
-
-    if (@auto_inc_cols) {
-      $args->[1]{returning} = \@auto_inc_cols;
-
-      $self->_auto_incs([]);
-      $self->_auto_incs->[0] = \@auto_inc_cols;
-    }
-  }
 
-  return $self->next::method(@_);
-}
+  my $dbh = $self->_dbh or return 0;
 
-sub _execute {
-  my $self = shift;
-  my ($op) = @_;
-
-  my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
-
-  if ($op eq 'insert' && $self->_auto_incs) {
-    local $@;
-    my (@auto_incs) = eval {
-      local $SIG{__WARN__} = sub {};
-      $sth->fetchrow_array
-    };
-    $self->_auto_incs->[1] = \@auto_incs;
-    $sth->finish;
-  }
+  local $dbh->{RaiseError} = 1;
+  local $dbh->{PrintError} = 0;
 
-  return wantarray ? ($rv, $sth, @bind) : $rv;
+  return try {
+    $dbh->do('select 1 from rdb$database');
+    1;
+  } catch {
+    0;
+  };
 }
 
-sub last_insert_id {
-  my ($self, $source, @cols) = @_;
-  my @result;
-
-  my %auto_incs;
-  @auto_incs{ @{ $self->_auto_incs->[0] } } =
-    @{ $self->_auto_incs->[1] };
-
-  push @result, $auto_incs{$_} for @cols;
-
-  return @result;
+# We want dialect 3 for new features and quoting to work, DBD::InterBase uses
+# dialect 1 (interbase compat) by default.
+sub _init {
+  my $self = shift;
+  $self->_set_sql_dialect(3);
 }
 
-# this sub stolen from DB2
-
-sub _sql_maker_opts {
-  my ( $self, $opts ) = @_;
-
-  if ( $opts ) {
-    $self->{_sql_maker_opts} = { %$opts };
-  }
+sub _set_sql_dialect {
+  my $self = shift;
+  my $val  = shift || 3;
 
-  return { limit_dialect => 'FirstSkip', %{$self->{_sql_maker_opts}||{}} };
-}
+  my $dsn = $self->_dbi_connect_info->[0];
 
-sub _svp_begin {
-    my ($self, $name) = @_;
+  return if ref($dsn) eq 'CODE';
 
-    $self->_get_dbh->do("SAVEPOINT $name");
+  if ($dsn !~ /ib_dialect=/) {
+    $self->_dbi_connect_info->[0] = "$dsn;ib_dialect=$val";
+    my $connected = defined $self->_dbh;
+    $self->disconnect;
+    $self->ensure_connected if $connected;
+  }
 }
 
-sub _svp_release {
-    my ($self, $name) = @_;
+=head2 connect_call_use_softcommit
 
-    $self->_get_dbh->do("RELEASE SAVEPOINT $name");
-}
+Used as:
 
-sub _svp_rollback {
-    my ($self, $name) = @_;
+  on_connect_call => 'use_softcommit'
 
-    $self->_get_dbh->do("ROLLBACK TO SAVEPOINT $name")
-}
+In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the
+L<DBD::InterBase> C<ib_softcommit> option.
 
-sub _ping {
-  my $self = shift;
+You need either this option or C<< disable_sth_caching => 1 >> for
+L<DBIx::Class> code to function correctly (otherwise you may get C<no statement
+executing> errors.) Or use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird>
+driver.
 
-  my $dbh = $self->_dbh or return 0;
+The downside of using this option is that your process will B<NOT> see UPDATEs,
+INSERTs and DELETEs from other processes for already open statements.
 
-  local $dbh->{RaiseError} = 1;
+=cut
 
-  eval {
-    $dbh->do('select 1 from rdb$database');
-  };
+sub connect_call_use_softcommit {
+  my $self = shift;
 
-  return $@ ? 0 : 1;
+  $self->_dbh->{ib_softcommit} = 1;
 }
 
 =head2 connect_call_datetime_setup
@@ -146,8 +100,8 @@ Used as:
 
   on_connect_call => 'datetime_setup'
 
-In L<DBIx::Class::Storage::DBI/connect_info> to set the date and timestamp
-formats using:
+In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the date and
+timestamp formats using:
 
   $dbh->{ib_time_all} = 'ISO';
 
@@ -156,10 +110,18 @@ See L<DBD::InterBase> for more details.
 The C<TIMESTAMP> data type supports up to 4 digits after the decimal point for
 second precision. The full precision is used.
 
+The C<DATE> data type stores the date portion only, and it B<MUST> be declared
+with:
+
+  data_type => 'date'
+
+in your Result class.
+
+Timestamp columns can be declared with either C<datetime> or C<timestamp>.
+
 You will need the L<DateTime::Format::Strptime> module for inflation to work.
 
-For L<DBIx::Class::Storage::DBI::ODBC::Firebird>, this is a noop and sub-second
-precision is not currently available.
+For L<DBIx::Class::Storage::DBI::ODBC::Firebird>, this is a noop.
 
 =cut
 
@@ -169,20 +131,6 @@ sub connect_call_datetime_setup {
   $self->_get_dbh->{ib_time_all} = 'ISO';
 }
 
-
-# from MSSQL
-
-sub build_datetime_parser {
-  my $self = shift;
-  my $type = "DateTime::Format::Strptime";
-  eval "use ${type}";
-  $self->throw_exception("Couldn't load ${type}: $@") if $@;
-  return $type->new(
-    pattern => '%Y-%m-%d %H:%M:%S.%4N', # %F %T
-    on_error => 'croak',
-  );
-}
-
 1;
 
 =head1 CAVEATS
@@ -191,9 +139,13 @@ sub build_datetime_parser {
 
 =item *
 
-C<last_insert_id> support only works for Firebird versions 2 or greater. To
-work with earlier versions, we'll need to figure out how to retrieve the bodies
-of C<BEFORE INSERT> triggers and parse them for the C<GENERATOR> name.
+with L</connect_call_use_softcommit>, you will not be able to see changes made
+to data in other processes. If this is an issue, use
+L<disable_sth_caching|DBIx::Class::Storage::DBI/disable_sth_caching> as a
+workaround for the C<no statement executing> errors, this of course adversely
+affects performance.
+
+Alternately, use the L<ODBC|DBIx::Class::Storage::DBI::ODBC::Firebird> driver.
 
 =back
 
@@ -206,3 +158,4 @@ See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
 You may distribute this code under the same terms as Perl itself.
 
 =cut
+# vim:sts=2 sw=2: