Man page - mongoc_bulk_operation_update_many_with_opts(3)

Packages contains this manual

Package: libmongoc-doc
apt-get install libmongoc-doc

Manuals in package:

Documentations in package:

Manual

MONGOC_BULK_OPERATION_UPDATE_MANY_WITH_OPTS

SYNOPSIS
PARAMETERS
ERRORS
RETURNS
AUTHOR
COPYRIGHT

SYNOPSIS

bool
mongoc_bulk_operation_update_many_with_opts (mongoc_bulk_operation_t *bulk,
const bson_t *selector,
const bson_t *document,
const bson_t *opts,
bson_error_t *error); /* OUT */

This function queues an update as part of a bulk operation. This does not execute the operation. To execute the entirety of the bulk operation call mongoc_bulk_operation_execute() .

WARNING:

document MUST only contain fields whose key starts with $ . See the update document specification for more details.

PARAMETERS

	•		bulk : A mongoc_bulk_operation_t .
	•		selector : A bson_t that selects which documents to remove.
	•		document : A bson_t containing the update document.
	•		error : A bson_error_t any errors that may have occurred.

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

	•		validate : Construct a bitwise-or of all desired - bson_validate_flags_t . Set to false to skip client-side validation of the provided BSON documents.
	•		collation : Configure textual comparisons. See Setting Collation Order , and the MongoDB Manual entry on 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.
	•		upsert : If true, insert a document if none match selector .
	•		arrayFilters : An array of filters specifying to which array elements an update should apply.

ERRORS

Operation errors are propagated via mongoc_bulk_operation_execute() , while argument validation errors are reported by the error argument.

RETURNS

Returns true on success, and false if there is a server or network error or if passed invalid arguments.

SEE ALSO:

mongoc_bulk_operation_update_one_with_opts()

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.