MongoDB C++ Driver mongocxx-3.11.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>
28#include <mongocxx/stdx.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(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
67 collation() const;
68
88
97 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bool>&) bypass_document_validation() const;
98
113
119 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::hint>&) hint() const;
120
132 let(bsoncxx::v_noabi::document::view_or_value let);
133
140 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>)
141 let() const;
142
154 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
155
163 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>)
164 comment() const;
165
180
189 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::chrono::milliseconds>&) max_time() const;
190
205 projection(bsoncxx::v_noabi::document::view_or_value projection);
206
215 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
216 projection() const;
217
235
245 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::options::return_document>&)
247
265 sort(bsoncxx::v_noabi::document::view_or_value ordering);
266
275 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
276 sort() const;
277
294
303 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bool>&) upsert() const;
304
320
330 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::write_concern>&)
332
333 private:
334 stdx::optional<bool> _bypass_document_validation;
335 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
336 stdx::optional<mongocxx::v_noabi::hint> _hint;
337 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
338 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
339 stdx::optional<std::chrono::milliseconds> _max_time;
340 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
341 stdx::optional<mongocxx::v_noabi::options::return_document> _return_document;
342 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
343 stdx::optional<bool> _upsert;
344 stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
345};
346
347} // namespace options
348} // namespace v_noabi
349} // namespace mongocxx
350
351#include <mongocxx/config/postlude.hpp>
352
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 replace operation.
Definition find_one_and_replace.hpp:40
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 > let() const
Gets the current value of the let option.
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 > & bypass_document_validation() const
The current setting for bypassing document validation.
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 > & projection() const
Gets the current projection for this operation.
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_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: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.