MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
update.hpp
Go to the documentation of this file.
1// Copyright 2009-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
18
23
24#include <mongocxx/hint.hpp>
25#include <mongocxx/stdx.hpp>
27
29
30namespace mongocxx {
31namespace v_noabi {
32namespace options {
33
37class update {
38 public:
55
62
77 collation(bsoncxx::v_noabi::document::view_or_value collation);
78
88 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
89 collation() const;
90
105
111 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::hint>&) hint() const;
112
123 MONGOCXX_ABI_EXPORT_CDECL(update&) let(bsoncxx::v_noabi::document::view_or_value let);
124
131 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>)
132 let() const;
133
145 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
146
154 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>)
155 comment() const;
156
174
180 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bool>&) upsert() const;
181
196
206 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::write_concern>&)
208
223 array_filters(bsoncxx::v_noabi::array::view_or_value array_filters);
224
234 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::array::view_or_value>&)
236
237 private:
238 stdx::optional<bool> _bypass_document_validation;
239 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
240 stdx::optional<bool> _upsert;
241 stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
242 stdx::optional<bsoncxx::v_noabi::array::view_or_value> _array_filters;
243 stdx::optional<mongocxx::v_noabi::hint> _hint;
244 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
245 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
246};
247
248} // namespace options
249} // namespace v_noabi
250} // namespace mongocxx
251
252#include <mongocxx/config/postlude.hpp>
253
Provides bsoncxx::v_noabi::array::view_or_value.
A polyfill for std::optional<T>.
Definition optional.hpp:874
Class representing a hint to be passed to a database operation.
Definition hint.hpp:37
Class representing the optional arguments to a MongoDB update operation.
Definition update.hpp:37
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::array::view_or_value > & array_filters() const
Get array filters for this operation.
const stdx::optional< bool > & upsert() const
Gets the current value of the upsert option.
update & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation option. If true, allows the write to opt-out of document level va...
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
const stdx::optional< bool > & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
Class representing the server-side requirement for reporting the success of a write operation....
Definition write_concern.hpp:61
Provides bsoncxx::v_noabi::document::view_or_value.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:222
Provides mongocxx::v_noabi::hint.
The mongocxx macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
The top-level namespace within which all mongocxx library entities are declared.
Provides std::optional-related polyfills for library API usage.
Declares mongocxx::v_noabi::options::update.
Redeclares bsoncxx::v_noabi::stdx in mongocxx::v_noabi::stdx for internal use.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides mongocxx::v_noabi::write_concern.