MongoDB C++ Driver mongocxx-3.6.7
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 <mongocxx/hint.hpp>
21#include <mongocxx/stdx.hpp>
22#include <mongocxx/write_concern.hpp>
23
24#include <mongocxx/config/prelude.hpp>
25
26namespace mongocxx {
27MONGOCXX_INLINE_NAMESPACE_BEGIN
28namespace options {
29
33class MONGOCXX_API update {
34 public:
50 update& 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
98 update& hint(class hint index_hint);
99
105 const stdx::optional<class hint>& hint() const;
106
123 update& upsert(bool upsert);
124
130 const stdx::optional<bool>& upsert() const;
131
145
154 const stdx::optional<class write_concern>& write_concern() const;
155
169
178 const stdx::optional<bsoncxx::array::view_or_value>& array_filters() const;
179
180 private:
181 stdx::optional<bool> _bypass_document_validation;
182 stdx::optional<bsoncxx::document::view_or_value> _collation;
183 stdx::optional<bool> _upsert;
184 stdx::optional<class write_concern> _write_concern;
185 stdx::optional<bsoncxx::array::view_or_value> _array_filters;
186 stdx::optional<class hint> _hint;
187};
188
189} // namespace options
190MONGOCXX_INLINE_NAMESPACE_END
191} // namespace mongocxx
192
193#include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
Class representing the optional arguments to a MongoDB update operation.
Definition: update.hpp:33
const stdx::optional< bool > & upsert() const
Gets the current value of the upsert option.
const stdx::optional< class write_concern > & write_concern() const
The current write_concern for this operation.
update & array_filters(bsoncxx::array::view_or_value array_filters)
Set array filters 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 & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation option.
const stdx::optional< bsoncxx::array::view_or_value > & array_filters() const
Get array filters for this operation.
update & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< class 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::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
update & write_concern(class 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:56
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24