MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
bulk_write.hpp
1 // Copyright 2014 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 <bsoncxx/document/view_or_value.hpp>
18 #include <bsoncxx/stdx/optional.hpp>
19 #include <bsoncxx/types/bson_value/view_or_value.hpp>
20 #include <mongocxx/write_concern.hpp>
21 
22 #include <mongocxx/config/prelude.hpp>
23 
24 namespace mongocxx {
25 inline namespace v_noabi {
26 namespace options {
27 
31 class MONGOCXX_API bulk_write {
32  public:
39 
55  bulk_write& ordered(bool ordered);
56 
62  bool ordered() const;
63 
77 
86  const stdx::optional<class write_concern>& write_concern() const;
87 
98  bulk_write& bypass_document_validation(bool bypass_document_validation);
99 
106  const stdx::optional<bool> bypass_document_validation() const;
107 
118  bulk_write& let(bsoncxx::document::view_or_value let);
119 
126  const stdx::optional<bsoncxx::document::view_or_value> let() const;
127 
139 
146  const stdx::optional<bsoncxx::types::bson_value::view_or_value> comment() const;
147 
148  private:
149  bool _ordered;
150  stdx::optional<class write_concern> _write_concern;
151  stdx::optional<bool> _bypass_document_validation;
152  stdx::optional<bsoncxx::document::view_or_value> _let;
153  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
154 };
155 
156 } // namespace options
157 } // namespace v_noabi
158 } // namespace mongocxx
159 
160 #include <mongocxx/config/postlude.hpp>
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:29
Class representing the optional arguments to a MongoDB bulk write.
Definition: bulk_write.hpp:31
bulk_write & ordered(bool ordered)
Sets whether the writes must be executed in order by the server.
const stdx::optional< bool > bypass_document_validation() const
The current setting for bypassing document validation for this operation.
const stdx::optional< bsoncxx::document::view_or_value > let() const
Gets the current value of the let option.
bool ordered() const
Gets the current value of the ordered option.
const stdx::optional< class write_concern > & write_concern() const
The current write_concern for this operation.
bulk_write & write_concern(class write_concern wc)
Sets the write_concern for this operation.
bulk_write & bypass_document_validation(bool bypass_document_validation)
Set whether or not to bypass document validation for this operation.
bulk_write()
Constructs a new bulk_write object.
bulk_write & comment(bsoncxx::types::bson_value::view_or_value comment)
Set the value of the comment option.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
bulk_write & let(bsoncxx::document::view_or_value let)
Set the value of the let option.
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:59
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24