clean up the way dbh_do is used in Storage::* so that inheritance can work and its...
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI.pm
index 8f2900e..37b586e 100644 (file)
@@ -10,7 +10,6 @@ use SQL::Abstract::Limit;
 use DBIx::Class::Storage::DBI::Cursor;
 use DBIx::Class::Storage::Statistics;
 use IO::File;
-use Carp::Clan qw/DBIx::Class/;
 
 __PACKAGE__->mk_group_accessors(
   'simple' =>
@@ -36,10 +35,36 @@ sub new {
   $self;
 }
 
+sub _RowNumberOver {
+  my ($self, $sql, $order, $rows, $offset ) = @_;
+
+  $offset += 1;
+  my $last = $rows + $offset;
+  my ( $order_by ) = $self->_order_by( $order );
+
+  $sql = <<"";
+SELECT * FROM
+(
+   SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
+      $sql
+      $order_by
+   ) Q1
+) Q2
+WHERE ROW_NUM BETWEEN $offset AND $last
+
+  return $sql;
+}
+
+
 # While we're at it, this should make LIMIT queries more efficient,
 #  without digging into things too deeply
 sub _find_syntax {
   my ($self, $syntax) = @_;
+  my $dbhname = ref $syntax eq 'HASH' ? $syntax->{Driver}{Name} : '';
+  if(ref($self) && $dbhname && $dbhname eq 'DB2') {
+    return 'RowNumberOver';
+  }
+
   $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
 }
 
@@ -427,19 +452,26 @@ This method is deprecated in favor of setting via L</connect_info>.
 
 Arguments: $subref, @extra_coderef_args?
 
-Execute the given subref with the underlying database handle as its
-first argument, using the new exception-based connection management.
+Execute the given subref using the new exception-based connection management.
+
+The first two arguments will be the storage object that C<dbh_do> was called
+on and a database handle to use.  Any additional arguments will be passed
+verbatim to the called subref as arguments 2 and onwards.
 
-Any additional arguments will be passed verbatim to the called subref
-as arguments 2 and onwards.
+Using this (instead of $self->_dbh or $self->dbh) ensures correct
+exception handling and reconnection (or failover in future subclasses).
+
+Your subref should have no side-effects outside of the database, as
+there is the potential for your subref to be partially double-executed
+if the database connection was stale/dysfunctional.
 
 Example:
 
   my @stuff = $schema->storage->dbh_do(
     sub {
-      my $dbh = shift;
-      my $cols = join(q{, }, @_);
-      shift->selectrow_array("SELECT $cols FROM foo")
+      my ($storage, $dbh, @cols) = @_;
+      my $cols = join(q{, }, @cols);
+      $dbh->selectrow_array("SELECT $cols FROM foo");
     },
     @column_list
   );
