MongoDB C++ Driver 4.4.0
Loading...
Searching...
No Matches
find_one_and_update.hpp
Go to the documentation of this file.
1// Copyright 2009-present MongoDB, Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <mongocxx/options/find_one_and_update-fwd.hpp> // IWYU pragma: export
18
19//
20
24
25#include <mongocxx/v1/find_one_and_update_options.hpp> // IWYU pragma: export
26
27#include <chrono>
28#include <cstdint> // IWYU pragma: keep: backward compatibility, to be removed.
29#include <utility>
30
38
39#include <mongocxx/hint.hpp>
43
45
46namespace mongocxx {
47namespace v_noabi {
48namespace options {
49
54 public:
59
65
69 explicit operator v1::find_one_and_update_options() const {
72
74
75 if (_bypass_document_validation) {
76 ret.bypass_document_validation(*_bypass_document_validation);
77 }
78
79 if (_collation) {
80 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
81 }
82
83 if (_hint) {
84 ret.hint(to_v1(*_hint));
85 }
86
87 if (_let) {
88 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
89 }
90
91 if (_comment) {
92 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
93 }
94
95 if (_max_time) {
96 ret.max_time(*_max_time);
97 }
98
99 if (_projection) {
100 ret.projection(bsoncxx::v1::document::value{to_v1(_projection->view())});
101 }
102
103 if (_return_document) {
104 ret.return_document(*_return_document);
105 }
106
107 if (_ordering) {
108 ret.sort(bsoncxx::v1::document::value{to_v1(_ordering->view())});
109 }
110
111 if (_upsert) {
112 ret.upsert(*_upsert);
113 }
114
115 if (_read_concern) {
116 ret.read_concern(to_v1(*_read_concern));
117 }
118
119 if (_write_concern) {
120 ret.write_concern(to_v1(*_write_concern));
121 }
122
123 if (_array_filters) {
124 ret.array_filters(bsoncxx::v1::array::value{to_v1(_array_filters->view())});
125 }
126
127 return ret;
128 }
129
143 _collation = std::move(collation);
144 return *this;
145 }
146
159
178 _bypass_document_validation = std::move(bypass_document_validation);
179 return *this;
180 }
181
191 return _bypass_document_validation;
192 }
193
209 _hint = std::move(index_hint);
210 return *this;
211 }
212
219 return _hint;
220 }
221
233 _let = std::move(let);
234 return *this;
235 }
236
246
261
271
285 find_one_and_update& max_time(std::chrono::milliseconds max_time) {
286 _max_time = std::move(max_time);
287 return *this;
288 }
289
299 return _max_time;
300 }
301
316 _projection = std::move(projection);
317 return *this;
318 }
319
331
348 _return_document = std::move(return_document);
349 return *this;
350 }
351
364
382 _ordering = std::move(ordering);
383 return *this;
384 }
385
397
414 _upsert = std::move(upsert);
415 return *this;
416 }
417
427 return _upsert;
428 }
429
444 _read_concern = std::move(read_concern);
445 return *this;
446 }
447
458 return _read_concern;
459 }
460
475 _write_concern = std::move(write_concern);
476 return *this;
477 }
478
489 return _write_concern;
490 }
491
506 _array_filters = std::move(array_filters);
507 return *this;
508 }
509
522
523 private:
524 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
537};
538
539} // namespace options
540} // namespace v_noabi
541} // namespace mongocxx
542
543namespace mongocxx {
544namespace v_noabi {
545
552
559
560} // namespace v_noabi
561} // namespace mongocxx
562
564
Provides bsoncxx::v_noabi::array::view_or_value.
A BSON array.
Definition value.hpp:39
A BSON document.
Definition value.hpp:44
A polyfill for std::optional<T>.
Definition optional.hpp:799
A union of BSON type values.
Definition value.hpp:52
find_one_and_update()=default
Default initialization.
Options for a "findOneAndUpdate" operation.
Definition find_one_and_update_options.hpp:66
find_one_and_update_options & return_document(v1::return_document v)
Set the "returnDocument" field.
find_one_and_update_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
find_one_and_update_options & bypass_document_validation(bool v)
Set the "bypassDocumentValidation" field.
find_one_and_update_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
find_one_and_update_options & hint(v1::hint v)
Set the "hint" field.
find_one_and_update_options & projection(bsoncxx::v1::document::value v)
Set the "projection" field.
find_one_and_update_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
find_one_and_update_options & upsert(bool v)
Set the "upsert" field.
find_one_and_update_options & sort(bsoncxx::v1::document::value v)
Set the "sort" field.
find_one_and_update_options & max_time(std::chrono::milliseconds v)
Set the "maxTimeMS" field.
find_one_and_update_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
find_one_and_update_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
find_one_and_update_options & array_filters(bsoncxx::v1::array::value v)
Set the "arrayFilters" field.
The index to "hint" or force a MongoDB server to use when performing a query.
Definition hint.hpp:42
Used by mongocxx::v_noabi::collection.
Definition find_one_and_update.hpp:53
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
The current setting for bypassing document validation.
Definition find_one_and_update.hpp:190
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > const comment() const
Gets the current value of the comment option.
Definition find_one_and_update.hpp:268
find_one_and_update & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection, which limits the fields to return.
Definition find_one_and_update.hpp:315
operator v1::find_one_and_update_options() const
Convert to the mongocxx::v1 equivalent.
Definition find_one_and_update.hpp:69
find_one_and_update & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition find_one_and_update.hpp:208
find_one_and_update()=default
Default initialization.
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const let() const
Gets the current value of the let option.
Definition find_one_and_update.hpp:243
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Gets the current sort ordering.
Definition find_one_and_update.hpp:394
find_one_and_update & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
Definition find_one_and_update.hpp:177
find_one_and_update & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition find_one_and_update.hpp:232
find_one_and_update & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
Definition find_one_and_update.hpp:285
find_one_and_update & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition find_one_and_update.hpp:142
find_one_and_update & read_concern(v_noabi::read_concern read_concern)
Sets the read concern for this operation.
Definition find_one_and_update.hpp:443
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current upsert setting.
Definition find_one_and_update.hpp:426
find_one_and_update & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition find_one_and_update.hpp:257
find_one_and_update & array_filters(bsoncxx::v_noabi::array::view_or_value array_filters)
Set array filters for this operation.
Definition find_one_and_update.hpp:505
find_one_and_update & sort(bsoncxx::v_noabi::document::view_or_value ordering)
Sets the order by which to search the collection for a matching document.
Definition find_one_and_update.hpp:381
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
Gets the current read concern.
Definition find_one_and_update.hpp:457
find_one_and_update & write_concern(v_noabi::write_concern write_concern)
Sets the write concern for this operation.
Definition find_one_and_update.hpp:474
find_one_and_update & upsert(bool upsert)
Sets the upsert flag on the operation. When true, the operation creates a new document if no document...
Definition find_one_and_update.hpp:413
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition find_one_and_update.hpp:298
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition find_one_and_update.hpp:156
bsoncxx::v_noabi::stdx::optional< v_noabi::options::return_document > const & return_document() const
Which version of the updated document to return.
Definition find_one_and_update.hpp:361
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition find_one_and_update.hpp:218
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & projection() const
Gets the current projection for this operation.
Definition find_one_and_update.hpp:328
find_one_and_update & return_document(return_document return_document)
Set the desired version of the updated document to return, either the original document,...
Definition find_one_and_update.hpp:347
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::array::view_or_value > const & array_filters() const
Get array filters for this operation.
Definition find_one_and_update.hpp:519
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
Gets the current write concern.
Definition find_one_and_update.hpp:488
Controls the consistency and isolation properties of data read from replica sets and sharded clusters...
Definition read_concern.hpp:54
The level of acknowledgment requested for write operations to a MongoDB server.
Definition write_concern.hpp:54
Provides bsoncxx::v_noabi::document::view_or_value.
Declares mongocxx::v_noabi::options::find_one_and_update.
Provides mongocxx::v1::find_one_and_update_options.
Provides mongocxx::v_noabi::options::return_document.
#define MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(...)
Equivalent to MONGOCXX_ABI_EXPORT_UNSTABLE with MONGOCXX_ABI_CDECL.
Definition config.hpp:28
The mongocxx v_noabi macro guard postlude header.
The mongocxx v_noabi macro guard prelude header.
v_noabi::view_or_value< view, value > view_or_value
Equivalent to v_noabi::view_or_value<v_noabi::array::view, v_noabi::array::value>.
Definition view_or_value.hpp:31
v_noabi::view_or_value< v_noabi::document::view, v_noabi::document::value > view_or_value
Equivalent to v_noabi::view_or_value<v_noabi::document::view, v_noabi::document::value>.
Definition view_or_value.hpp:30
v_noabi::view_or_value< view, value > view_or_value
Equivalent to v_noabi::view_or_value<view, value>.
Definition view_or_value.hpp:31
v1::element::view to_v1(v_noabi::array::element const &v)
Convert to the bsoncxx::v1 equivalent of v.
Definition element.hpp:132
Declares entities whose ABI stability is guaranteed for documented symbols.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
v1::bulk_write to_v1(v_noabi::bulk_write v)
Convert to the mongocxx::v1 equivalent of v.
Definition bulk_write.hpp:162
v_noabi::bulk_write from_v1(v1::bulk_write v)
Convert to the mongocxx::v_noabi equivalent of v.
Definition bulk_write.hpp:155
The top-level namespace within which all mongocxx library entities are declared.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides bsoncxx::v1::array::value.
Provides bsoncxx::v1::document::value.
Provides bsoncxx::v1::types::value.
Provides bsoncxx::v_noabi::array::view.
Provides bsoncxx::v_noabi::document::view.
Provides std::optional-related polyfills for library API usage.
Provides bsoncxx::v_noabi::types::bson_value::view.
Provides mongocxx::v_noabi::hint.
Provides mongocxx::v_noabi::read_concern.
Provides mongocxx::v_noabi::write_concern.