MongoDB C++ Driver 4.4.0
Loading...
Searching...
No Matches
bulk_write.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/bulk_write-fwd.hpp> // IWYU pragma: export
18
19//
20
23
24#include <mongocxx/v1/bulk_write.hpp> // IWYU pragma: export
25
26#include <utility>
27
33
36
38
39namespace mongocxx {
40namespace v_noabi {
41namespace options {
42
47 public:
53 bulk_write() = default;
54
59
63 explicit operator v1::bulk_write::options() const {
66
68
69 ret.ordered(_ordered);
70
71 if (_read_concern) {
72 ret.read_concern(to_v1(*_read_concern));
73 }
74
75 if (_write_concern) {
76 ret.write_concern(to_v1(*_write_concern));
77 }
78
79 if (_bypass_document_validation) {
80 ret.bypass_document_validation(*_bypass_document_validation);
81 }
82
83 if (_let) {
84 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
85 }
86
87 if (_comment) {
88 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
89 }
90
91 return ret;
92 }
93
110 _ordered = ordered;
111 return *this;
112 }
113
119 bool ordered() const {
120 return _ordered;
121 }
122
137 _read_concern = std::move(rc);
138 return *this;
139 }
140
151 return _read_concern;
152 }
153
168 _write_concern = std::move(wc);
169 return *this;
170 }
171
182 return _write_concern;
183 }
184
196 _bypass_document_validation = bypass_document_validation;
197 return *this;
198 }
199
207 return _bypass_document_validation;
208 }
209
221 _let = std::move(let);
222 return *this;
223 }
224
234
246 _comment = std::move(comment);
247 return *this;
248 }
249
259
260 class internal;
261
262 private:
263 bool _ordered = true;
266 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
269};
270
271} // namespace options
272} // namespace v_noabi
273} // namespace mongocxx
274
275namespace mongocxx {
276namespace v_noabi {
277
282 return {std::move(v)};
283}
284
291
292} // namespace v_noabi
293} // namespace mongocxx
294
296
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
bulk_write()=default
Constructs a new bulk_write object. By default, bulk writes are considered ordered as this is the onl...
Options for a bulk write operation.
Definition bulk_write.hpp:893
options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
options & bypass_document_validation(bool v)
Set the "bypassDocumentValidation" field.
options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
options & let(bsoncxx::v1::document::value v)
Set the "let" field.
options & read_concern(v1::read_concern v)
Set the "readConcern" field.
options & ordered(bool v)
Set the "ordered" field.
Used by mongocxx::v_noabi::collection.
Definition bulk_write.hpp:46
bulk_write & ordered(bool ordered)
Sets whether the writes must be executed in order by the server.
Definition bulk_write.hpp:109
bulk_write & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition bulk_write.hpp:245
operator v1::bulk_write::options() const
Convert to the mongocxx::v1 equivalent.
Definition bulk_write.hpp:63
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
The current read_concern for this operation.
Definition bulk_write.hpp:150
bulk_write & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition bulk_write.hpp:220
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const let() const
Gets the current value of the let option.
Definition bulk_write.hpp:231
bulk_write & write_concern(v_noabi::write_concern wc)
Sets the write_concern for this operation.
Definition bulk_write.hpp:167
bool ordered() const
Gets the current value of the ordered option.
Definition bulk_write.hpp:119
bsoncxx::v_noabi::stdx::optional< bool > const bypass_document_validation() const
The current setting for bypassing document validation for this operation.
Definition bulk_write.hpp:206
bulk_write()=default
Constructs a new bulk_write object. By default, bulk writes are considered ordered as this is the onl...
bulk_write & read_concern(v_noabi::read_concern rc)
Sets the read_concern for this operation.
Definition bulk_write.hpp:136
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
The current write_concern for this operation.
Definition bulk_write.hpp:181
bulk_write & bypass_document_validation(bool bypass_document_validation)
Set whether or not to bypass document validation for this operation.
Definition bulk_write.hpp:195
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 bulk_write.hpp:256
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_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 entities related to write operations.
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.
Declares mongocxx::v_noabi::options::bulk_write.
Provides mongocxx::v_noabi::read_concern.
Provides mongocxx::v_noabi::write_concern.