@@ -448,7 +480,12 @@ Example:
 
 sub dbh_do {
   my $self = shift;
-  my $todo = shift;
+  my $coderef = shift;
+
+  return $coderef->($self, $self->_dbh, @_) if $self->{_in_txn_do};
+
+  ref $coderef eq 'CODE' or $self->throw_exception
+    ('$coderef must be a CODE reference');
 
   my @result;
   my $want_array = wantarray;
@@ -456,29 +493,85 @@ sub dbh_do {
   eval {
     $self->_verify_pid if $self->_dbh;
     $self->_populate_dbh if !$self->_dbh;
-    my $dbh = $self->_dbh;
     if($want_array) {
-        @result = $todo->($dbh, @_);
+        @result = $coderef->($self, $self->_dbh, @_);
     }
     elsif(defined $want_array) {
-        $result[0] = $todo->($dbh, @_);
+        $result[0] = $coderef->($self, $self->_dbh, @_);
     }
     else {
-        $todo->($dbh, @_);
+        $coderef->($self, $self->_dbh, @_);
     }
   };
 
-  if($@) {
+  my $exception = $@;
+  if(!$exception) { return $want_array ? @result : $result[0] }
+
+  $self->throw_exception($exception) if $self->connected;
+
+  # We were not connected - reconnect and retry, but let any
+  #  exception fall right through this time
+  $self->_populate_dbh;
+  $coderef->($self, $self->_dbh, @_);
+}
+
+# This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
+# It also informs dbh_do to bypass itself while under the direction of txn_do,
+#  via $self->{_in_txn_do} (this saves some redundant eval and errorcheck, etc)
+sub txn_do {
+  my $self = shift;
+  my $coderef = shift;
+
+  ref $coderef eq 'CODE' or $self->throw_exception
+    ('$coderef must be a CODE reference');
+
+  local $self->{_in_txn_do} = 1;
+
+  my @result;
+  my $want_array = wantarray;
+
+  my $tried = 0;
+  while(1) {
+    eval {
+      $self->_verify_pid if $self->_dbh;
+      $self->_populate_dbh if !$self->_dbh;
+
+      $self->txn_begin;
+      if($want_array) {
+          @result = $coderef->(@_);
+      }
+      elsif(defined $want_array) {
+          $result[0] = $coderef->(@_);
+      }
+      else {
+          $coderef->(@_);
+      }
+      $self->txn_commit;
+    };
+
     my $exception = $@;
-    $self->connected
-      ? $self->throw_exception($exception)
-      : $self->_populate_dbh;
+    if(!$exception) { return $want_array ? @result : $result[0] }
+
+    if($tried++ > 0 || $self->connected) {
+      eval { $self->txn_rollback };
+      my $rollback_exception = $@;
+      if($rollback_exception) {
+        my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
+        $self->throw_exception($exception)  # propagate nested rollback
+          if $rollback_exception =~ /$exception_class/;
+
+        $self->throw_exception(
+          "Transaction aborted: ${exception}. "
+          . "Rollback failed: ${rollback_exception}"
+        );
+      }
+      $self->throw_exception($exception)
+    }
 
-    my $dbh = $self->_dbh;
-    return $todo->($dbh, @_);
+    # We were not connected, and was first try - reconnect and retry
+    # via the while loop
+    $self->_populate_dbh;
   }
-
-  return $want_array ? @result : $result[0];
 }
 
 =head2 disconnect
@@ -619,67 +712,69 @@ sub _connect {
   $dbh;
 }
 
+sub _dbh_txn_begin {
+  my ($self, $dbh) = @_;
+  if ($dbh->{AutoCommit}) {
+    $self->debugobj->txn_begin()
+      if ($self->debug);
+    $dbh->begin_work;
+  }
+}
+
 sub txn_begin {
   my $self = shift;
-  if ($self->{transaction_depth}++ == 0) {
-    $self->dbh_do(sub {
-      my $dbh = shift;
-      if ($dbh->{AutoCommit}) {
-        $self->debugobj->txn_begin()
-          if ($self->debug);
-        $dbh->begin_work;
-      }
-    });
+  $self->dbh_do($self->can('_dbh_txn_begin'))
+    if $self->{transaction_depth}++ == 0;
+}
+
+sub _dbh_txn_commit {
+  my ($self, $dbh) = @_;
+  if ($self->{transaction_depth} == 0) {
+    unless ($dbh->{AutoCommit}) {
+      $self->debugobj->txn_commit()
+        if ($self->debug);
+      $dbh->commit;
+    }
+  }
+  else {
+    if (--$self->{transaction_depth} == 0) {
+      $self->debugobj->txn_commit()
+        if ($self->debug);
+      $dbh->commit;
+    }
   }
 }
 
 sub txn_commit {
   my $self = shift;
-  $self->dbh_do(sub {
-    my $dbh = shift;
-    if ($self->{transaction_depth} == 0) {
-      unless ($dbh->{AutoCommit}) {
-        $self->debugobj->txn_commit()
-          if ($self->debug);
-        $dbh->commit;
-      }
+  $self->dbh_do($self->can('_dbh_txn_commit'));
+}
+
+sub _dbh_txn_rollback {
+  my ($self, $dbh) = @_;
+  if ($self->{transaction_depth} == 0) {
+    unless ($dbh->{AutoCommit}) {
+      $self->debugobj->txn_rollback()
+        if ($self->debug);
+      $dbh->rollback;
+    }
+  }
+  else {
+    if (--$self->{transaction_depth} == 0) {
+      $self->debugobj->txn_rollback()
+        if ($self->debug);
+      $dbh->rollback;
     }
     else {
-      if (--$self->{transaction_depth} == 0) {
-        $self->debugobj->txn_commit()
-          if ($self->debug);
-        $dbh->commit;
-      }
+      die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
     }
-  });
+  }
 }
 
 sub txn_rollback {
   my $self = shift;
 
-  eval {
-    $self->dbh_do(sub {
-      my $dbh = shift;
-      if ($self->{transaction_depth} == 0) {
-        unless ($dbh->{AutoCommit}) {
-          $self->debugobj->txn_rollback()
-            if ($self->debug);
-          $dbh->rollback;
-        }
-      }
-      else {
-        if (--$self->{transaction_depth} == 0) {
-          $self->debugobj->txn_rollback()
-            if ($self->debug);
-          $dbh->rollback;
-        }
-        else {
-          die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
-        }
-      }
-    });
-  };
-
+  eval { $self->dbh_do($self->can('_dbh_txn_rollback')) };
   if ($@) {
     my $error = $@;
     my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
@@ -768,6 +863,12 @@ sub _select {
 
 =head2 select
 
+=over 4
+
+=item Arguments: $ident, $select, $condition, $attrs
+
+=back
+
 Handle a SQL select statement.
 
 =cut
@@ -778,94 +879,92 @@ sub select {
   return $self->cursor->new($self, \@_, $attrs);
 }
 
-=head2 select_single
-
-Performs a select, fetch and return of data - handles a single row
-only.
-
-=cut
-
-# Need to call finish() to work round broken DBDs
-
 sub select_single {
   my $self = shift;
   my ($rv, $sth, @bind) = $self->_select(@_);
   my @row = $sth->fetchrow_array;
+  # Need to call finish() to work round broken DBDs
   $sth->finish();
   return @row;
 }
 
 =head2 sth
 
+=over 4
+
+=item Arguments: $sql
+
+=back
+
 Returns a L<DBI> sth (statement handle) for the supplied SQL.
 
 =cut
 
-sub sth {
-  my ($self, $sql) = @_;
+sub _dbh_sth {
+  my ($self, $dbh, $sql) = @_;
   # 3 is the if_active parameter which avoids active sth re-use
-  return $self->dbh_do(sub { shift->prepare_cached($sql, {}, 3) });
+  $dbh->prepare_cached($sql, {}, 3);
 }
 
-=head2 columns_info_for
-
-Returns database type info for a given table columns.
-
-=cut
-
-sub columns_info_for {
-  my ($self, $table) = @_;
+sub sth {
+  my ($self, $sql) = @_;
+  $self->dbh_do($self->can('_dbh_sth'), $sql);
+}
 
-  $self->dbh_do(sub {
-    my $dbh = shift;
-
-    if ($dbh->can('column_info')) {
-      my %result;
-      eval {
-        my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
-        my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
-        $sth->execute();
-        while ( my $info = $sth->fetchrow_hashref() ){
-          my %column_info;
-          $column_info{data_type}   = $info->{TYPE_NAME};
-          $column_info{size}      = $info->{COLUMN_SIZE};
-          $column_info{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
-          $column_info{default_value} = $info->{COLUMN_DEF};
-          my $col_name = $info->{COLUMN_NAME};
-          $col_name =~ s/^\"(.*)\"$/$1/;
-
-          $result{$col_name} = \%column_info;
-        }
-      };
-      return \%result if !$@;
-    }
+sub _dbh_columns_info_for {
+  my ($self, $dbh, $table) = @_;
 
+  if ($dbh->can('column_info')) {
     my %result;
-    my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
-    $sth->execute;
-    my @columns = @{$sth->{NAME_lc}};
-    for my $i ( 0 .. $#columns ){
-      my %column_info;
-      my $type_num = $sth->{TYPE}->[$i];
-      my $type_name;
-      if(defined $type_num && $dbh->can('type_info')) {
-        my $type_info = $dbh->type_info($type_num);
-        $type_name = $type_info->{TYPE_NAME} if $type_info;
+    eval {
+      my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
+      my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
+      $sth->execute();
+      while ( my $info = $sth->fetchrow_hashref() ){
+        my %column_info;
+        $column_info{data_type}   = $info->{TYPE_NAME};
+        $column_info{size}      = $info->{COLUMN_SIZE};
+        $column_info{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
+        $column_info{default_value} = $info->{COLUMN_DEF};
+        my $col_name = $info->{COLUMN_NAME};
+        $col_name =~ s/^\"(.*)\"$/$1/;
+
+        $result{$col_name} = \%column_info;
       }
-      $column_info{data_type} = $type_name ? $type_name : $type_num;
-      $column_info{size} = $sth->{PRECISION}->[$i];
-      $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
+    };
+    return \%result if !$@ && scalar keys %result;
+  }
 
-      if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
-        $column_info{data_type} = $1;
-        $column_info{size}    = $2;
-      }
+  my %result;
+  my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
+  $sth->execute;
+  my @columns = @{$sth->{NAME_lc}};
+  for my $i ( 0 .. $#columns ){
+    my %column_info;
+    my $type_num = $sth->{TYPE}->[$i];
+    my $type_name;
+    if(defined $type_num && $dbh->can('type_info')) {
+      my $type_info = $dbh->type_info($type_num);
+      $type_name = $type_info->{TYPE_NAME} if $type_info;
+    }
+    $column_info{data_type} = $type_name ? $type_name : $type_num;
+    $column_info{size} = $sth->{PRECISION}->[$i];
+    $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
 
-      $result{$columns[$i]} = \%column_info;
+    if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
+      $column_info{data_type} = $1;
+      $column_info{size}    = $2;
     }
 
-    return \%result;
-  });
+    $result{$columns[$i]} = \%column_info;
+  }
+
+  return \%result;
+}
+
+sub columns_info_for {
+  my ($self, $table) = @_;
+  $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
 }
 
 =head2 last_insert_id
@@ -874,10 +973,15 @@ Return the row id of the last insert.
 
 =cut
 
+sub _dbh_last_insert_id {
+    my ($self, $dbh, $source, $col) = @_;
+    # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
+    $dbh->func('last_insert_rowid');
+}
+
 sub last_insert_id {
-  my ($self, $row) = @_;
-    
-  $self->dbh_do(sub { shift->func('last_insert_rowid') });
+  my $self = shift;
+  $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
 }
 
 =head2 sqlt_type
@@ -886,7 +990,7 @@ Returns the database driver name.
 
 =cut
 
-sub sqlt_type { shift->dbh_do(sub { shift->{Driver}->{Name} }) }
+sub sqlt_type { shift->dbh->{Driver}->{Name} }
 
 =head2 create_ddl_dir (EXPERIMENTAL)
 
@@ -896,7 +1000,7 @@ sub sqlt_type { shift->dbh_do(sub { shift->{Driver}->{Name} }) }
 
 =back
 
-Creates an SQL file based on the Schema, for each of the specified
+Creates a SQL file based on the Schema, for each of the specified
 database types, in the given directory.
 
 Note that this feature is currently EXPERIMENTAL and may not work correctly
@@ -956,8 +1060,24 @@ sub create_ddl_dir
 
 =head2 deployment_statements
 
-Create the statements for L</deploy> and
-L<DBIx::Class::Schema/deploy>.
+=over 4
+
+=item Arguments: $schema, $type, $version, $directory, $sqlt_args
+
+=back
+
+Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
+The database driver name is given by C<$type>, though the value from
+L</sqlt_type> is used if it is not specified.
+
+C<$directory> is used to return statements from files in a previously created
+L</create_ddl_dir> directory and is optional. The filenames are constructed
+from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
+
+If no C<$directory> is specified then the statements are constructed on the
+fly using L<SQL::Translator> and C<$version> is ignored.
+
+See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
 
 =cut
 
@@ -998,8 +1118,8 @@ sub deployment_statements {
 }
 
 sub deploy {
-  my ($self, $schema, $type, $sqltargs) = @_;
-  foreach my $statement ( $self->deployment_statements($schema, $type, undef, undef, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
+  my ($self, $schema, $type, $sqltargs, $dir) = @_;
+  foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
     for ( split(";\n", $statement)) {
       next if($_ =~ /^--/);
       next if(!$_);
@@ -1051,7 +1171,6 @@ sub build_datetime_parser {
 sub DESTROY {
   my $self = shift;
   return if !$self->_dbh;
-
   $self->_verify_pid;
   $self->_dbh(undef);
 }
@@ -1104,4 +1223,3 @@ Andy Grundman <andy@hybridized.org>
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-