1MONGOC_COLLECTION_UPDATE_MANY(3)   libmongoc  MONGOC_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. If updating with a
24         pipeline, a bson_t array.
25
26       • reply:  Optional.  An  uninitialized bson_t populated with the update
27         result, or NULL.
28
29       • error: An optional location for a bson_error_t or NULL.
30
31       opts may be NULL or a BSON document with additional command options:
32
33       • writeConcern:  Construct  a  mongoc_write_concern_t  and   use   mon‐
34         goc_write_concern_append  to  add  the write concern to opts. See the
35         example code for mongoc_client_write_command_with_opts.
36
37       • sessionId:  First,  construct  a  mongoc_client_session_t  with  mon‐
38         goc_client_start_session.  You  can  begin  a  transaction  with mon‐
39         goc_client_session_start_transaction, optionally with a mongoc_trans‐
40         action_opt_t  that  overrides  the options inherited from collection,
41         and use mongoc_client_session_append to add the session to opts.  See
42         the example code for mongoc_client_session_t.
43
44       • validate:     Construct     a     bitwise-or     of    all    desired
45         bson_validate_flags_t. Set to false to skip client-side validation of
46         the provided BSON documents.
47
48       • bypassDocumentValidation: Set to true to skip server-side schema val‐
49         idation of the provided BSON documents.
50
51       • collation: Configure textual comparisons. See Setting  Collation  Or‐
52         der,  and  the  MongoDB Manual entry on Collation. Collation requires
53         MongoDB 3.2 or later, otherwise an error is returned.
54
55       • hint: A document or string that specifies the index to use to support
56         the query predicate.
57
58       • upsert:  When true, creates a new document if no document matches the
59         query.
60
61       • arrayFilters: An array of filters specifying to which array  elements
62         an update should apply.
63

DESCRIPTION

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

ERRORS

76       Errors are propagated via the error parameter.
77

RETURNS

79       Returns  true  if successful. Returns false and sets error if there are
80       invalid arguments or a server or network error.
81
82       A write concern timeout or write concern error is considered a failure.
83
84       SEE ALSO:
85          MongoDB update command documentation for more information on the update options.
86
87          mongoc_collection_update_one
88
89

AUTHOR

91       MongoDB, Inc
92

94       2017-present, MongoDB, Inc
95
96
97
98
991.20.0                           Nov 18, 2021 MONGOC_COLLECTION_UPDATE_MANY(3)
Impressum