SERVER-12380 Refactor update() and receivedUpdate() for better reuse.

This patch introduces an UpdateExecutor type, that encapsulates the work of
performing a database update, described by the existing UpdateRequest type.
This includes any necessary parsing and also driving execution of the match
query and the update transformations.  The UpdateExecutor interface makes it
convenient for users to prepare the operation to the greatest extent possible in
an unlocked context, without having to know the details of what that preparation
entails.

1 files changed, 13 insertions, 0 deletions

diff --git a/src/mongo/db/ops/update.h b/src/mongo/db/ops/update.h
index 79970ab49cc..34d290cfe85 100644
--- a/src/mongo/db/ops/update.h
+++ b/src/mongo/db/ops/update.h
@@ -40,8 +40,21 @@ namespace mongo {
     class CanonicalQuery;
     class UpdateDriver;
 
+    /**
+     * Utility method to execute an update described by "request".
+     *
+     * Caller must hold the appropriate database locks.
+     */
     UpdateResult update(const UpdateRequest& request, OpDebug* opDebug);
 
+    /**
+     * Execute the update described by "request", using the given already-parsed
+     * driver and canonical query.
+     *
+     * NOTE: This function is really a utility method for UpdateExecutor.
+     *
+     * TODO: Move this into a private method of UpdateExecutor.
+     */
     UpdateResult update(const UpdateRequest& request,
                         OpDebug* opDebug,
                         UpdateDriver* driver,