mongoc_collection_replace_one - Man Page

mongoc_collection_replace_one()

Synopsis

bool
mongoc_collection_replace_one (mongoc_collection_t *collection,
                               const bson_t *selector,
                               const bson_t *replacement,
                               const bson_t *opts,
                               bson_t *reply,
                               bson_error_t *error);

Parameters

opts may be NULL or a BSON document with additional command options:

Description

This function shall replace documents in collection that match selector with replacement.

If provided, reply will be initialized and populated with the fields matchedCount, modifiedCount, upsertedCount, and optionally upsertedId if applicable. If there is a server error then reply contains either a writeErrors array with one subdocument or a writeConcernErrors array. The reply must be freed with bson_destroy().

See Also

MongoDB update command documentation for more information on the update options.

mongoc_collection_update_one mongoc_collection_update_many

Errors

Errors are propagated via the error parameter.

Returns

Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.

A write concern timeout or write concern error is considered a failure.

Author

MongoDB, Inc

Referenced By

mongoc_collection_update_one(3).

Apr 09, 2021 1.17.5 libmongoc