MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
update.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/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 update {
35  public:
51  update& bypass_document_validation(bool bypass_document_validation);
52 
58  const stdx::optional<bool>& bypass_document_validation() const;
59 
73  update& collation(bsoncxx::document::view_or_value collation);
74 
84  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
85 
99  update& hint(class hint index_hint);
100 
106  const stdx::optional<class hint>& hint() const;
107 
118  update& 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 
164  update& upsert(bool upsert);
165 
171  const stdx::optional<bool>& upsert() const;
172 
186 
195  const stdx::optional<class write_concern>& write_concern() const;
196 
209  update& array_filters(bsoncxx::array::view_or_value array_filters);
210 
219  const stdx::optional<bsoncxx::array::view_or_value>& array_filters() const;
220 
221  private:
222  stdx::optional<bool> _bypass_document_validation;
223  stdx::optional<bsoncxx::document::view_or_value> _collation;
224  stdx::optional<bool> _upsert;
225  stdx::optional<class write_concern> _write_concern;
226  stdx::optional<bsoncxx::array::view_or_value> _array_filters;
227  stdx::optional<class hint> _hint;
228  stdx::optional<bsoncxx::document::view_or_value> _let;
229  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
230 };
231 
232 } // namespace options
233 } // namespace v_noabi
234 } // namespace mongocxx
235 
236 #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 update operation.
Definition: update.hpp:34
update & array_filters(bsoncxx::array::view_or_value array_filters)
Set array filters for this operation.
const stdx::optional< class write_concern > & write_concern() const
The current write_concern for this operation.
const stdx::optional< bsoncxx::document::view_or_value > let() const
Gets the current value of the let option.
const stdx::optional< bool > & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
update & let(bsoncxx::document::view_or_value let)
Set the value of the let option.
const stdx::optional< bsoncxx::array::view_or_value > & array_filters() const
Get array filters for this operation.
update & write_concern(class write_concern wc)
Sets the write_concern for this operation.
update & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation option.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
update & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
update & upsert(bool upsert)
Sets the upsert option.
update & hint(class hint index_hint)
Sets the index to use for this operation.
update & comment(bsoncxx::types::bson_value::view_or_value comment)
Set the value of the comment option.
const stdx::optional< class hint > & hint() const
Gets the current hint.
const stdx::optional< bool > & upsert() const
Gets the current value of the upsert option.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
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