MongoDB C++ Driver 4.2.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
35
37
38namespace mongocxx {
39namespace v_noabi {
40namespace options {
41
46 public:
52 bulk_write() = default;
53
57 /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() bulk_write(v1::bulk_write::options opts);
58
62 explicit operator v1::bulk_write::options() const {
65
67
68 ret.ordered(_ordered);
69
70 if (_write_concern) {
71 ret.write_concern(to_v1(*_write_concern));
72 }
73
74 if (_bypass_document_validation) {
75 ret.bypass_document_validation(*_bypass_document_validation);
76 }
77
78 if (_let) {
79 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
80 }
81
82 if (_comment) {
83 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
84 }
85
86 return ret;
87 }
88
105 _ordered = ordered;
106 return *this;
107 }
108
114 bool ordered() const {
115 return _ordered;
116 }
117
132 _write_concern = std::move(wc);
133 return *this;
134 }
135
146 return _write_concern;
147 }
148
160 _bypass_document_validation = bypass_document_validation;
161 return *this;
162 }
163
171 return _bypass_document_validation;
172 }
173
185 _let = std::move(let);
186 return *this;
187 }
188
198
210 _comment = std::move(comment);
211 return *this;
212 }
213
223
224 class internal;
225
226 private:
227 bool _ordered = true;
229 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
232};
233
234} // namespace options
235} // namespace v_noabi
236} // namespace mongocxx
237
238namespace mongocxx {
239namespace v_noabi {
240
245 return {std::move(v)};
246}
247
254
255} // namespace v_noabi
256} // namespace mongocxx
257
259
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
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:910
options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
options & let(bsoncxx::v1::document::value let)
Set the "let" field.
options & bypass_document_validation(bool bypass_document_validation)
Set the "bypassDocumentValidation" field.
options & write_concern(v1::write_concern wc)
Set the "writeConcern" field.
options & ordered(bool ordered)
Set the "ordered" field.
Used by mongocxx::v_noabi::collection.
Definition bulk_write.hpp:45
bulk_write & ordered(bool ordered)
Sets whether the writes must be executed in order by the server.
Definition bulk_write.hpp:104
bulk_write & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition bulk_write.hpp:209
operator v1::bulk_write::options() const
Convert to the mongocxx::v1 equivalent.
Definition bulk_write.hpp:62
bulk_write & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition bulk_write.hpp:184
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:195
bulk_write & write_concern(v_noabi::write_concern wc)
Sets the write_concern for this operation.
Definition bulk_write.hpp:131
bool ordered() const
Gets the current value of the ordered option.
Definition bulk_write.hpp:114
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:170
bulk_write()=default
Constructs a new bulk_write object. By default, bulk writes are considered ordered as this is the onl...
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
The current write_concern for this operation.
Definition bulk_write.hpp:145
bulk_write & bypass_document_validation(bool bypass_document_validation)
Set whether or not to bypass document validation for this operation.
Definition bulk_write.hpp:159
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:220
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.
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::write_concern.