MongoDB C++ Driver  mongocxx-3.6.2
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
replace.hpp
1 // Copyright 2018-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 <bsoncxx/array/view_or_value.hpp>
18 #include <bsoncxx/document/view_or_value.hpp>
19 #include <bsoncxx/stdx/optional.hpp>
20 #include <mongocxx/hint.hpp>
21 #include <mongocxx/stdx.hpp>
22 #include <mongocxx/write_concern.hpp>
23 
24 #include <mongocxx/config/prelude.hpp>
25 
26 namespace mongocxx {
27 MONGOCXX_INLINE_NAMESPACE_BEGIN
28 namespace options {
29 
33 class MONGOCXX_API replace {
34  public:
50  replace& bypass_document_validation(bool bypass_document_validation);
51 
57  const stdx::optional<bool>& bypass_document_validation() const;
58 
73 
83  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
84 
101  replace& upsert(bool upsert);
102 
108  const stdx::optional<bool>& upsert() const;
109 
123 
132  const stdx::optional<class write_concern>& write_concern() const;
133 
147  replace& hint(class hint index_hint);
148 
154  const stdx::optional<class hint>& hint() const;
155 
156  private:
157  stdx::optional<bool> _bypass_document_validation;
158  stdx::optional<bsoncxx::document::view_or_value> _collation;
159  stdx::optional<bool> _upsert;
160  stdx::optional<class write_concern> _write_concern;
161  stdx::optional<class hint> _hint;
162 };
163 
164 } // namespace options
165 MONGOCXX_INLINE_NAMESPACE_END
166 } // namespace mongocxx
167 
168 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
bsoncxx::view_or_value< document::view, document::value >
mongocxx::options::replace::hint
replace & hint(class hint index_hint)
Sets the index to use for this operation.
mongocxx::write_concern
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:56
mongocxx::options::replace::upsert
const stdx::optional< bool > & upsert() const
Gets the current value of the upsert option.
mongocxx::options::replace::write_concern
const stdx::optional< class write_concern > & write_concern() const
The current write_concern for this operation.
mongocxx::options::replace::write_concern
replace & write_concern(class write_concern wc)
Sets the write_concern for this operation.
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
mongocxx::options::replace::collation
replace & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
mongocxx::options::replace::collation
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
mongocxx::options::replace::bypass_document_validation
const stdx::optional< bool > & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
mongocxx::options::replace
Class representing the optional arguments to a MongoDB replace operation.
Definition: replace.hpp:33
mongocxx::options::replace::hint
const stdx::optional< class hint > & hint() const
Gets the current hint.
mongocxx::options::replace::upsert
replace & upsert(bool upsert)
Sets the upsert option.
mongocxx::options::replace::bypass_document_validation
replace & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation option.