MongoDB C++ Driver 4.2.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>
40
42
43namespace mongocxx {
44namespace v_noabi {
45namespace options {
46
50class update {
51 public:
55 update() = default;
56
61
65 /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() update(v1::update_one_options opts);
66
72 explicit operator v1::update_many_options() const {
75
77
78 if (_bypass_document_validation) {
79 ret.bypass_document_validation(*_bypass_document_validation);
80 }
81
82 if (_collation) {
83 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
84 }
85
86 if (_upsert) {
87 ret.upsert(*_upsert);
88 }
89
90 if (_write_concern) {
91 ret.write_concern(to_v1(*_write_concern));
92 }
93
94 if (_array_filters) {
95 ret.array_filters(bsoncxx::v1::array::value{to_v1(*_array_filters)});
96 }
97
98 if (_hint) {
99 ret.hint(to_v1(*_hint));
100 }
101
102 if (_let) {
103 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
104 }
105
106 if (_comment) {
107 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
108 }
109
110 return ret;
111 }
112
116 explicit operator v1::update_one_options() const {
119
121
122 if (_bypass_document_validation) {
123 ret.bypass_document_validation(*_bypass_document_validation);
124 }
125
126 if (_collation) {
127 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
128 }
129
130 if (_upsert) {
131 ret.upsert(*_upsert);
132 }
133
134 if (_write_concern) {
135 ret.write_concern(to_v1(*_write_concern));
136 }
137
138 if (_array_filters) {
139 ret.array_filters(bsoncxx::v1::array::value{to_v1(*_array_filters)});
140 }
141
142 if (_hint) {
143 ret.hint(to_v1(*_hint));
144 }
145
146 if (_let) {
147 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
148 }
149
150 if (_sort) {
151 ret.sort(bsoncxx::v1::document::value{to_v1(_sort->view())});
152 }
153
154 if (_comment) {
155 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
156 }
157
158 return ret;
159 }
160
177 _bypass_document_validation = bypass_document_validation;
178 return *this;
179 }
180
187 return _bypass_document_validation;
188 }
189
204 _collation = std::move(collation);
205 return *this;
206 }
207
220
234 update& hint(v_noabi::hint index_hint) {
235 _hint = std::move(index_hint);
236 return *this;
237 }
238
245 return _hint;
246 }
247
259 _let = std::move(let);
260 return *this;
261 }
262
272
277 _sort = std::move(sort);
278 return *this;
279 }
280
287
299 _comment = std::move(comment);
300 return *this;
301 }
302
312
330 _upsert = upsert;
331 return *this;
332 }
333
340 return _upsert;
341 }
342
357 _write_concern = std::move(wc);
358 return *this;
359 }
360
371 return _write_concern;
372 }
373
388 _array_filters = std::move(array_filters);
389 return *this;
390 }
391
404
405 private:
406 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
415};
416
417} // namespace options
418} // namespace v_noabi
419} // namespace mongocxx
420
421namespace mongocxx {
422namespace v_noabi {
423
428 return {std::move(v)};
429}
430
435 return {std::move(v)};
436}
437
438// Ambiguous whether `v_noabi::options::update` should be converted to `v1::update_many_options` or
439// `v1::update_one_options`. Require users to explicitly cast to the expected type instead.
440//
441// v1::update_many_options to_v1(v_noabi::options::update const& v);
442// v1::update_one_options to_v1(v_noabi::options::update const& v);
443
444} // namespace v_noabi
445} // namespace mongocxx
446
448
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:58
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 & 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:59
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.
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:50
update & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition update.hpp:298
update & array_filters(bsoncxx::v_noabi::array::view_or_value array_filters)
Set array filters for this operation.
Definition update.hpp:387
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
The current write_concern for this operation.
Definition update.hpp:370
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition update.hpp:244
update & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition update.hpp:203
update & upsert(bool upsert)
Sets the upsert option.
Definition update.hpp:329
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current value of the upsert option.
Definition update.hpp:339
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:176
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:269
operator v1::update_many_options() const
Convert to the mongocxx::v1 equivalent.
Definition update.hpp:72
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
Definition update.hpp:186
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:217
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:284
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:401
update & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition update.hpp:258
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:309
update & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition update.hpp:234
operator v1::update_one_options() const
Convert to the mongocxx::v1 equivalent.
Definition update.hpp:116
update & sort(bsoncxx::v_noabi::document::view_or_value sort)
Set the sort option.
Definition update.hpp:276
update & write_concern(v_noabi::write_concern wc)
Sets the write_concern for this operation.
Definition update.hpp:356
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::write_concern.