MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
find_one_and_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
17#include <chrono>
18#include <cstdint>
19
21
26
27#include <mongocxx/hint.hpp>
29#include <mongocxx/stdx.hpp>
31
33
34namespace mongocxx {
35namespace v_noabi {
36namespace options {
37
42 public:
56 collation(bsoncxx::v_noabi::document::view_or_value collation);
57
67 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
68 collation() const;
69
89
98 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bool>&) bypass_document_validation() const;
99
115
121 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::hint>&) hint() const;
122
134 let(bsoncxx::v_noabi::document::view_or_value let);
135
142 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>)
143 let() const;
144
156 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
157
165 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>)
166 comment() const;
167
182
191 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::chrono::milliseconds>&) max_time() const;
192
207 projection(bsoncxx::v_noabi::document::view_or_value projection);
208
217 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
218 projection() const;
219
237
247 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::options::return_document>&)
249
267 sort(bsoncxx::v_noabi::document::view_or_value ordering);
268
277 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
278 sort() const;
279
296
305 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bool>&) upsert() const;
306
322
332 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::write_concern>&)
334
349 array_filters(bsoncxx::v_noabi::array::view_or_value array_filters);
350
360 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::array::view_or_value>&)
362
363 private:
364 stdx::optional<bool> _bypass_document_validation;
365 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
366 stdx::optional<mongocxx::v_noabi::hint> _hint;
367 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
368 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
369 stdx::optional<std::chrono::milliseconds> _max_time;
370 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
371 stdx::optional<mongocxx::v_noabi::options::return_document> _return_document;
372 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
373 stdx::optional<bool> _upsert;
374 stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
375 stdx::optional<bsoncxx::v_noabi::array::view_or_value> _array_filters;
376};
377
378} // namespace options
379} // namespace v_noabi
380} // namespace mongocxx
381
382#include <mongocxx/config/postlude.hpp>
383
Provides bsoncxx::v_noabi::array::view_or_value.
Class representing a hint to be passed to a database operation.
Definition hint.hpp:37
Class representing the optional arguments to a MongoDB find_and_modify update operation.
Definition find_one_and_update.hpp:41
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & projection() const
Gets the current projection for this operation.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & sort() const
Gets the current sort ordering.
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 > & bypass_document_validation() const
The current setting for bypassing document validation.
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< bool > & upsert() const
Gets the current upsert setting.
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.
Declares mongocxx::v_noabi::options::find_one_and_update.
Provides mongocxx::v_noabi::options::return_document.
#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.
return_document
Enum representing whether to return the old or new version of a document modified by a findOneAndModi...
Definition find_one_common_options.hpp:29
The top-level namespace within which all mongocxx library entities are declared.
The top-level namespace reserved for the C++ standard library.
Provides std::optional-related polyfills for library API usage.
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.