MongoDB C++ Driver 4.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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>
30
32
33namespace mongocxx {
34namespace v_noabi {
35namespace options {
36
41 public:
55 collation(bsoncxx::v_noabi::document::view_or_value collation);
56
66 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
67 collation() const;
68
88
97 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool> const&)
99
115
122 hint() const;
123
135 let(bsoncxx::v_noabi::document::view_or_value let);
136
143 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const)
144 let() const;
145
157 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
158
166 bsoncxx::v_noabi::types::bson_value::view_or_value> const)
167 comment() const;
168
183
192 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> const&)
193 max_time() const;
194
209 projection(bsoncxx::v_noabi::document::view_or_value projection);
210
219 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
220 projection() const;
221
239
251
269 sort(bsoncxx::v_noabi::document::view_or_value ordering);
270
279 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
280 sort() const;
281
298
307 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool> const&) upsert() const;
308
324
336
352
362 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::array::view_or_value> const&)
364
365 private:
366 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
367 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
368 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::hint> _hint;
369 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
370 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
371 bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
372 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
373 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::options::return_document> _return_document;
374 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
375 bsoncxx::v_noabi::stdx::optional<bool> _upsert;
376 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
377 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::array::view_or_value> _array_filters;
378};
379
380} // namespace options
381} // namespace v_noabi
382} // namespace mongocxx
383
384#include <mongocxx/config/postlude.hpp>
385
Provides bsoncxx::v_noabi::array::view_or_value.
Used by mongocxx::v_noabi::collection.
Definition find_one_and_update.hpp:40
find_one_and_update & write_concern(mongocxx::v_noabi::write_concern write_concern)
Sets the write concern for this operation.
find_one_and_update & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection, which limits the fields to return.
find_one_and_update & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
find_one_and_update & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
find_one_and_update & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
find_one_and_update & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
find_one_and_update & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
find_one_and_update & array_filters(bsoncxx::v_noabi::array::view_or_value array_filters)
Set array filters for this operation.
find_one_and_update & sort(bsoncxx::v_noabi::document::view_or_value ordering)
Sets the order by which to search the collection for a matching document.
find_one_and_update & upsert(bool upsert)
Sets the upsert flag on the operation. When true, the operation creates a new document if no document...
find_one_and_update & return_document(return_document return_document)
Set the desired version of the updated document to return, either the original document,...
find_one_and_update & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
Provides bsoncxx::v_noabi::document::view_or_value.
Declares mongocxx::v_noabi::options::find_one_and_update.
Provides mongocxx::v_noabi::options::return_document.
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.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
The top-level namespace within which all mongocxx library entities are declared.
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.