MongoDB C++ Driver 4.3.0
Loading...
Searching...
No Matches
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/update-fwd.hpp> // IWYU pragma: export
18
19//
20
24
25#include <mongocxx/v1/update_many_options.hpp> // IWYU pragma: export
26#include <mongocxx/v1/update_one_options.hpp> // IWYU pragma: export
27
28#include <utility>
29
37
38#include <mongocxx/hint.hpp>
41
43
44namespace mongocxx {
45namespace v_noabi {
46namespace options {
47
51class update {
52 public:
56 update() = default;
57
62
66 /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() update(v1::update_one_options opts);
67
73 explicit operator v1::update_many_options() const {
76
78
79 if (_bypass_document_validation) {
80 ret.bypass_document_validation(*_bypass_document_validation);
81 }
82
83 if (_collation) {
84 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
85 }
86
87 if (_upsert) {
88 ret.upsert(*_upsert);
89 }
90
91 if (_read_concern) {
92 ret.read_concern(to_v1(*_read_concern));
93 }
94
95 if (_write_concern) {
96 ret.write_concern(to_v1(*_write_concern));
97 }
98
99 if (_array_filters) {
100 ret.array_filters(bsoncxx::v1::array::value{to_v1(*_array_filters)});
101 }
102
103 if (_hint) {
104 ret.hint(to_v1(*_hint));
105 }
106
107 if (_let) {
108 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
109 }
110
111 if (_comment) {
112 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
113 }
114
115 return ret;
116 }
117
121 explicit operator v1::update_one_options() const {
124
126
127 if (_bypass_document_validation) {
128 ret.bypass_document_validation(*_bypass_document_validation);
129 }
130
131 if (_collation) {
132 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
133 }
134
135 if (_upsert) {
136 ret.upsert(*_upsert);
137 }
138
139 if (_read_concern) {
140 ret.read_concern(to_v1(*_read_concern));
141 }
142
143 if (_write_concern) {
144 ret.write_concern(to_v1(*_write_concern));
145 }
146
147 if (_array_filters) {
148 ret.array_filters(bsoncxx::v1::array::value{to_v1(*_array_filters)});
149 }
150
151 if (_hint) {
152 ret.hint(to_v1(*_hint));
153 }
154
155 if (_let) {
156 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
157 }
158
159 if (_sort) {
160 ret.sort(bsoncxx::v1::document::value{to_v1(_sort->view())});
161 }
162
163 if (_comment) {
164 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
165 }
166
167 return ret;
168 }
169
186 _bypass_document_validation = bypass_document_validation;
187 return *this;
188 }
189
196 return _bypass_document_validation;
197 }
198
213 _collation = std::move(collation);
214 return *this;
215 }
216
229
243 update& hint(v_noabi::hint index_hint) {
244 _hint = std::move(index_hint);
245 return *this;
246 }
247
254 return _hint;
255 }
256
268 _let = std::move(let);
269 return *this;
270 }
271
281
286 _sort = std::move(sort);
287 return *this;
288 }
289
296
308 _comment = std::move(comment);
309 return *this;
310 }
311
321
339 _upsert = upsert;
340 return *this;
341 }
342
349 return _upsert;
350 }
351
366 _read_concern = std::move(rc);
367 return *this;
368 }
369
380 return _read_concern;
381 }
382
397 _write_concern = std::move(wc);
398 return *this;
399 }
400
411 return _write_concern;
412 }
413
428 _array_filters = std::move(array_filters);
429 return *this;
430 }
431
444
445 private:
446 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
456};
457
458} // namespace options
459} // namespace v_noabi
460} // namespace mongocxx
461
462namespace mongocxx {
463namespace v_noabi {
464
469 return {std::move(v)};
470}
471
476 return {std::move(v)};
477}
478
479// Ambiguous whether `v_noabi::options::update` should be converted to `v1::update_many_options` or
480// `v1::update_one_options`. Require users to explicitly cast to the expected type instead.
481//
482// v1::update_many_options to_v1(v_noabi::options::update const& v);
483// v1::update_one_options to_v1(v_noabi::options::update const& v);
484
485} // namespace v_noabi
486} // namespace mongocxx
487
489
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
update()=default
Default initialization.
Options for an "updateMany" operation.
Definition update_many_options.hpp:60
update_many_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
update_many_options & upsert(bool upsert)
Set the "upsert" field.
update_many_options & bypass_document_validation(bool bypass_document_validation)
Set the "bypassDocumentValidation" field.
update_many_options & read_concern(v1::read_concern rc)
Set the "readConcern" field.
update_many_options & let(bsoncxx::v1::document::value let)
Set the "let" field.
update_many_options & write_concern(v1::write_concern wc)
Set the "writeConcern" field.
update_many_options & hint(v1::hint index_hint)
Set the "hint" field.
update_many_options & array_filters(bsoncxx::v1::array::value array_filters)
Set the "arrayFilters" field.
update_many_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
Options for an "updateOne" operation.
Definition update_one_options.hpp:61
update_one_options & upsert(bool upsert)
Set the "upsert" field.
update_one_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
update_one_options & write_concern(v1::write_concern wc)
Set the "writeConcern" field.
update_one_options & let(bsoncxx::v1::document::value let)
Set the "let" field.
update_one_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
update_one_options & bypass_document_validation(bool bypass_document_validation)
Set the "bypassDocumentValidation" field.
update_one_options & array_filters(bsoncxx::v1::array::value array_filters)
Set the "arrayFilters" field.
update_one_options & hint(v1::hint index_hint)
Set the "hint" field.
update_one_options & sort(bsoncxx::v1::document::value sort)
Set the "sort" field.
update_one_options & read_concern(v1::read_concern rc)
Set the "readConcern" 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 update.hpp:51
update & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition update.hpp:307
update & array_filters(bsoncxx::v_noabi::array::view_or_value array_filters)
Set array filters for this operation.
Definition update.hpp:427
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
The current write_concern for this operation.
Definition update.hpp:410
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition update.hpp:253
update & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition update.hpp:212
update & upsert(bool upsert)
Sets the upsert option.
Definition update.hpp:338
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current value of the upsert option.
Definition update.hpp:348
update & 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 update.hpp:185
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const let() const
Gets the current value of the let option.
Definition update.hpp:278
operator v1::update_many_options() const
Convert to the mongocxx::v1 equivalent.
Definition update.hpp:73
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
Definition update.hpp:195
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition update.hpp:226
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
The current read_concern for this operation.
Definition update.hpp:379
update()=default
Default initialization.
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Get the current value of the sort option.
Definition update.hpp:293
update & read_concern(v_noabi::read_concern rc)
Sets the read_concern for this operation.
Definition update.hpp:365
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::array::view_or_value > const & array_filters() const
Get array filters for this operation.
Definition update.hpp:441
update & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition update.hpp:267
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 update.hpp:318
update & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition update.hpp:243
operator v1::update_one_options() const
Convert to the mongocxx::v1 equivalent.
Definition update.hpp:121
update & sort(bsoncxx::v_noabi::document::view_or_value sort)
Set the sort option.
Definition update.hpp:285
update & write_concern(v_noabi::write_concern wc)
Sets the write_concern for this operation.
Definition update.hpp:396
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.
#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.
Declares mongocxx::v_noabi::options::update.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides mongocxx::v1::update_many_options.
Provides mongocxx::v1::update_one_options.
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.