bulk: add mongoc_bulk_operation_new()

This is useful for situations where you want to create bulk operations
and replay them a number of times.

Fixes CDRIVER-391.

Author: Christian Hergert

build/cmake/libmongoc-ssl.def

@@ -4,9 +4,14 @@ mongoc_bulk_operation_delete_one
 mongoc_bulk_operation_destroy
 mongoc_bulk_operation_execute
 mongoc_bulk_operation_insert
+mongoc_bulk_operation_new
 mongoc_bulk_operation_remove
 mongoc_bulk_operation_remove_one
 mongoc_bulk_operation_replace_one
+mongoc_bulk_operation_set_client
+mongoc_bulk_operation_set_collection
+mongoc_bulk_operation_set_database
+mongoc_bulk_operation_set_hint
 mongoc_bulk_operation_set_write_concern
 mongoc_bulk_operation_update
 mongoc_bulk_operation_update_one

build/cmake/libmongoc.def

@@ -4,9 +4,14 @@ mongoc_bulk_operation_delete_one
 mongoc_bulk_operation_destroy
 mongoc_bulk_operation_execute
 mongoc_bulk_operation_insert
+mongoc_bulk_operation_new
 mongoc_bulk_operation_remove
 mongoc_bulk_operation_remove_one
 mongoc_bulk_operation_replace_one
+mongoc_bulk_operation_set_client
+mongoc_bulk_operation_set_collection
+mongoc_bulk_operation_set_database
+mongoc_bulk_operation_set_hint
 mongoc_bulk_operation_set_write_concern
 mongoc_bulk_operation_update
 mongoc_bulk_operation_update_one

src/libmongoc.symbols

@@ -3,9 +3,14 @@ mongoc_bulk_operation_delete_one
 mongoc_bulk_operation_destroy
 mongoc_bulk_operation_execute
 mongoc_bulk_operation_insert
+mongoc_bulk_operation_new
 mongoc_bulk_operation_remove
 mongoc_bulk_operation_remove_one
 mongoc_bulk_operation_replace_one
+mongoc_bulk_operation_set_client
+mongoc_bulk_operation_set_collection
+mongoc_bulk_operation_set_database
+mongoc_bulk_operation_set_hint
 mongoc_bulk_operation_set_write_concern
 mongoc_bulk_operation_update
 mongoc_bulk_operation_update_one

src/mongoc/mongoc-bulk-operation.c

@@ -44,6 +44,20 @@
  */
 
 
