MongoDB C++ Driver mongocxx-4.0.0
Loading...
Searching...
No Matches
find_one_and_replace.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
25
26#include <mongocxx/hint.hpp>
29
31
32namespace mongocxx {
33namespace v_noabi {
34namespace options {
35
40 public:
54 collation(bsoncxx::v_noabi::document::view_or_value collation);
55
66 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
67 collation() const;
68
88
97 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<bool>&)
99
114
120 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::hint>&)
121 hint() const;
122
134 let(bsoncxx::v_noabi::document::view_or_value let);
135
143 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>)
144 let() const;
145
157 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
158
166 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>)
167 comment() const;
168
183
192 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds>&)
193 max_time() const;
194
209 projection(bsoncxx::v_noabi::document::view_or_value projection);
210
220 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
221 projection() const;
222
240
251 const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::options::return_document>&)
253
271 sort(bsoncxx::v_noabi::document::view_or_value ordering);
272
282 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
283 sort() const;
284
301
310 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<bool>&) upsert() const;
311
327
338 const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern>&)
340
341 private:
342 bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
343 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
344 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::hint> _hint;
345 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
346 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
347 bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
348 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
349 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::options::return_document> _return_document;
350 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
351 bsoncxx::v_noabi::stdx::optional<bool> _upsert;
352 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
353};
354
355} // namespace options
356} // namespace v_noabi
357} // namespace mongocxx
358
359#include <mongocxx/config/postlude.hpp>
360
Class representing a hint to be passed to a database operation.
Definition hint.hpp:35
Class representing the optional arguments to a MongoDB find_and_modify replace operation.
Definition find_one_and_replace.hpp:39
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > let() const
Gets the current value of the let option.
const bsoncxx::v_noabi::stdx::optional< bool > & bypass_document_validation() const
The current setting for bypassing document validation.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & projection() const
Gets the current projection for this operation.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & sort() const
Gets the current sort ordering.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
const bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
const bsoncxx::v_noabi::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:60
Provides bsoncxx::v_noabi::document::view_or_value.
Declares mongocxx::v_noabi::options::find_one_and_replace.
Provides mongocxx::v_noabi::options::return_document.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:204
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.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides mongocxx::v_noabi::write_concern.