CDRIVER-1985 Deprecate mongoc_collection_save

Author: bjori

doc/mongoc_collection_save.rst

@@ -3,6 +3,15 @@
 mongoc_collection_save()
 ========================
 
+Deprecated
+----------
+
+This function is deprecated and should not be used in new code.
+
+Please use :symbol:`mongoc_collection_insert() <mongoc_collection_insert>` or
+:symbol:`mongoc_collection_update() <mongoc_collection_update>` instead.
+
+
 Synopsis
 --------
 
@@ -12,7 +21,8 @@ Synopsis
   mongoc_collection_save (mongoc_collection_t *collection,
                           const bson_t *document,
                           const mongoc_write_concern_t *write_concern,
-                          bson_error_t *error);
+                          bson_error_t *error)
+      BSON_GNUC_DEPRECATED_FOR (mongoc_collection_insert or mongoc_collection_update);
 
 Parameters
 ----------

src/mongoc/mongoc-collection.h

@@ -188,7 +188,8 @@ BSON_EXPORT (bool)
 mongoc_collection_save (mongoc_collection_t *collection,
                         const bson_t *document,
                         const mongoc_write_concern_t *write_concern,
-                        bson_error_t *error);
+                        bson_error_t *error)
+   BSON_GNUC_DEPRECATED_FOR (mongoc_collection_insert or mongoc_collection_update);
 BSON_EXPORT (bool)
 mongoc_collection_remove (mongoc_collection_t *collection,
                           mongoc_remove_flags_t flags,

src/mongoc/mongoc-database.c

@@ -414,7 +414,7 @@ mongoc_database_add_user_legacy (mongoc_database_t *database,
       bson_append_utf8 (&user, "pwd", 3, pwd, -1);
    }
 
-   if (!mongoc_collection_save (collection, &user, NULL, error)) {
+   if (!mongoc_collection_insert (collection, MONGOC_INSERT_NONE, &user, NULL, error)) {
       GOTO (failure_with_user);
    }
 

tests/test-mongoc-collection.c

@@ -1231,6 +1231,8 @@ test_save (void)
    context = bson_context_new (BSON_CONTEXT_NONE);
    ASSERT (context);
 
+   BEGIN_IGNORE_DEPRECATIONS;
+
    for (i = 0; i < 10; i++) {
       bson_init (&b);
       bson_oid_init (&oid, context);
@@ -1253,6 +1255,9 @@ test_save (void)
 
    r = mongoc_collection_save (
       collection, tmp_bson ("{'a.b': 1}"), NULL, &error);
+
+   END_IGNORE_DEPRECATIONS;
+
    ASSERT (!r);
    ASSERT_ERROR_CONTAINS (error,
                           MONGOC_ERROR_COMMAND,