CDRIVER-3552 allow hinting delete commands

Author: alcaeus

build/generate-opts.py

@@ -177,14 +177,18 @@ def __init__(self, items, **defaults):
         bypass_option,
     ], validate='_mongoc_default_insert_vflags', ordered='true')),
 
-    ('mongoc_delete_one_opts_t', Struct([
+    ('mongoc_delete_opts_t', Shared([
         ('crud', {'type': 'mongoc_crud_opts_t'}),
         collation_option,
+        hint_option,
+    ])),
+
+    ('mongoc_delete_one_opts_t', Struct([
+        ('delete', {'type': 'mongoc_delete_opts_t'}),
     ])),
 
     ('mongoc_delete_many_opts_t', Struct([
-        ('crud', {'type': 'mongoc_crud_opts_t'}),
-        collation_option,
+        ('delete', {'type': 'mongoc_delete_opts_t'}),
     ])),
 
     ('mongoc_update_one_opts_t', Struct([
@@ -248,6 +252,7 @@ def __init__(self, items, **defaults):
 
     ('mongoc_bulk_remove_opts_t', Shared([
         collation_option,
+        hint_option,
         ('limit', {'type': 'int32_t', 'hidden': True})
     ])),
 

src/libmongoc/doc/includes/bulk-remove-many-opts.txt

@@ -6,3 +6,4 @@
 ``opts`` may be NULL or a BSON document with additional command options:
 
 * ``collation``: Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://docs.mongodb.com/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.
+* ``hint``: A document or string that specifies the index to use to support the query predicate.

src/libmongoc/doc/includes/bulk-remove-one-opts.txt

@@ -6,3 +6,4 @@
 ``opts`` may be NULL or a BSON document with additional command options:
 
 * ``collation``: Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://docs.mongodb.com/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.
+* ``hint``: A document or string that specifies the index to use to support the query predicate.

src/libmongoc/doc/includes/delete-many-opts.txt

@@ -9,3 +9,4 @@
 * ``sessionId``: First, construct a :symbol:`mongoc_client_session_t` with :symbol:`mongoc_client_start_session`. You can begin a transaction with :symbol:`mongoc_client_session_start_transaction`, optionally with a :symbol:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :symbol:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :symbol:`mongoc_client_session_t`.
 * ``validate``: Construct a bitwise-or of all desired :symbol:`bson_validate_flags_t <bson_validate_with_error>`. Set to ``false`` to skip client-side validation of the provided BSON documents.
 * ``collation``: Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://docs.mongodb.com/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.
+* ``hint``: A document or string that specifies the index to use to support the query predicate.

src/libmongoc/doc/includes/delete-one-opts.txt

@@ -9,3 +9,4 @@
 * ``sessionId``: First, construct a :symbol:`mongoc_client_session_t` with :symbol:`mongoc_client_start_session`. You can begin a transaction with :symbol:`mongoc_client_session_start_transaction`, optionally with a :symbol:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :symbol:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :symbol:`mongoc_client_session_t`.
 * ``validate``: Construct a bitwise-or of all desired :symbol:`bson_validate_flags_t <bson_validate_with_error>`. Set to ``false`` to skip client-side validation of the provided BSON documents.
 * ``collation``: Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://docs.mongodb.com/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.
+* ``hint``: A document or string that specifies the index to use to support the query predicate.

src/libmongoc/src/mongoc/mongoc-bulk-operation.c

@@ -148,6 +148,7 @@ _mongoc_bulk_operation_remove_with_opts (
    bson_t opts;
    bool has_collation;
    bool ret = false;
+   bool has_delete_hint;
 
    ENTRY;
 
@@ -174,11 +175,17 @@ _mongoc_bulk_operation_remove_with_opts (
       bson_append_document (&opts, "collation", 9, &remove_opts->collation);
    }
 
+   has_delete_hint = !!(remove_opts->hint.value_type);
+   if (has_delete_hint) {
+      bson_append_value (&opts, "hint", 4, &remove_opts->hint);
+   }
+
    if (bulk->commands.len) {
       last = &_mongoc_array_index (
          &bulk->commands, mongoc_write_command_t, bulk->commands.len - 1);
       if (last->type == MONGOC_WRITE_COMMAND_DELETE) {
          last->flags.has_collation |= has_collation;
+         last->flags.has_delete_hint |= has_delete_hint;
          last->flags.has_multi_write |= (remove_opts->limit == 0);
          _mongoc_write_command_delete_append (last, selector, &opts);
          ret = true;
@@ -190,6 +197,7 @@ _mongoc_bulk_operation_remove_with_opts (
       &command, selector, NULL, &opts, bulk->flags, bulk->operation_id);
 
    command.flags.has_collation = has_collation;
+   command.flags.has_delete_hint = has_delete_hint;
    command.flags.has_multi_write = (remove_opts->limit == 0);
 
    _mongoc_array_append_val (&bulk->commands, command);

src/libmongoc/src/mongoc/mongoc-client-private.h

@@ -59,6 +59,8 @@ BSON_BEGIN_DECLS
 #define WIRE_VERSION_CMD_WRITE_CONCERN 5
 /* first version to support collation */
 #define WIRE_VERSION_COLLATION 5
+/* first version to support server-side errors for unsupported hint options */
+#define WIRE_VERSION_HINT_SERVER_SIDE_ERROR 5
 /* first version to support OP_MSG */
 #define WIRE_VERSION_OP_MSG 6
 /* first version to support array filters for "update" command */
@@ -75,6 +77,13 @@ BSON_BEGIN_DECLS
 #define WIRE_VERSION_4_2 8
 /* version corresponding to client side field level encryption support. */
 #define WIRE_VERSION_CSE 8
+/* first version to throw server-side errors for unsupported hint in
+ * "findAndModify" command */
+#define WIRE_VERSION_FIND_AND_MODIFY_HINT_SERVER_SIDE_ERROR 8
+/* first version to support hint for "delete" command */
+#define WIRE_VERSION_DELETE_HINT 9
+/* first version to support hint for "findAndModify" command */
+#define WIRE_VERSION_FIND_AND_MODIFY_HINT 9
 /* version corresponding to server 4.4 release */
 #define WIRE_VERSION_4_4 9
 /* version corresponding to retryable writes error label */

src/libmongoc/src/mongoc/mongoc-collection.c

@@ -2318,9 +2318,8 @@ static bool
 _mongoc_delete_one_or_many (mongoc_collection_t *collection,
                             bool multi,
                             const bson_t *selector,
-                            mongoc_crud_opts_t *crud,
+                            mongoc_delete_opts_t *delete_opts,
                             const bson_t *cmd_opts,
-                            const bson_t *collation,
                             bson_t *opts,
                             bson_t *reply,
                             bson_error_t *error)
@@ -2338,8 +2337,12 @@ _mongoc_delete_one_or_many (mongoc_collection_t *collection,
    _mongoc_write_result_init (&result);
    bson_append_int32 (opts, "limit", 5, multi ? 0 : 1);
 
-   if (!bson_empty (collation)) {
-      bson_append_document (opts, "collation", 9, collation);
+   if (!bson_empty (&delete_opts->collation)) {
+      bson_append_document (opts, "collation", 9, &delete_opts->collation);
+   }
+
+   if (delete_opts->hint.value_type) {
+      bson_append_value (opts, "hint", 4, &delete_opts->hint);
    }
 
    _mongoc_write_command_init_delete_idl (
@@ -2350,17 +2353,20 @@ _mongoc_delete_one_or_many (mongoc_collection_t *collection,
       ++collection->client->cluster.operation_id);
 
    command.flags.has_multi_write = multi;
-   if (!bson_empty (collation)) {
+   if (!bson_empty (&delete_opts->collation)) {
       command.flags.has_collation = true;
    }
+   if (delete_opts->hint.value_type) {
+      command.flags.has_delete_hint = true;
+   }
 
    _mongoc_collection_write_command_execute_idl (
-      &command, collection, crud, &result);
+      &command, collection, &delete_opts->crud, &result);
 
    /* set field described in CRUD spec for the DeleteResult */
    ret = MONGOC_WRITE_RESULT_COMPLETE (&result,
                                        collection->client->error_api_version,
-                                       crud->writeConcern,
+                                       delete_opts->crud.writeConcern,
                                        /* no error domain override */
                                        (mongoc_error_domain_t) 0,
                                        reply,
@@ -2399,9 +2405,8 @@ mongoc_collection_delete_one (mongoc_collection_t *collection,
    ret = _mongoc_delete_one_or_many (collection,
                                      false /* multi */,
                                      selector,
-                                     &delete_one_opts.crud,
+                                     &delete_one_opts.delete,
                                      &delete_one_opts.extra,
-                                     &delete_one_opts.collation,
                                      &limit,
                                      reply,
                                      error);
@@ -2438,9 +2443,8 @@ mongoc_collection_delete_many (mongoc_collection_t *collection,
    ret = _mongoc_delete_one_or_many (collection,
                                      true /* multi */,
                                      selector,
-                                     &delete_many_opts.crud,
+                                     &delete_many_opts.delete,
                                      &delete_many_opts.extra,
-                                     &delete_many_opts.collation,
                                      &limit,
                                      reply,
                                      error);
@@ -3031,6 +3035,7 @@ mongoc_collection_find_and_modify_with_opts (
    mongoc_server_stream_t *server_stream = NULL;
    mongoc_server_stream_t *retry_server_stream = NULL;
    mongoc_find_and_modify_appended_opts_t appended_opts;
+   mongoc_write_concern_t *write_concern = NULL;
 
    ENTRY;
 
@@ -3062,15 +3067,6 @@ mongoc_collection_find_and_modify_with_opts (
       GOTO (done);
    }
 
-   if (appended_opts.hint.value_type &&
-       server_stream->sd->max_wire_version < WIRE_VERSION_4_2) {
-      bson_set_error (error,
-                      MONGOC_ERROR_COMMAND,
-                      MONGOC_ERROR_PROTOCOL_BAD_WIRE_VERSION,
-                      "selected server does not support hint on findAndModify");
-      GOTO (done);
-   }
-
    name = mongoc_collection_get_name (collection);
    BSON_APPEND_UTF8 (&command, "findAndModify", name);
    BSON_APPEND_DOCUMENT (&command, "query", query);
@@ -3120,16 +3116,49 @@ mongoc_collection_find_and_modify_with_opts (
    }
 
    if (appended_opts.writeConcern) {
-      if (!mongoc_cmd_parts_set_write_concern (
-             &parts,
-             appended_opts.writeConcern,
-             server_stream->sd->max_wire_version,
-             error)) {
+      if (_mongoc_client_session_in_txn (parts.assembled.session)) {
+         bson_set_error (error,
+                         MONGOC_ERROR_COMMAND,
+                         MONGOC_ERROR_COMMAND_INVALID_ARG,
+                         "Cannot set write concern after starting transaction");
          GOTO (done);
       }
+
+      write_concern = appended_opts.writeConcern;
+   }
+
+   if (!write_concern) {
+      if (server_stream->sd->max_wire_version >=
+             WIRE_VERSION_FAM_WRITE_CONCERN &&
+          (mongoc_write_concern_is_acknowledged (collection->write_concern) ||
+           !_mongoc_client_session_in_txn (parts.assembled.session))) {
+         if (!mongoc_write_concern_is_valid (collection->write_concern)) {
+            bson_set_error (error,
+                            MONGOC_ERROR_COMMAND,
+                            MONGOC_ERROR_COMMAND_INVALID_ARG,
+                            "The write concern is invalid.");
+            GOTO (done);
+         }
+
+         write_concern = collection->write_concern;
+      }
    }
 
    if (appended_opts.hint.value_type) {
+      int max_wire_version =
+         mongoc_write_concern_is_acknowledged (write_concern)
+            ? WIRE_VERSION_FIND_AND_MODIFY_HINT_SERVER_SIDE_ERROR
+            : WIRE_VERSION_FIND_AND_MODIFY_HINT;
+
+      if (server_stream->sd->max_wire_version < max_wire_version) {
+         bson_set_error (
+            error,
+            MONGOC_ERROR_COMMAND,
+            MONGOC_ERROR_PROTOCOL_BAD_WIRE_VERSION,
+            "selected server does not support hint on findAndModify");
+         GOTO (done);
+      }
+
       bson_append_value (&parts.extra, "hint", 4, &appended_opts.hint);
    }
 
@@ -3143,38 +3172,13 @@ mongoc_collection_find_and_modify_with_opts (
       }
    }
 
-   if (_mongoc_client_session_in_txn (parts.assembled.session) &&
-       appended_opts.writeConcern) {
-      bson_set_error (error,
-                      MONGOC_ERROR_COMMAND,
-                      MONGOC_ERROR_COMMAND_INVALID_ARG,
-                      "Cannot set write concern after starting transaction");
+   /* An empty write concern amounts to a no-op, so there's no need to guard
+    * against it. */
+   if (!mongoc_cmd_parts_set_write_concern (
+          &parts, write_concern, server_stream->sd->max_wire_version, error)) {
       GOTO (done);
    }
 
-   if (!appended_opts.writeConcern) {
-      if (server_stream->sd->max_wire_version >=
-          WIRE_VERSION_FAM_WRITE_CONCERN) {
-         if (!mongoc_write_concern_is_valid (collection->write_concern)) {
-            bson_set_error (error,
-                            MONGOC_ERROR_COMMAND,
-                            MONGOC_ERROR_COMMAND_INVALID_ARG,
-                            "The write concern is invalid.");
-            GOTO (done);
-         }
-
-         if (mongoc_write_concern_is_acknowledged (collection->write_concern)) {
-            if (!mongoc_cmd_parts_set_write_concern (
-                   &parts,
-                   collection->write_concern,
-                   server_stream->sd->max_wire_version,
-                   error)) {
-               GOTO (done);
-            }
-         }
-      }
-   }
-
    parts.assembled.operation_id = ++cluster->operation_id;
    if (!mongoc_cmd_parts_assemble (&parts, server_stream, error)) {
       GOTO (done);

src/libmongoc/src/mongoc/mongoc-opts-private.h

@@ -46,15 +46,19 @@ typedef struct _mongoc_insert_many_opts_t {
    bson_t extra;
 } mongoc_insert_many_opts_t;
 
-typedef struct _mongoc_delete_one_opts_t {
+typedef struct _mongoc_delete_opts_t {
    mongoc_crud_opts_t crud;
    bson_t collation;
+   bson_value_t hint;
+} mongoc_delete_opts_t;
+
+typedef struct _mongoc_delete_one_opts_t {
+   mongoc_delete_opts_t delete;
    bson_t extra;
 } mongoc_delete_one_opts_t;
 
 typedef struct _mongoc_delete_many_opts_t {
-   mongoc_crud_opts_t crud;
-   bson_t collation;
+   mongoc_delete_opts_t delete;
    bson_t extra;
 } mongoc_delete_many_opts_t;
 
@@ -115,6 +119,7 @@ typedef struct _mongoc_bulk_replace_one_opts_t {
 
 typedef struct _mongoc_bulk_remove_opts_t {
    bson_t collation;
+   bson_value_t hint;
    int32_t limit;
 } mongoc_bulk_remove_opts_t;