MongoDB C++ Driver  mongocxx-3.10.2
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 <mongocxx/options/bulk_write-fwd.hpp>
18 
19 #include <bsoncxx/document/view_or_value.hpp>
20 #include <bsoncxx/stdx/optional.hpp>
21 #include <bsoncxx/types/bson_value/view_or_value.hpp>
22 #include <mongocxx/write_concern.hpp>
23 
24 #include <mongocxx/config/prelude.hpp>
25 
26 namespace mongocxx {
27 namespace v_noabi {
28 namespace options {
29 
33 class bulk_write {
34  public:
41 
58 
64  bool ordered() const;
65 
79 
88  const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern() const;
89 
101 
108  const stdx::optional<bool> bypass_document_validation() const;
109 
121 
128  const stdx::optional<bsoncxx::v_noabi::document::view_or_value> let() const;
129 
141 
148  const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> comment() const;
149 
150  private:
151  bool _ordered;
152  stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
153  stdx::optional<bool> _bypass_document_validation;
154  stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
155  stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
156 };
157 
158 } // namespace options
159 } // namespace v_noabi
160 } // namespace mongocxx
161 
162 #include <mongocxx/config/postlude.hpp>
Class representing the optional arguments to a MongoDB bulk write.
Definition: bulk_write.hpp:33
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.
bool ordered() const
Gets the current value of the ordered option.
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
bulk_write & bypass_document_validation(bool bypass_document_validation)
Set whether or not to bypass document validation for this operation.
const stdx::optional< mongocxx::v_noabi::write_concern > & write_concern() const
The current write_concern for this operation.
bulk_write()
Constructs a new bulk_write object.
bulk_write & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
bulk_write & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > let() const
Gets the current value of the let option.
bulk_write & write_concern(mongocxx::v_noabi::write_concern wc)
Sets the write_concern for this operation.
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:58
The top-level namespace for mongocxx library entities.
Definition: bulk_write-fwd.hpp:19