mongoc_collection_update_many()¶
Synopsis¶
bool
mongoc_collection_update_many (mongoc_collection_t *collection,
const bson_t *selector,
const bson_t *update,
const bson_t *opts,
bson_t *reply,
bson_error_t *error);
Parameters¶
collection: A mongoc_collection_t.selector: Abson_tcontaining the query to match documents for updating.update: Abson_tcontaining the update to perform.opts: Abson_tcontaining additional options orNULL.reply: Optional. An uninitializedbson_tpopulated with the update result, orNULL.error: An optional location for a bson_error_t orNULL.
opts may be NULL or a BSON document with additional command options:
readConcern: Construct a mongoc_read_concern_t and use mongoc_read_concern_append() to add the read concern toopts. See the example code for mongoc_client_read_command_with_opts().writeConcern: Construct a mongoc_write_concern_t and use mongoc_write_concern_append() to add the write concern toopts. See the example code for mongoc_client_write_command_with_opts().sessionId: Construct a mongoc_client_session_t with mongoc_client_start_session() and use mongoc_client_session_append() to add the session toopts. See the example code for mongoc_client_session_t.validate: Set tofalseto skip client-side validation of the provided BSON documents.bypassDocumentValidation: Set totrueto skip server-side schema validation of the provided BSON documents.collation: Configure textual comparisons. See Setting Collation Order, and the MongoDB Manual entry on Collation.serverId: To target a specific server, include an int32 “serverId” field. Obtain the id by calling mongoc_client_select_server(), then mongoc_server_description_id() on its return value.arrayFiltersAn array of filters specifying to which array elements an update should apply.upsertAboolean, when true, creates a new document if no document matches the query.
Description¶
This function updates all documents in collection that match selector.
To update at most one document see mongoc_collection_update_one().
If you pass a non-NULL reply, it is filled out with fields “modifiedCount” and “matchedCount”. If a document was upserted, reply contains an “upsertedId” field. 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.
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.
If provided, reply will be initialized and populated with the fields matchedCount, modifiedCount, and optionally upsertedId if applicable.