Fix datetimes in ODBC/Firebird (merge identical code left after a870aa85e)
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / InterBase.pm
index 23cc529..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();
+use Try::Tiny;
+use namespace::clean;
 
-__PACKAGE__->mk_group_accessors(simple => qw/
-  _fb_auto_incs
-/);
+=head1 NAME
 
-sub _prep_for_execute {
-  my $self = shift;
-  my ($op, $extra_bind, $ident, $args) = @_;
+DBIx::Class::Storage::DBI::InterBase - Driver for the Firebird RDBMS via
+L<DBD::InterBase>
 
-  my ($sql, $bind) = $self->next::method (@_);
+=head1 DESCRIPTION
 
-  if ($op eq 'insert') {
-    my @auto_inc_cols = grep {
-      my $inserting = $args->[0]{$_};
+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.
 
-      $ident->column_info($_)->{is_auto_increment} && (
-        (not defined $inserting)
-        ||
-        (ref $inserting eq 'SCALAR' && $$inserting eq 'NULL')
-      )
-    } $ident->columns;
+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>.
 
-    if (@auto_inc_cols) {
-      my $auto_inc_cols =
-        join ', ',
-        map $self->_quote_column_for_returning($_), @auto_inc_cols;
+To turn on L<DBIx::Class::InflateColumn::DateTime> support, see
+L</connect_call_datetime_setup>.
 
-      $sql .= " RETURNING ($auto_inc_cols)";
+=cut
 
-      $self->_fb_auto_incs([]);
-      $self->_fb_auto_incs->[0] = \@auto_inc_cols;
-    }
-  }
+sub _ping {
+  my $self = shift;
 
-  return ($sql, $bind);
-}
+  my $dbh = $self->_dbh or return 0;
 
-sub _quote_column_for_returning {
-  my ($self, $col) = @_;
+  local $dbh->{RaiseError} = 1;
+  local $dbh->{PrintError} = 0;
 
-  return $self->sql_maker->_quote($col);
+  return try {
+    $dbh->do('select 1 from rdb$database');
+    1;
+  } catch {
+    0;
+  };
 }
 
-sub _execute {
+# 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;
-  my ($op) = @_;
-
-  my ($rv, $sth, @bind) = $self->dbh_do($self->can('_dbh_execute'), @_);
-
-  if ($op eq 'insert' && $self->_fb_auto_incs) {
-    local $@;
-    my (@auto_incs) = eval {
-      local $SIG{__WARN__} = sub {};
-      $sth->fetchrow_array
-    };
-    $self->_fb_auto_incs->[1] = \@auto_incs;
-    $sth->finish;
-  }
-
-  return wantarray ? ($rv, $sth, @bind) : $rv;
+  $self->_set_sql_dialect(3);
 }
 
-sub last_insert_id {
-  my ($self, $source, @cols) = @_;
-  my @result;
+sub _set_sql_dialect {
+  my $self = shift;
+  my $val  = shift || 3;
 
-  my %auto_incs;
-  @auto_incs{ @{ $self->_fb_auto_incs->[0] } } =
-    @{ $self->_fb_auto_incs->[1] };
+  my $dsn = $self->_dbi_connect_info->[0];
 
-  push @result, $auto_incs{$_} for @cols;
+  return if ref($dsn) eq 'CODE';
 
-  return @result;
+  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;
+  }
 }
 
-# this sub stolen from DB2
+=head2 connect_call_use_softcommit
 
-sub _sql_maker_opts {
-  my ( $self, $opts ) = @_;
+Used as:
 
-  if ( $opts ) {
-    $self->{_sql_maker_opts} = { %$opts };
-  }
+  on_connect_call => 'use_softcommit'
 
-  return { limit_dialect => 'FirstSkip', %{$self->{_sql_maker_opts}||{}} };
-}
+In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the
+L<DBD::InterBase> C<ib_softcommit> option.
 
-sub datetime_parser_type { __PACKAGE__ }
+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 ($datetime_parser, $datetime_formatter);
+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.
 
-sub parse_datetime {
-    shift;
-    require DateTime::Format::Strptime;
-    $datetime_parser ||= DateTime::Format::Strptime->new(
-        pattern => '%a %d %b %Y %r',
-# there should be a %Z (TZ) on the end, but it's ambiguous and not parsed
-        on_error => 'croak',
-    );
-    $datetime_parser->parse_datetime(shift);
+=cut
+
+sub connect_call_use_softcommit {
+  my $self = shift;
+
+  $self->_dbh->{ib_softcommit} = 1;
 }
 
-sub format_datetime {
-    shift;
-    require DateTime::Format::Strptime;
-    $datetime_formatter ||= DateTime::Format::Strptime->new(
-        pattern => '%F %H:%M:%S.%4N',
-        on_error => 'croak',
-    );
-    $datetime_formatter->format_datetime(shift);
+=head2 connect_call_datetime_setup
+
+Used as:
+
+  on_connect_call => 'datetime_setup'
+
+In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the date and
+timestamp formats using:
+
+  $dbh->{ib_time_all} = 'ISO';
+
+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.
+
+=cut
+
+sub connect_call_datetime_setup {
+  my $self = shift;
+
+  $self->_get_dbh->{ib_time_all} = 'ISO';
 }
 
 1;
+
+=head1 CAVEATS
+
+=over 4
+
+=item *
+
+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
+
+=head1 AUTHOR
+
+See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+# vim:sts=2 sw=2: