MongoDB C++ Driver 4.4.0
Loading...
Searching...
No Matches
find_one_and_replace.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_replace-fwd.hpp> // IWYU pragma: export
18
19//
20
23
24#include <mongocxx/v1/find_one_and_replace_options.hpp> // IWYU pragma: export
25
26#include <chrono>
27#include <cstdint> // IWYU pragma: keep: backward compatibility, to be removed.
28#include <utility>
29
35
36#include <mongocxx/hint.hpp>
40
42
43namespace mongocxx {
44namespace v_noabi {
45namespace options {
46
51 public:
56
62
66 explicit operator v1::find_one_and_replace_options() const {
69
71
72 if (_bypass_document_validation) {
73 ret.bypass_document_validation(*_bypass_document_validation);
74 }
75
76 if (_collation) {
77 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
78 }
79
80 if (_hint) {
81 ret.hint(to_v1(*_hint));
82 }
83
84 if (_let) {
85 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
86 }
87
88 if (_comment) {
90 }
91
92 if (_max_time) {
93 ret.max_time(*_max_time);
94 }
95
96 if (_projection) {
97 ret.projection(bsoncxx::v1::document::value{to_v1(_projection->view())});
98 }
99
100 if (_return_document) {
101 ret.return_document(*_return_document);
102 }
103
104 if (_ordering) {
105 ret.sort(bsoncxx::v1::document::value{to_v1(_ordering->view())});
106 }
107
108 if (_upsert) {
109 ret.upsert(*_upsert);
110 }
111
112 if (_read_concern) {
113 ret.read_concern(to_v1(*_read_concern));
114 }
115
116 if (_write_concern) {
117 ret.write_concern(to_v1(*_write_concern));
118 }
119
120 return ret;
121 }
122
136 _collation = std::move(collation);
137 return *this;
138 }
139
152
171 _bypass_document_validation = bypass_document_validation;
172 return *this;
173 }
174
184 return _bypass_document_validation;
185 }
186
201 _hint = std::move(index_hint);
202 return *this;
203 }
204
211 return _hint;
212 }
213
225 _let = std::move(let);
226 return *this;
227 }
228
238
253
263
277 find_one_and_replace& max_time(std::chrono::milliseconds max_time) {
278 _max_time = max_time;
279 return *this;
280 }
281
291 return _max_time;
292 }
293
308 _projection = std::move(projection);
309 return *this;
310 }
311
323
340 _return_document = return_document;
341 return *this;
342 }
343
356
374 _ordering = std::move(ordering);
375 return *this;
376 }
377
389
406 _upsert = upsert;
407 return *this;
408 }
409
419 return _upsert;
420 }
421
436 _read_concern = std::move(read_concern);
437 return *this;
438 }
439
450 return _read_concern;
451 }
452
467 _write_concern = std::move(write_concern);
468 return *this;
469 }
470
481 return _write_concern;
482 }
483
484 private:
485 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
497};
498
499} // namespace options
500} // namespace v_noabi
501} // namespace mongocxx
502
503namespace mongocxx {
504namespace v_noabi {
505
512
519
520} // namespace v_noabi
521} // namespace mongocxx
522
524
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_replace()=default
Default initialization.
Options for a "findOneAndReplace" operation.
Definition find_one_and_replace_options.hpp:63
find_one_and_replace_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
find_one_and_replace_options & hint(v1::hint v)
Set the "hint" field.
find_one_and_replace_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
find_one_and_replace_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
find_one_and_replace_options & return_document(v1::return_document v)
Set the "returnDocument" field.
find_one_and_replace_options & upsert(bool v)
Set the "upsert" field.
find_one_and_replace_options & bypass_document_validation(bool v)
Set the "bypassDocumentValidation" field.
find_one_and_replace_options & max_time(std::chrono::milliseconds v)
Set the "maxTimeMS" field.
find_one_and_replace_options & projection(bsoncxx::v1::document::value v)
Set the "projection" field.
find_one_and_replace_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
find_one_and_replace_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
find_one_and_replace_options & sort(bsoncxx::v1::document::value v)
Set the "sort" 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_replace.hpp:50
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
Gets the current read concern.
Definition find_one_and_replace.hpp:449
find_one_and_replace & 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_replace.hpp:405
bsoncxx::v_noabi::stdx::optional< v_noabi::options::return_document > const & return_document() const
Which version of the replaced document to return.
Definition find_one_and_replace.hpp:353
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
The current setting for bypassing document validation.
Definition find_one_and_replace.hpp:183
find_one_and_replace & 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_replace.hpp:373
find_one_and_replace & return_document(return_document return_document)
Set the desired version of the replaced document to return, either the original document,...
Definition find_one_and_replace.hpp:339
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_replace.hpp:260
find_one_and_replace & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition find_one_and_replace.hpp:224
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
Gets the current write concern.
Definition find_one_and_replace.hpp:480
find_one_and_replace & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition find_one_and_replace.hpp:249
find_one_and_replace & read_concern(v_noabi::read_concern read_concern)
Sets the read concern for this operation.
Definition find_one_and_replace.hpp:435
find_one_and_replace & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
Definition find_one_and_replace.hpp:170
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current upsert setting.
Definition find_one_and_replace.hpp:418
find_one_and_replace & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection, which limits the fields to return.
Definition find_one_and_replace.hpp:307
find_one_and_replace & 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_replace.hpp:277
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Gets the current sort ordering.
Definition find_one_and_replace.hpp:386
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition find_one_and_replace.hpp:210
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_replace.hpp:320
operator v1::find_one_and_replace_options() const
Convert to the mongocxx::v1 equivalent.
Definition find_one_and_replace.hpp:66
find_one_and_replace()=default
Default initialization.
find_one_and_replace & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition find_one_and_replace.hpp:135
find_one_and_replace & write_concern(v_noabi::write_concern write_concern)
Sets the write concern for this operation.
Definition find_one_and_replace.hpp:466
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_replace.hpp:149
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_replace.hpp:235
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition find_one_and_replace.hpp:290
find_one_and_replace & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition find_one_and_replace.hpp:200
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_replace.
Provides mongocxx::v1::find_one_and_replace_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< 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::document::value.
Provides bsoncxx::v1::types::value.
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.