CDRIVER-5711 remove mongoc_collection_delete and unused flags (#1923)

kevinAlbs · web-flow · commit a5fbaceb7f3a · 2025-03-17T13:33:25.000-04:00
* remove `mongoc_collection_delete`

* remove `mongoc_delete_flags_t`

* remove `mongoc_reply_flags_t` from public API
diff --git a/NEWS b/NEWS
@@ -16,6 +16,8 @@ Unreleased (2.0.0)
 * `MONGOC_QUERY_SLAVE_OK` is removed. Use the equivalent `MONGOC_QUERY_SECONDARY_OK` instead.
 * `MONGOC_URI_SLAVEOK` is removed. It was unused.
 * `mongoc_collection_save` is removed. Use `mongoc_collection_insert_one` or `mongoc_collection_replace_one` instead.
+* `mongoc_collection_delete` is removed. Use `mongoc_collection_delete_one` or `mongoc_collection_delete_many` instead.
+* `mongoc_delete_flags_t` and `mongoc_reply_flags_t` are removed.
 
 ### Forwarding headers (`#include <bson.h>` and `#include <mongoc.h>`)
 
diff --git a/src/libmongoc/doc/api.rst b/src/libmongoc/doc/api.rst
@@ -30,7 +30,6 @@ API Reference
    mongoc_collection_t
    mongoc_cursor_t
    mongoc_database_t
-   mongoc_delete_flags_t
    mongoc_find_and_modify_opts_t
    mongoc_gridfs_file_list_t
    mongoc_gridfs_file_opt_t
@@ -50,7 +49,6 @@ API Reference
    mongoc_read_mode_t
    mongoc_read_prefs_t
    mongoc_remove_flags_t
-   mongoc_reply_flags_t
    mongoc_server_api_t
    mongoc_server_api_version_t
    mongoc_server_description_t
diff --git a/src/libmongoc/doc/mongoc_collection_delete.rst b/src/libmongoc/doc/mongoc_collection_delete.rst
diff --git a/src/libmongoc/doc/mongoc_collection_get_last_error.rst b/src/libmongoc/doc/mongoc_collection_get_last_error.rst
@@ -39,7 +39,6 @@ Description
 
 - :symbol:`mongoc_collection_update`
 - :symbol:`mongoc_collection_remove`
-- :symbol:`mongoc_collection_delete`
 - :symbol:`mongoc_collection_insert_bulk`
 - :symbol:`mongoc_collection_insert`
 
diff --git a/src/libmongoc/doc/mongoc_collection_t.rst b/src/libmongoc/doc/mongoc_collection_t.rst
@@ -40,7 +40,6 @@ Read preferences and write concerns are inherited from the parent client. They c
     mongoc_collection_create_index
     mongoc_collection_create_index_with_opts
     mongoc_collection_create_indexes_with_opts
-    mongoc_collection_delete
     mongoc_collection_delete_many
     mongoc_collection_delete_one
     mongoc_collection_destroy
diff --git a/src/libmongoc/doc/mongoc_delete_flags_t.rst b/src/libmongoc/doc/mongoc_delete_flags_t.rst
diff --git a/src/libmongoc/doc/mongoc_reply_flags_t.rst b/src/libmongoc/doc/mongoc_reply_flags_t.rst
diff --git a/src/libmongoc/src/mongoc/mongoc-collection.c b/src/libmongoc/src/mongoc/mongoc-collection.c
@@ -2348,17 +2348,6 @@ mongoc_collection_remove (mongoc_collection_t *collection,
 }
 
 
-bool
-mongoc_collection_delete (mongoc_collection_t *collection,
-                          mongoc_delete_flags_t flags,
-                          const bson_t *selector,
-                          const mongoc_write_concern_t *write_concern,
-                          bson_error_t *error)
-{
-   return mongoc_collection_remove (collection, (mongoc_remove_flags_t) flags, selector, write_concern, error);
-}
-
-
 static bool
 _mongoc_delete_one_or_many (mongoc_collection_t *collection,
                             bool multi,
diff --git a/src/libmongoc/src/mongoc/mongoc-collection.h b/src/libmongoc/src/mongoc/mongoc-collection.h
@@ -251,13 +251,6 @@ mongoc_collection_replace_one (mongoc_collection_t *collection,
                                bson_t *reply,
                                bson_error_t *error);
 
-BSON_DEPRECATED_FOR (mongoc_collection_delete_one or mongoc_collection_delete_many)
-MONGOC_EXPORT (bool) mongoc_collection_delete (mongoc_collection_t *collection,
-                                               mongoc_delete_flags_t flags,
-                                               const bson_t *selector,
-                                               const mongoc_write_concern_t *write_concern,
-                                               bson_error_t *error);
-
 MONGOC_EXPORT (bool)
 mongoc_collection_remove (mongoc_collection_t *collection,
                           mongoc_remove_flags_t flags,
diff --git a/src/libmongoc/src/mongoc/mongoc-flags.c b/src/libmongoc/src/mongoc/mongoc-flags.c
@@ -36,12 +36,6 @@ BSON_STATIC_ASSERT (MONGOC_OP_MSG_FLAG_CHECKSUM_PRESENT == MONGOC_MSG_CHECKSUM_P
 BSON_STATIC_ASSERT (MONGOC_OP_MSG_FLAG_MORE_TO_COME == MONGOC_MSG_MORE_TO_COME);
 BSON_STATIC_ASSERT (MONGOC_OP_MSG_FLAG_EXHAUST_ALLOWED == MONGOC_MSG_EXHAUST_ALLOWED);
 
-BSON_STATIC_ASSERT (MONGOC_OP_REPLY_RESPONSE_FLAG_NONE == MONGOC_REPLY_NONE);
-BSON_STATIC_ASSERT (MONGOC_OP_REPLY_RESPONSE_FLAG_CURSOR_NOT_FOUND == MONGOC_REPLY_CURSOR_NOT_FOUND);
-BSON_STATIC_ASSERT (MONGOC_OP_REPLY_RESPONSE_FLAG_QUERY_FAILURE == MONGOC_REPLY_QUERY_FAILURE);
-BSON_STATIC_ASSERT (MONGOC_OP_REPLY_RESPONSE_FLAG_SHARD_CONFIG_STALE == MONGOC_REPLY_SHARD_CONFIG_STALE);
-BSON_STATIC_ASSERT (MONGOC_OP_REPLY_RESPONSE_FLAG_AWAIT_CAPABLE == MONGOC_REPLY_AWAIT_CAPABLE);
-
 BSON_STATIC_ASSERT (MONGOC_OP_UPDATE_FLAG_NONE == MONGOC_UPDATE_NONE);
 BSON_STATIC_ASSERT (MONGOC_OP_UPDATE_FLAG_UPSERT == MONGOC_UPDATE_UPSERT);
 BSON_STATIC_ASSERT (MONGOC_OP_UPDATE_FLAG_MULTI_UPDATE == MONGOC_UPDATE_MULTI_UPDATE);
@@ -57,6 +51,3 @@ BSON_STATIC_ASSERT (MONGOC_OP_QUERY_FLAG_NO_CURSOR_TIMEOUT == MONGOC_QUERY_NO_CU
 BSON_STATIC_ASSERT (MONGOC_OP_QUERY_FLAG_AWAIT_DATA == MONGOC_QUERY_AWAIT_DATA);
 BSON_STATIC_ASSERT (MONGOC_OP_QUERY_FLAG_EXHAUST == MONGOC_QUERY_EXHAUST);
 BSON_STATIC_ASSERT (MONGOC_OP_QUERY_FLAG_PARTIAL == MONGOC_QUERY_PARTIAL);
-
-BSON_STATIC_ASSERT (MONGOC_OP_DELETE_FLAG_NONE == MONGOC_DELETE_NONE);
-BSON_STATIC_ASSERT (MONGOC_OP_DELETE_FLAG_SINGLE_REMOVE == MONGOC_DELETE_SINGLE_REMOVE);
diff --git a/src/libmongoc/src/mongoc/mongoc-flags.h b/src/libmongoc/src/mongoc/mongoc-flags.h
@@ -25,23 +25,6 @@
 BSON_BEGIN_DECLS
 
 
-/**
- * mongoc_delete_flags_t:
- * @MONGOC_DELETE_NONE: Specify no delete flags.
- * @MONGOC_DELETE_SINGLE_REMOVE: Only remove the first document matching the
- *    document selector.
- *
- * This type is only for use with deprecated functions and should not be
- * used in new code. Use mongoc_remove_flags_t instead.
- *
- * #mongoc_delete_flags_t are used when performing a delete operation.
- */
-typedef enum {
-   MONGOC_DELETE_NONE = 0,
-   MONGOC_DELETE_SINGLE_REMOVE = 1 << 0,
-} mongoc_delete_flags_t;
-
-
 /**
  * mongoc_remove_flags_t:
  * @MONGOC_REMOVE_NONE: Specify no delete flags.
@@ -104,27 +87,6 @@ typedef enum {
 } mongoc_query_flags_t;
 
 
-/**
- * mongoc_reply_flags_t:
- * @MONGOC_REPLY_NONE: No flags set.
- * @MONGOC_REPLY_CURSOR_NOT_FOUND: Cursor was not found.
- * @MONGOC_REPLY_QUERY_FAILURE: Query failed, error document provided.
- * @MONGOC_REPLY_SHARD_CONFIG_STALE: Shard configuration is stale.
- * @MONGOC_REPLY_AWAIT_CAPABLE: Wait for data to be returned until timeout
- *    has passed. Used with %MONGOC_QUERY_TAILABLE_CURSOR.
- *
- * #mongoc_reply_flags_t contains flags supplied by the Mongo server in reply
- * to a request.
- */
-typedef enum {
-   MONGOC_REPLY_NONE = 0,
-   MONGOC_REPLY_CURSOR_NOT_FOUND = 1 << 0,
-   MONGOC_REPLY_QUERY_FAILURE = 1 << 1,
-   MONGOC_REPLY_SHARD_CONFIG_STALE = 1 << 2,
-   MONGOC_REPLY_AWAIT_CAPABLE = 1 << 3,
-} mongoc_reply_flags_t;
-
-
 /**
  * mongoc_update_flags_t:
  * @MONGOC_UPDATE_NONE: No update flags specified.
diff --git a/src/libmongoc/tests/mock_server/mock-server.h b/src/libmongoc/tests/mock_server/mock-server.h
@@ -20,6 +20,16 @@
 #include <bson/bson.h>
 
 #include <mongoc/mongoc-flags-private.h>
+
+// mongoc_reply_flags_t represents flags for the legacy OP_REPLY protocol:
+typedef enum {
+   MONGOC_REPLY_NONE = 0,
+   MONGOC_REPLY_CURSOR_NOT_FOUND = 1 << 0,
+   MONGOC_REPLY_QUERY_FAILURE = 1 << 1,
+   MONGOC_REPLY_SHARD_CONFIG_STALE = 1 << 2,
+   MONGOC_REPLY_AWAIT_CAPABLE = 1 << 3,
+} mongoc_reply_flags_t;
+
 #include <mongoc/mongoc-uri.h>
 
 #ifdef MONGOC_ENABLE_SSL
diff --git a/src/libmongoc/tests/test-mongoc-collection.c b/src/libmongoc/tests/test-mongoc-collection.c
@@ -5316,10 +5316,8 @@ test_remove_multi (void)
       mongoc_collection_remove (collection, MONGOC_REMOVE_NONE, tmp_bson ("{'_id': {'$gte': 8}}"), NULL, &error),
       error);
 
-   /* mongoc_collection_delete is an alias of mongoc_collection_remove, although
-    * its flag type differs slightly */
    ASSERT_OR_PRINT (
-      mongoc_collection_delete (collection, MONGOC_DELETE_NONE, tmp_bson ("{'_id': {'$lt': 2}}"), NULL, &error), error);
+      mongoc_collection_remove (collection, MONGOC_REMOVE_NONE, tmp_bson ("{'_id': {'$lt': 2}}"), NULL, &error), error);
 
    _test_docs_in_coll_matches (collection, tmp_bson ("{'x': 1234}"), NULL, 6);
 
@@ -5684,25 +5682,6 @@ test_get_last_error (void)
             {"nInserted" : 0, "nMatched" : 0, "nModified" : 0, "nRemoved" : 1, "nUpserted" : 0, "writeErrors" : []}));
    }
 
-   // Test mongoc_collection_delete:
-   {
-      mongoc_collection_drop (coll, NULL);
-
-      // Clear error:
-      ASSERT_OR_PRINT (mongoc_collection_command_simple (coll, tmp_bson ("{'ping': 1}"), NULL, NULL, &error), error);
-      ASSERT (!mongoc_collection_get_last_error (coll));
-
-      // Insert a document to delete:
-      ASSERT_OR_PRINT (mongoc_collection_insert_one (coll, tmp_bson ("{'_id': 0}"), NULL, NULL, &error), error);
-
-      ok = mongoc_collection_delete (coll, MONGOC_DELETE_NONE, tmp_bson ("{}"), NULL, &error);
-      ASSERT_OR_PRINT (ok, error);
-      const bson_t *gle = mongoc_collection_get_last_error (coll);
-      ASSERT_MATCH (
-         gle,
-         BSON_STR (
-            {"nInserted" : 0, "nMatched" : 0, "nModified" : 0, "nRemoved" : 1, "nUpserted" : 0, "writeErrors" : []}));
-   }
 
    // Test mongoc_collection_insert_bulk:
    {