+mongoc_bulk_operation_t *
+mongoc_bulk_operation_new (bool ordered)
+{
+   mongoc_bulk_operation_t *bulk;
+
+   bulk = bson_malloc0 (sizeof *bulk);
+   bulk->ordered = ordered;
+
+   _mongoc_array_init (&bulk->commands, sizeof (mongoc_write_command_t));
+
+   return bulk;
+}
+
+
 mongoc_bulk_operation_t *
 _mongoc_bulk_operation_new (mongoc_client_t              *client,        /* IN */
                             const char                   *database,      /* IN */
@@ -57,23 +71,14 @@ _mongoc_bulk_operation_new (mongoc_client_t              *client,        /* IN *
    BSON_ASSERT (client);
    BSON_ASSERT (collection);
 
-   bulk = bson_malloc0 (sizeof *bulk);
-
+   bulk = mongoc_bulk_operation_new (ordered);
    bulk->client = client;
    bulk->database = bson_strdup (database);
    bulk->collection = bson_strdup (collection);
-   bulk->ordered = ordered;
    bulk->hint = hint;
    bulk->write_concern = mongoc_write_concern_copy (write_concern);
    bulk->executed = false;
 
-   if (!bulk->write_concern) {
-      bulk->write_concern = mongoc_write_concern_new ();
-   }
-
-   _mongoc_write_result_init (&bulk->result);
-   _mongoc_array_init (&bulk->commands, sizeof (mongoc_write_command_t));
-
    return bulk;
 }
 
@@ -95,7 +100,10 @@ mongoc_bulk_operation_destroy (mongoc_bulk_operation_t *bulk) /* IN */
       bson_free (bulk->collection);
       mongoc_write_concern_destroy (bulk->write_concern);
       _mongoc_array_destroy (&bulk->commands);
-      _mongoc_write_result_destroy (&bulk->result);
+
+      if (bulk->executed) {
+         _mongoc_write_result_destroy (&bulk->result);
+      }
 
       bson_free (bulk);
    }
@@ -276,17 +284,41 @@ mongoc_bulk_operation_execute (mongoc_bulk_operation_t *bulk,  /* IN */
 
    bson_return_val_if_fail (bulk, false);
 
+   if (!bulk->write_concern) {
+      bulk->write_concern = mongoc_write_concern_new ();
+   }
+
    if (bulk->executed) {
+      _mongoc_write_result_destroy (&bulk->result);
+   }
+
+   _mongoc_write_result_init (&bulk->result);
+
+   bulk->executed = true;
+
+   if (!bulk->client) {
+      bson_set_error (error,
+                      MONGOC_ERROR_COMMAND,
+                      MONGOC_ERROR_COMMAND_INVALID_ARG,
+                      "mongoc_bulk_operation_execute() requires a client "
+                      "and one has not been set.");
+      return false;
+   } else if (!bulk->database) {
       bson_set_error (error,
                       MONGOC_ERROR_COMMAND,
                       MONGOC_ERROR_COMMAND_INVALID_ARG,
-                      "mongoc_bulk_operation_execute() may only be called "
-                      "once for a bulk operation.");
+                      "mongoc_bulk_operation_execute() requires a database "
+                      "and one has not been set.");
+      return false;
+   } else if (!bulk->collection) {
+      bson_set_error (error,
+                      MONGOC_ERROR_COMMAND,
+                      MONGOC_ERROR_COMMAND_INVALID_ARG,
+                      "mongoc_bulk_operation_execute() requires a collection "
+                      "and one has not been set.");
       return false;
    }
 
-   bulk->executed = true;
-
    if (reply) {
       bson_init (reply);
    }
@@ -336,3 +368,51 @@ mongoc_bulk_operation_set_write_concern (mongoc_bulk_operation_t      *bulk,
       bulk->write_concern = mongoc_write_concern_new ();
    }
 }
+
+
+void
+mongoc_bulk_operation_set_database (mongoc_bulk_operation_t *bulk,
+                                    const char              *database)
+{
+   bson_return_if_fail (bulk);
+
+   if (bulk->database) {
+      bson_free (bulk->database);
+   }
+
+   bulk->database = bson_strdup (database);
+}
+
+
+void
+mongoc_bulk_operation_set_collection (mongoc_bulk_operation_t *bulk,
+                                      const char              *collection)
+{
+   bson_return_if_fail (bulk);
+
+   if (bulk->collection) {
+      bson_free (bulk->collection);
+   }
+
+   bulk->collection = bson_strdup (collection);
+}
+
+
+void
+mongoc_bulk_operation_set_client (mongoc_bulk_operation_t *bulk,
+                                  void                    *client)
+{
+   bson_return_if_fail (bulk);
+
+   bulk->client = client;
+}
+
+
+void
+mongoc_bulk_operation_set_hint (mongoc_bulk_operation_t *bulk,
+                                uint32_t                 hint)
+{
+   bson_return_if_fail (bulk);
+
+   bulk->hint = hint;
+}

src/mongoc/mongoc-bulk-operation.h

@@ -58,8 +58,24 @@ void mongoc_bulk_operation_update_one  (mongoc_bulk_operation_t       *bulk,
                                         const bson_t                  *selector,
                                         const bson_t                  *document,
                                         bool                           upsert);
