MongoDB C++ Driver  mongocxx-3.9.0
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 <bsoncxx/types/bson_value/view_or_value.hpp>
21 #include <mongocxx/hint.hpp>
22 #include <mongocxx/stdx.hpp>
23 #include <mongocxx/write_concern.hpp>
24 
25 #include <mongocxx/config/prelude.hpp>
26 
27 namespace mongocxx {
28 inline namespace v_noabi {
29 namespace options {
30 
34 class MONGOCXX_API replace {
35  public:
51  replace& bypass_document_validation(bool bypass_document_validation);
52 
58  const stdx::optional<bool>& bypass_document_validation() const;
59 
73  replace& collation(bsoncxx::document::view_or_value collation);
74 
84  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
85 
102  replace& upsert(bool upsert);
103 
109  const stdx::optional<bool>& upsert() const;
110 
124 
133  const stdx::optional<class write_concern>& write_concern() const;
134 
148  replace& hint(class hint index_hint);
149 
155  const stdx::optional<class hint>& hint() const;
156 
167  replace& let(bsoncxx::document::view_or_value let);
168 
175  const stdx::optional<bsoncxx::document::view_or_value> let() const;
176 
188 
195  const stdx::optional<bsoncxx::types::bson_value::view_or_value> comment() const;
196 
197  private:
198  stdx::optional<bool> _bypass_document_validation;
199  stdx::optional<bsoncxx::document::view_or_value> _collation;
200  stdx::optional<bool> _upsert;
201  stdx::optional<class write_concern> _write_concern;
202  stdx::optional<class hint> _hint;
203  stdx::optional<bsoncxx::document::view_or_value> _let;
204  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
205 };
206 
207 } // namespace options
208 } // namespace v_noabi
209 } // namespace mongocxx
210 
211 #include <mongocxx/config/postlude.hpp>
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:29
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:31
Class representing the optional arguments to a MongoDB replace operation.
Definition: replace.hpp:34
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
replace & write_concern(class write_concern wc)
Sets the write_concern for this operation.
const stdx::optional< bool > & upsert() const
Gets the current value of the upsert option.
replace & hint(class hint index_hint)
Sets the index to use for this operation.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
const stdx::optional< bool > & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
replace & comment(bsoncxx::types::bson_value::view_or_value comment)
Set the value of the comment option.
const stdx::optional< bsoncxx::document::view_or_value > let() const
Gets the current value of the let option.
replace & upsert(bool upsert)
Sets the upsert option.
replace & let(bsoncxx::document::view_or_value let)
Set the value of the let option.
const stdx::optional< class write_concern > & write_concern() const
The current write_concern for this operation.
replace & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< class hint > & hint() const
Gets the current hint.
replace & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation 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