MongoDB C++ Driver 4.2.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>
42
44
45namespace mongocxx {
46namespace v_noabi {
47namespace options {
48
53 public:
58
63
67 explicit operator v1::find_one_and_update_options() const {
70
72
73 if (_bypass_document_validation) {
74 ret.bypass_document_validation(*_bypass_document_validation);
75 }
76
77 if (_collation) {
78 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
79 }
80
81 if (_hint) {
82 ret.hint(to_v1(*_hint));
83 }
84
85 if (_let) {
86 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
87 }
88
89 if (_comment) {
90 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
91 }
92
93 if (_max_time) {
94 ret.max_time(*_max_time);
95 }
96
97 if (_projection) {
98 ret.projection(bsoncxx::v1::document::value{to_v1(_projection->view())});
99 }
100
101 if (_return_document) {
102 ret.return_document(*_return_document);
103 }
104
105 if (_ordering) {
106 ret.sort(bsoncxx::v1::document::value{to_v1(_ordering->view())});
107 }
108
109 if (_upsert) {
110 ret.upsert(*_upsert);
111 }
112
113 if (_write_concern) {
114 ret.write_concern(to_v1(*_write_concern));
115 }
116
117 if (_array_filters) {
118 ret.array_filters(bsoncxx::v1::array::value{to_v1(_array_filters->view())});
119 }
120
121 return ret;
122 }
123
137 _collation = std::move(collation);
138 return *this;
139 }
140
153
172 _bypass_document_validation = std::move(bypass_document_validation);
173 return *this;
174 }
175
185 return _bypass_document_validation;
186 }
187
203 _hint = std::move(index_hint);
204 return *this;
205 }
206
213 return _hint;
214 }
215
227 _let = std::move(let);
228 return *this;
229 }
230
240
255
265
279 find_one_and_update& max_time(std::chrono::milliseconds max_time) {
280 _max_time = std::move(max_time);
281 return *this;
282 }
283
293 return _max_time;
294 }
295
310 _projection = std::move(projection);
311 return *this;
312 }
313
325
342 _return_document = std::move(return_document);
343 return *this;
344 }
345
358
376 _ordering = std::move(ordering);
377 return *this;
378 }
379
391
408 _upsert = std::move(upsert);
409 return *this;
410 }
411
421 return _upsert;
422 }
423
438 _write_concern = std::move(write_concern);
439 return *this;
440 }
441
452 return _write_concern;
453 }
454
469 _array_filters = std::move(array_filters);
470 return *this;
471 }
472
485
486 private:
487 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
499};
500
501} // namespace options
502} // namespace v_noabi
503} // namespace mongocxx
504
505namespace mongocxx {
506namespace v_noabi {
507
514
521
522} // namespace v_noabi
523} // namespace mongocxx
524
526
Provides bsoncxx::v_noabi::array::view_or_value.
A BSON array.
Definition value.hpp:41
A BSON document.
Definition value.hpp:46
A polyfill for std::optional<T>.
Definition optional.hpp:799
A union of BSON type values.
Definition value.hpp:54
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 & sort(bsoncxx::v1::document::value ordering)
Set the "sort" field.
find_one_and_update_options & array_filters(bsoncxx::v1::array::value array_filters)
Set the "arrayFilters" field.
find_one_and_update_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
find_one_and_update_options & hint(v1::hint index_hint)
Set the "hint" field.
find_one_and_update_options & projection(bsoncxx::v1::document::value projection)
Set the "projection" field.
find_one_and_update_options & write_concern(v1::write_concern write_concern)
Set the "writeConcern" field.
find_one_and_update_options & bypass_document_validation(bool bypass_document_validation)
Set the "bypassDocumentValidation" field.
find_one_and_update_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
find_one_and_update_options & max_time(std::chrono::milliseconds max_time)
Set the "maxTimeMS" field.
find_one_and_update_options & let(bsoncxx::v1::document::value let)
Set the "let" field.
find_one_and_update_options & return_document(v1::return_document return_document)
Set the "returnDocument" field.
find_one_and_update_options & upsert(bool upsert)
Set the "upsert" 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:52
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
The current setting for bypassing document validation.
Definition find_one_and_update.hpp:184
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:262
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:309
operator v1::find_one_and_update_options() const
Convert to the mongocxx::v1 equivalent.
Definition find_one_and_update.hpp:67
find_one_and_update & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition find_one_and_update.hpp:202
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:237
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:388
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:171
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:226
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:279
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:136
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current upsert setting.
Definition find_one_and_update.hpp:420
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:251
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:468
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:375
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:437
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:407
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition find_one_and_update.hpp:292
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:150
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:355
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition find_one_and_update.hpp:212
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:322
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:341
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:482
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
Gets the current write concern.
Definition find_one_and_update.hpp:451
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(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
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::write_concern.