MongoDB C++ Driver 4.2.0
Loading...
Searching...
No Matches
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/replace-fwd.hpp> // IWYU pragma: export
18
19//
20
23
24#include <mongocxx/v1/replace_one_options.hpp> // IWYU pragma: export
25
26#include <utility>
27
28#include <bsoncxx/array/view_or_value.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
34
35#include <mongocxx/hint.hpp>
37
39
40namespace mongocxx {
41namespace v_noabi {
42namespace options {
43
47class replace {
48 public:
52 replace() = default;
53
58
62 explicit operator v1::replace_one_options() const {
65
67
68 if (_bypass_document_validation) {
69 ret.bypass_document_validation(*_bypass_document_validation);
70 }
71
72 if (_collation) {
73 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
74 }
75
76 if (_upsert) {
77 ret.upsert(*_upsert);
78 }
79
80 if (_write_concern) {
81 ret.write_concern(to_v1(*_write_concern));
82 }
83
84 if (_hint) {
85 ret.hint(to_v1(*_hint));
86 }
87
88 if (_let) {
89 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
90 }
91
92 if (_sort) {
93 ret.sort(bsoncxx::v1::document::value{to_v1(_sort->view())});
94 }
95
96 if (_comment) {
97 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
98 }
99
100 return ret;
101 }
102
119 _bypass_document_validation = bypass_document_validation;
120 return *this;
121 }
122
129 return _bypass_document_validation;
130 }
131
146 _collation = std::move(collation);
147 return *this;
148 }
149
162
180 _upsert = upsert;
181 return *this;
182 }
183
190 return _upsert;
191 }
192
207 _write_concern = std::move(wc);
208 return *this;
209 }
210
221 return _write_concern;
222 }
223
238 _hint = std::move(index_hint);
239 return *this;
240 }
241
248 return _hint;
249 }
250
262 _let = std::move(let);
263 return *this;
264 }
265
275
280 _sort = std::move(sort);
281 return *this;
282 }
283
290
302 _comment = std::move(comment);
303 return *this;
304 }
305
315
316 private:
317 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
325};
326
327} // namespace options
328} // namespace v_noabi
329} // namespace mongocxx
330
331namespace mongocxx {
332namespace v_noabi {
333
338 return {std::move(v)};
339}
340
347
348} // namespace v_noabi
349} // namespace mongocxx
350
352
Provides bsoncxx::v_noabi::array::view_or_value.
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
replace()=default
Default initialization.
Options for a "replaceOne" operation.
Definition replace_one_options.hpp:56
replace_one_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
replace_one_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
replace_one_options & hint(v1::hint index_hint)
Set the "hint" field.
replace_one_options & write_concern(v1::write_concern wc)
Set the "writeConcern" field.
replace_one_options & sort(bsoncxx::v1::document::value sort)
Set the "sort" field.
replace_one_options & bypass_document_validation(bool bypass_document_validation)
Set the "bypassDocumentValidation" field.
replace_one_options & upsert(bool upsert)
Set the "upsert" field.
replace_one_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 replace.hpp:47
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
The current write_concern for this operation.
Definition replace.hpp:220
replace & sort(bsoncxx::v_noabi::document::view_or_value sort)
Set the sort option.
Definition replace.hpp:279
replace & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition replace.hpp:145
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition replace.hpp:159
replace & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition replace.hpp:237
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const let() const
Gets the current value of the let option.
Definition replace.hpp:272
replace & write_concern(v_noabi::write_concern wc)
Sets the write_concern for this operation.
Definition replace.hpp:206
replace & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation option. If true, allows the write to opt-out of document level va...
Definition replace.hpp:118
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition replace.hpp:247
replace & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition replace.hpp:301
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 replace.hpp:312
operator v1::replace_one_options() const
Convert to the mongocxx::v1 equivalent.
Definition replace.hpp:62
replace()=default
Default initialization.
replace & upsert(bool upsert)
Sets the upsert option.
Definition replace.hpp:179
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Get the current value of the sort option.
Definition replace.hpp:287
replace & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition replace.hpp:261
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current value of the upsert option.
Definition replace.hpp:189
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
Definition replace.hpp:128
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.
#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.
Declares mongocxx::v_noabi::options::replace.
Provides mongocxx::v1::replace_one_options.
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.