MongoDB C++ Driver current
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>
26
28
29namespace mongocxx {
30namespace v_noabi {
31namespace options {
32
36class update {
37 public:
54
62
77 collation(bsoncxx::v_noabi::document::view_or_value collation);
78
88 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
89 collation() const;
90
105
111 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::hint> const&)
112 hint() const;
113
124 MONGOCXX_ABI_EXPORT_CDECL(update&) let(bsoncxx::v_noabi::document::view_or_value let);
125
132 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const)
133 let() const;
134
138 MONGOCXX_ABI_EXPORT_CDECL(update&) sort(bsoncxx::v_noabi::document::view_or_value sort);
139
143 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
144 sort() const;
145
157 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
158
165 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<
166 bsoncxx::v_noabi::types::bson_value::view_or_value> const)
167 comment() const;
168
186
192 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool> const&) upsert() const;
193
208
218 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern> const&)
220
235 array_filters(bsoncxx::v_noabi::array::view_or_value array_filters);
236
246 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::array::view_or_value> const&)
248
249 private:
250 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
251 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
252 bsoncxx::v_noabi::stdx::optional<bool> _upsert;
253 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
254 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::array::view_or_value> _array_filters;
255 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::hint> _hint;
256 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
257 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _sort;
258 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
259};
260
261} // namespace options
262} // namespace v_noabi
263} // namespace mongocxx
264
265#include <mongocxx/config/postlude.hpp>
266
Provides bsoncxx::v_noabi::array::view_or_value.
A polyfill for std::optional<T>.
Definition optional.hpp:800
The index to "hint" or force a MongoDB server to use when performing a query.
Definition hint.hpp:35
Used by mongocxx::v_noabi::collection.
Definition update.hpp:36
bsoncxx::v_noabi::stdx::optional< bool > const & 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...
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const let() const
Gets the current value of the let option.
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Get the current value of the sort option.
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::array::view_or_value > const & array_filters() const
Get array filters for this operation.
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > const comment() const
Gets the current value of the comment option.
The level of acknowledgment requested for write operations to a MongoDB server.
Definition write_concern.hpp:48
Provides bsoncxx::v_noabi::document::view_or_value.
Provides mongocxx::v_noabi::hint.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v_noabi 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.
Declares mongocxx::v_noabi::options::update.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides std::optional-related polyfills for library API usage.
Provides mongocxx::v_noabi::write_concern.