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
34         mongoc_write_concern_append()  to  add the write concern to opts. See
35         the example code for mongoc_client_write_command_with_opts().
36
37       • sessionId:   First,   construct   a   mongoc_client_session_t    with
38         mongoc_client_start_session().  You  can  begin  a  transaction  with
39         mongoc_client_session_start_transaction(),    optionally    with    a
40         mongoc_transaction_opt_t  that  overrides  the options inherited from
41         collection, and use mongoc_client_session_append() to add the session
42         to opts. See 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       • comment: A bson_value_t specifying the comment to attach to this com‐
49         mand. The comment will appear in log messages, profiler  output,  and
50         currentOp output. Requires MongoDB 4.4 or later.
51
52       • bypassDocumentValidation: Set to true to skip server-side schema val‐
53         idation of the provided BSON documents.
54
55       • collation: Configure textual comparisons. See Setting  Collation  Or‐
56         der,  and  the  MongoDB Manual entry on Collation. Collation requires
57         MongoDB 3.2 or later, otherwise an error is returned.
58
59       • hint: A document or string that specifies the index to use to support
60         the query predicate.
61
62       • upsert:  When true, creates a new document if no document matches the
63         query.
64
65       • let: A BSON document consisting of any  number  of  parameter  names,
66         each  followed  by  definitions of constants in the MQL Aggregate Ex‐
67         pression language.
68
69       • arrayFilters: An array of filters specifying to which array  elements
70         an update should apply.
71

DESCRIPTION

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

ERRORS

84       Errors are propagated via the error parameter.
85

RETURNS

87       Returns  true  if successful. Returns false and sets error if there are
88       invalid arguments or a server or network error.
89
90       A write concern timeout or write concern error is considered a failure.
91
92       SEE ALSO:
93          MongoDB update command documentation for more information on the update options.
94
95          mongoc_collection_update_one()
96
97

AUTHOR

99       MongoDB, Inc
100

102       2017-present, MongoDB, Inc
103
104
105
106
1071.23.1                           Oct 20, 2022 MONGOC_COLLECTION_UPDATE_MANY(3)
Impressum