::Replicated - test hashref for connect_replicants and croak on coderef, switch to...

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

diff --git a/lib/DBIx/Class/Storage.pm b/lib/DBIx/Class/Storage.pm
index e57a48b..eb87d4f 100644 (file)
--- a/lib/DBIx/Class/Storage.pm
+++ b/lib/DBIx/Class/Storage.pm
@@ -301,7 +301,23 @@ sub svp_rollback { die "Virtual method!" }
 
 =head2 txn_scope_guard
 
-Return an object that does stuff.
+An alternative way of transaction handling based on
+L<DBIx::Class::Storage::TxnScopeGuard>:
+
+ my $txn_guard = $storage->txn_scope_guard;
+
+ $row->col1("val1");
+ $row->update;
+
+ $txn_guard->commit;
+
+If an exception occurs, or the guard object otherwise leaves the scope
+before C<< $txn_guard->commit >> is called, the transaction will be rolled
+back by an explicit L</txn_rollback> call. In essence this is akin to
+using a L</txn_begin>/L</txn_commit> pair, without having to worry
+about calling L</txn_rollback> at the right places. Note that since there
+is no defined code closure, there will be no retries and other magic upon
+database disconnection. If you need such functionality see L</txn_do>.
 
 =cut
 
@@ -438,15 +454,6 @@ only.
 
 sub select_single { die "Virtual method!" }
 
-=head2 reload_row ($row)
-
-given a L<DBIx::Class::Row> object, loads and returns the matching version from
-storage.  Does not effect the existing row object.
-
-=cut
-
-sub reload_row { die "Virtual method!" }
-
 =head2 columns_info_for
 
 Returns metadata for the given source's columns.  This