MongoDB C++ Driver 4.2.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>
39
41
42namespace mongocxx {
43namespace v_noabi {
44namespace options {
45
50 public:
55
60
64 explicit operator v1::find_one_and_replace_options() const {
67
69
70 if (_bypass_document_validation) {
71 ret.bypass_document_validation(*_bypass_document_validation);
72 }
73
74 if (_collation) {
75 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
76 }
77
78 if (_hint) {
79 ret.hint(to_v1(*_hint));
80 }
81
82 if (_let) {
83 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
84 }
85
86 if (_comment) {
88 }
89
90 if (_max_time) {
91 ret.max_time(*_max_time);
92 }
93
94 if (_projection) {
95 ret.projection(bsoncxx::v1::document::value{to_v1(_projection->view())});
96 }
97
98 if (_return_document) {
99 ret.return_document(*_return_document);
100 }
101
102 if (_ordering) {
103 ret.sort(bsoncxx::v1::document::value{to_v1(_ordering->view())});
104 }
105
106 if (_upsert) {
107 ret.upsert(*_upsert);
108 }
109
110 if (_write_concern) {
111 ret.write_concern(to_v1(*_write_concern));
112 }
113
114 return ret;
115 }
116
130 _collation = std::move(collation);
131 return *this;
132 }
133
146
165 _bypass_document_validation = bypass_document_validation;
166 return *this;
167 }
168
178 return _bypass_document_validation;
179 }
180
195 _hint = std::move(index_hint);
196 return *this;
197 }
198
205 return _hint;
206 }
207
219 _let = std::move(let);
220 return *this;
221 }
222
232
247
257
271 find_one_and_replace& max_time(std::chrono::milliseconds max_time) {
272 _max_time = max_time;
273 return *this;
274 }
275
285 return _max_time;
286 }
287
302 _projection = std::move(projection);
303 return *this;
304 }
305
317
334 _return_document = return_document;
335 return *this;
336 }
337
350
368 _ordering = std::move(ordering);
369 return *this;
370 }
371
383
400 _upsert = upsert;
401 return *this;
402 }
403
413 return _upsert;
414 }
415
430 _write_concern = std::move(write_concern);
431 return *this;
432 }
433
444 return _write_concern;
445 }
446
447 private:
448 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
459};
460
461} // namespace options
462} // namespace v_noabi
463} // namespace mongocxx
464
465namespace mongocxx {
466namespace v_noabi {
467
474
481
482} // namespace v_noabi
483} // namespace mongocxx
484
486
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_replace()=default
Default initialization.
Options for a "findOneAndReplace" operation.
Definition find_one_and_replace_options.hpp:63
find_one_and_replace_options & sort(bsoncxx::v1::document::value ordering)
Set the "sort" field.
find_one_and_replace_options & hint(v1::hint index_hint)
Set the "hint" field.
find_one_and_replace_options & bypass_document_validation(bool bypass_document_validation)
Set the "bypassDocumentValidation" field.
find_one_and_replace_options & projection(bsoncxx::v1::document::value projection)
Set the "projection" field.
find_one_and_replace_options & return_document(v1::return_document return_document)
Set the "returnDocument" field.
find_one_and_replace_options & write_concern(v1::write_concern write_concern)
Set the "writeConcern" field.
find_one_and_replace_options & max_time(std::chrono::milliseconds max_time)
Set the "maxTimeMS" field.
find_one_and_replace_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
find_one_and_replace_options & upsert(bool upsert)
Set the "upsert" field.
find_one_and_replace_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
find_one_and_replace_options & let(bsoncxx::v1::document::value let)
Set the "let" 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:49
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:399
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:347
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
The current setting for bypassing document validation.
Definition find_one_and_replace.hpp:177
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:367
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:333
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:254
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:218
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
Gets the current write concern.
Definition find_one_and_replace.hpp:443
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:243
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:164
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current upsert setting.
Definition find_one_and_replace.hpp:412
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:301
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:271
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:380
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition find_one_and_replace.hpp:204
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:314
operator v1::find_one_and_replace_options() const
Convert to the mongocxx::v1 equivalent.
Definition find_one_and_replace.hpp:64
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:129
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:429
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:143
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:229
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition find_one_and_replace.hpp:284
find_one_and_replace & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition find_one_and_replace.hpp:194
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(...)
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< 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::write_concern.