1MONGOC_BULK_OPERATION_UPDATE_ONE_WMIOTlNHiG_bOOmCPo_TnBSgU(oL3cK)_OPERATION_UPDATE_ONE_WITH_OPTS(3)
2
3
4

NAME

6       mongoc_bulk_operation_update_one_with_opts  - mongoc_bulk_operation_up‐
7       date_one_with_opts()
8

SYNOPSIS

10          bool
11          mongoc_bulk_operation_update_one_with_opts (mongoc_bulk_operation_t *bulk,
12                                                      const bson_t *selector,
13                                                      const bson_t *document,
14                                                      const bson_t *opts,
15                                                      bson_error_t *error); /* OUT */
16
17       This function queues an update as part of a  bulk  operation.  It  will
18       only modify a single document on the MongoDB server. This function does
19       not execute the operation. To execute the entirety of the  bulk  opera‐
20       tion call mongoc_bulk_operation_execute().
21

PARAMETERS

23       • bulk: A mongoc_bulk_operation_t.
24
25       • selector: A bson_t that selects which document to remove.
26
27       • document: A bson_t containing the update document.
28
29       • error: A bson_error_t any errors that may have occurred.
30
31       opts may be NULL or a BSON document with additional command options:
32
33       • validate:     Construct     a     bitwise-or     of    all    desired
34         bson_validate_flags_t. Set to false to skip client-side validation of
35         the provided BSON documents.
36
37       • collation:  Configure  textual comparisons. See Setting Collation Or‐
38         der, and the MongoDB Manual entry on  Collation.  Collation  requires
39         MongoDB 3.2 or later, otherwise an error is returned.
40
41       • hint: A document or string that specifies the index to use to support
42         the query predicate.
43
44       • upsert: If true, insert a document if none match selector.
45
46       • arrayFilters: An array of filters specifying to which array  elements
47         an update should apply.
48
49       WARNING:
50          document  must  only contain fields whose key starts with $. See the
51          update document specification for more details.
52

ERRORS

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

RETURNS

58       Returns  true on success, and false if there is a server or network er‐
59       ror or if passed invalid arguments.
60
61       SEE ALSO:
62          mongoc_bulk_operation_update_many_with_opts()
63
64

AUTHOR

66       MongoDB, Inc
67

69       2017-present, MongoDB, Inc
70
71
72
73
741.20.0                           NMoOvNG1O8C,_B2U0L2K1_OPERATION_UPDATE_ONE_WITH_OPTS(3)
Impressum