-void mongoc_bulk_operation_set_write_concern (mongoc_bulk_operation_t      *bulk,
-                                              const mongoc_write_concern_t *write_concern);
+
+
+/*
+ * The following functions are really only useful by language bindings and
+ * those wanting to replay a bulk operation to a number of clients or
+ * collections.
+ */
+mongoc_bulk_operation_t *mongoc_bulk_operation_new               (bool                          ordered);
+void                     mongoc_bulk_operation_set_write_concern (mongoc_bulk_operation_t      *bulk,
+                                                                  const mongoc_write_concern_t *write_concern);
+void                     mongoc_bulk_operation_set_database      (mongoc_bulk_operation_t      *bulk,
+                                                                  const char                   *database);
+void                     mongoc_bulk_operation_set_collection    (mongoc_bulk_operation_t      *bulk,
+                                                                  const char                   *collection);
+void                     mongoc_bulk_operation_set_client        (mongoc_bulk_operation_t      *bulk,
+                                                                  void                         *client);
+void                     mongoc_bulk_operation_set_hint          (mongoc_bulk_operation_t      *bulk,
+                                                                  uint32_t                      hint);
 
 
 BSON_END_DECLS

src/mongoc/mongoc-collection.c

@@ -18,6 +18,7 @@
 #include <bcon.h>
 #include <stdio.h>
 
+#include "mongoc-bulk-operation.h"
 #include "mongoc-bulk-operation-private.h"
 #include "mongoc-client-private.h"
 #include "mongoc-collection.h"

tests/test-bulk.c

@@ -422,7 +422,66 @@ test_bulk_edge_case_372 (void)
 
    bson_destroy (&reply);
 
+   mongoc_collection_drop (collection, NULL);
+
+   mongoc_bulk_operation_destroy (bulk);
+   mongoc_collection_destroy (collection);
+   mongoc_client_destroy (client);
+}
+
+
+static void
+test_bulk_new (void)
+{
+   mongoc_bulk_operation_t *bulk;
+   mongoc_collection_t *collection;
+   mongoc_client_t *client;
+   bson_error_t error;
+   bson_t empty = BSON_INITIALIZER;
+   bool r;
+
+   client = mongoc_client_new (gTestUri);
+   assert (client);
+
+   collection = get_test_collection (client, "bulk_new");
+   assert (collection);
+
+   bulk = mongoc_bulk_operation_new (true);
    mongoc_bulk_operation_destroy (bulk);
+
+   bulk = mongoc_bulk_operation_new (true);
+
+   r = mongoc_bulk_operation_execute (bulk, NULL, &error);
+   assert (!r);
+   assert (error.domain = MONGOC_ERROR_CLIENT);
+   assert (error.code = MONGOC_ERROR_COMMAND_INVALID_ARG);
+
+   mongoc_bulk_operation_set_database (bulk, "test");
+   r = mongoc_bulk_operation_execute (bulk, NULL, &error);
+   assert (!r);
+   assert (error.domain = MONGOC_ERROR_CLIENT);
+   assert (error.code = MONGOC_ERROR_COMMAND_INVALID_ARG);
+
+   mongoc_bulk_operation_set_collection (bulk, "test");
+   r = mongoc_bulk_operation_execute (bulk, NULL, &error);
+   assert (!r);
+   assert (error.domain = MONGOC_ERROR_CLIENT);
+   assert (error.code = MONGOC_ERROR_COMMAND_INVALID_ARG);
+
+   mongoc_bulk_operation_set_client (bulk, client);
+   r = mongoc_bulk_operation_execute (bulk, NULL, &error);
+   assert (!r);
+   assert (error.domain = MONGOC_ERROR_CLIENT);
+   assert (error.code = MONGOC_ERROR_COMMAND_INVALID_ARG);
+
+   mongoc_bulk_operation_insert (bulk, &empty);
+   r = mongoc_bulk_operation_execute (bulk, NULL, &error);
+   assert (r);
+
+   mongoc_bulk_operation_destroy (bulk);
+
+   mongoc_collection_drop (collection, NULL);
+
    mongoc_collection_destroy (collection);
    mongoc_client_destroy (client);
 }
@@ -437,6 +496,7 @@ test_bulk_install (TestSuite *suite)
    TestSuite_Add (suite, "/BulkOperation/update_upserted", test_update_upserted);
    TestSuite_Add (suite, "/BulkOperation/index_offset", test_index_offset);
    TestSuite_Add (suite, "/BulkOperation/CDRIVER-372", test_bulk_edge_case_372);
+   TestSuite_Add (suite, "/BulkOperation/new", test_bulk_new);
 
    atexit (cleanup_globals);
 }