1MONGOC_COLLECTION_UPDATE_ONE(3) libmongoc MONGOC_COLLECTION_UPDATE_ONE(3)
2
6 bool
7 mongoc_collection_update_one (mongoc_collection_t *collection,
8 const bson_t *selector,
9 const bson_t *update,
10 const bson_t *opts,
11 bson_t *reply,
12 bson_error_t *error);
13
15 • collection: A mongoc_collection_t.
16 • selector: A bson_t containing the query to match the document for up‐
18 dating.
19 • update: A bson_t containing the update to perform. If updating with a
21 pipeline, a bson_t array.
22 • reply: Optional. An uninitialized bson_t populated with the update
24 result, or NULL.
25 • error: An optional location for a bson_error_t or NULL.
27 opts may be NULL or a BSON document with additional command options:
29 • writeConcern: Construct a mongoc_write_concern_t and use
31 mongoc_write_concern_append() to add the write concern to opts. See
32 the example code for mongoc_client_write_command_with_opts().
33 • sessionId: First, construct a mongoc_client_session_t with
35 mongoc_client_start_session(). You can begin a transaction with
36 mongoc_client_session_start_transaction(), optionally with a
37 mongoc_transaction_opt_t that overrides the options inherited from
38 collection, and use mongoc_client_session_append() to add the session
39 to opts. See the example code for mongoc_client_session_t.
40 • validate: Construct a bitwise-or of all desired
42 bson_validate_flags_t. Set to false to skip client-side validation of
43 the provided BSON documents.
44 • comment: A bson_value_t specifying the comment to attach to this com‐
46 mand. The comment will appear in log messages, profiler output, and
47 currentOp output. Requires MongoDB 4.4 or later.
48 • bypassDocumentValidation: Set to true to skip server-side schema val‐
50 idation of the provided BSON documents.
51 • collation: Configure textual comparisons. See Setting Collation Or‐
53 der, and the MongoDB Manual entry on Collation. Collation requires
54 MongoDB 3.2 or later, otherwise an error is returned.
55 • hint: A document or string that specifies the index to use to support
57 the query predicate.
58 • upsert: When true, creates a new document if no document matches the
60 query.
61 • let: A BSON document consisting of any number of parameter names,
63 each followed by definitions of constants in the MQL Aggregate Ex‐
64 pression language.
65 • arrayFilters: An array of filters specifying to which array elements
67 an update should apply.
68
70 This function updates at most one document in collection that matches
71 selector.
72 To update multiple documents see mongoc_collection_update_many().
74 If you pass a non-NULL reply, it is filled out with fields matched‐
76 Count, modifiedCount, and optionally upsertedId if applicable. If there
77 is a server error then reply contains either a "writeErrors" array with
78 one subdocument or a "writeConcernErrors" array. The reply must be
79 freed with bson_destroy().
80
82 Errors are propagated via the error parameter.
83
85 Returns true if successful. Returns false and sets error if there are
86 invalid arguments or a server or network error.
87 A write concern timeout or write concern error is considered a failure.
89
91 example-update.c
92 #include "mongoc/mongoc.h"
94 int
96 main (void)
97 {
98 bson_t *to_insert = BCON_NEW ("_id", BCON_INT32 (1));
99 bson_t *selector = BCON_NEW ("_id", "{", "$gt", BCON_INT32 (0), "}");
100 bson_t *update = BCON_NEW ("$set", "{", "x", BCON_INT32 (1), "}");
101 const bson_t *next_doc;
102 char *to_str;
103 bson_error_t error = {0};
104 mongoc_cursor_t *cursor;
105 mongoc_client_t *client;
106 mongoc_collection_t *coll;
107 const char *uri_string = "mongodb://localhost:27017/?appname=example-update";
108 mongoc_uri_t *uri = mongoc_uri_new_with_error (uri_string, &error);
109 if (!uri) {
111 fprintf (stderr,
112 "failed to parse URI: %s\n"
113 "error message: %s\n",
114 uri_string,
115 error.message);
116 return EXIT_FAILURE;
117 }
118 client = mongoc_client_new_from_uri (uri);
120 if (!client) {
121 return EXIT_FAILURE;
122 }
123 coll = mongoc_client_get_collection (client, "db", "example_coll");
125 mongoc_client_set_error_api (client, 2);
127 /* insert a document */
128 if (!mongoc_collection_insert_one (coll, to_insert, NULL, NULL, &error)) {
129 fprintf (stderr, "insert failed: %s\n", error.message);
130 return EXIT_FAILURE;
131 }
132 if (!mongoc_collection_update_one (
134 coll, selector, update, NULL, NULL, &error)) {
135 fprintf (stderr, "update failed: %s\n", error.message);
136 return EXIT_FAILURE;
137 }
138 to_str = bson_as_relaxed_extended_json (to_insert, NULL);
140 printf ("inserted: %s\n", to_str);
141 bson_free (to_str);
142 cursor = mongoc_collection_find_with_opts (coll, selector, NULL, NULL);
144 BSON_ASSERT (mongoc_cursor_next (cursor, &next_doc));
145 printf ("after update, collection has the following document:\n");
146 to_str = bson_as_relaxed_extended_json (next_doc, NULL);
148 printf ("%s\n", to_str);
149 bson_free (to_str);
150 BSON_ASSERT (mongoc_collection_drop (coll, NULL));
152 bson_destroy (to_insert);
154 bson_destroy (update);
155 bson_destroy (selector);
156 mongoc_collection_destroy (coll);
157 mongoc_uri_destroy (uri);
158 mongoc_client_destroy (client);
159 return EXIT_SUCCESS;
161 }
162 SEE ALSO:
165 MongoDB update command documentation for more information on the update options.
166 mongoc_collection_update_many()
168 mongoc_collection_replace_one()
170
173 MongoDB, Inc
174
176 2017-present, MongoDB, Inc
1771.25.1 Nov 08, 2023 MONGOC_COLLECTION_UPDATE_ONE(3)