1MONGOC_COLLECTION_UPDATE_MANY(3)MongoDB C DriverMONGOC_COLLECTION_UPDATE_MANY(3)
2
3
4

NAME

6       mongoc_collection_update_many - mongoc_collection_update_many()
7

SYNOPSIS

9          bool
10          mongoc_collection_update_many (mongoc_collection_t *collection,
11                                         const bson_t *selector,
12                                         const bson_t *update,
13                                         const bson_t *opts,
14                                         bson_t *reply,
15                                         bson_error_t *error);
16

PARAMETERS

18       · collection: A mongoc_collection_t.
19
20       · selector: A bson_t containing the query to match documents for updat‐
21         ing.
22
23       · update: A bson_t containing the update to perform.
24
25       · reply: Optional. An uninitialized bson_t populated  with  the  update
26         result, or NULL.
27
28       · error: An optional location for a bson_error_t or NULL.
29
30       opts may be NULL or a BSON document with additional command options:
31
32       · writeConcern:   Construct   a  mongoc_write_concern_t  and  use  mon‐
33         goc_write_concern_append to add the write concern to  opts.  See  the
34         example code for mongoc_client_write_command_with_opts.
35
36       · sessionId:  First,  construct  a  mongoc_client_session_t  with  mon‐
37         goc_client_start_session. You  can  begin  a  transaction  with  mon‐
38         goc_client_session_start_transaction, optionally with a mongoc_trans‐
39         action_opt_t that overrides the options  inherited  from  collection,
40         and  use mongoc_client_session_append to add the session to opts. See
41         the example code for mongoc_client_session_t.
42
43       · validate:    Construct    a     bitwise-or     of     all     desired
44         bson_validate_flags_t. Set to false to skip client-side validation of
45         the provided BSON documents.
46
47       · bypassDocumentValidation: Set to true to skip server-side schema val‐
48         idation of the provided BSON documents.
49
50       · collation:  Configure  textual  comparisons.  See  Setting  Collation
51         Order, and the MongoDB Manual entry on Collation. Collation  requires
52         MongoDB 3.2 or later, otherwise an error is returned.
53
54       · upsert:  When true, creates a new document if no document matches the
55         query.
56
57       · arrayFilters: An array of filters specifying to which array  elements
58         an update should apply.
59

DESCRIPTION

61       This function updates all documents in collection that match selector.
62
63       To update at most one document see mongoc_collection_update_one.
64
65       If  you  pass  a non-NULL reply, it is filled out with fields  matched‐
66       Count, modifiedCount, and optionally upsertedId if applicable. If there
67       is a server error then reply contains either a "writeErrors" array with
68       one subdocument or a "writeConcernErrors"  array.  The  reply  must  be
69       freed with bson_destroy().
70

SEE ALSO

72       MongoDB update command documentation for more information on the update
73       options.
74
75       mongoc_collection_update_one
76

ERRORS

78       Errors are propagated via the error parameter.
79

RETURNS

81       Returns true if successful. Returns false and sets error if  there  are
82       invalid arguments or a server or network error.
83
84       A write concern timeout or write concern error is considered a failure.
85

AUTHOR

87       MongoDB, Inc
88

90       2017-present, MongoDB, Inc
91
92
93
94
951.13.1                           Jan 24, 2019 MONGOC_COLLECTION_UPDATE_MANY(3)
Impressum