MongoDB C++ Driver  mongocxx-3.10.2
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 <mongocxx/options/update-fwd.hpp>
18 
19 #include <bsoncxx/array/view_or_value.hpp>
20 #include <bsoncxx/document/view_or_value.hpp>
21 #include <bsoncxx/stdx/optional.hpp>
22 #include <bsoncxx/types/bson_value/view_or_value.hpp>
23 #include <mongocxx/hint.hpp>
24 #include <mongocxx/stdx.hpp>
25 #include <mongocxx/write_concern.hpp>
26 
27 #include <mongocxx/config/prelude.hpp>
28 
29 namespace mongocxx {
30 namespace v_noabi {
31 namespace options {
32 
36 class update {
37  public:
54 
60  const stdx::optional<bool>& bypass_document_validation() const;
61 
76 
86  const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& collation() const;
87 
102 
108  const stdx::optional<mongocxx::v_noabi::hint>& hint() 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 
167 
173  const stdx::optional<bool>& upsert() const;
174 
188 
197  const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern() const;
198 
212 
221  const stdx::optional<bsoncxx::v_noabi::array::view_or_value>& array_filters() const;
222 
223  private:
224  stdx::optional<bool> _bypass_document_validation;
225  stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
226  stdx::optional<bool> _upsert;
227  stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
228  stdx::optional<bsoncxx::v_noabi::array::view_or_value> _array_filters;
229  stdx::optional<mongocxx::v_noabi::hint> _hint;
230  stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
231  stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
232 };
233 
234 } // namespace options
235 } // namespace v_noabi
236 } // namespace mongocxx
237 
238 #include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:34
Class representing the optional arguments to a MongoDB update operation.
Definition: update.hpp:36
const stdx::optional< mongocxx::v_noabi::hint > & hint() const
Gets the current hint.
const stdx::optional< bool > & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
update & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
update & write_concern(mongocxx::v_noabi::write_concern wc)
Sets the write_concern for this operation.
update & array_filters(bsoncxx::v_noabi::array::view_or_value array_filters)
Set array filters for this operation.
const stdx::optional< bsoncxx::v_noabi::array::view_or_value > & array_filters() const
Get array filters for this operation.
update & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation option.
update & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
update & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
update & upsert(bool upsert)
Sets the upsert option.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > let() const
Gets the current value of the let option.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
update & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
const stdx::optional< mongocxx::v_noabi::write_concern > & write_concern() const
The current write_concern for this operation.
const stdx::optional< bool > & upsert() const
Gets the current value of the upsert option.
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