MongoDB C++ Driver mongocxx-3.7.0
Loading...
Searching...
No Matches
find_one_and_replace.hpp
1// Copyright 2014 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
20#include <bsoncxx/document/view_or_value.hpp>
21#include <bsoncxx/stdx/optional.hpp>
22#include <bsoncxx/types/bson_value/view_or_value.hpp>
23#include <mongocxx/hint.hpp>
24#include <mongocxx/options/find_one_common_options.hpp>
25#include <mongocxx/stdx.hpp>
26#include <mongocxx/write_concern.hpp>
27
28#include <mongocxx/config/prelude.hpp>
29
30namespace mongocxx {
31MONGOCXX_INLINE_NAMESPACE_BEGIN
32namespace options {
33
37class MONGOCXX_API find_one_and_replace {
38 public:
51
60 const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
61
78 find_one_and_replace& bypass_document_validation(bool bypass_document_validation);
79
87 const stdx::optional<bool>& bypass_document_validation() const;
88
102 find_one_and_replace& hint(class hint index_hint);
103
109 const stdx::optional<class hint>& hint() const;
110
122
129 const stdx::optional<bsoncxx::document::view_or_value> let() const;
130
142
149 const stdx::optional<bsoncxx::types::bson_value::view_or_value> comment() const;
150
163 find_one_and_replace& max_time(std::chrono::milliseconds max_time);
164
172 const stdx::optional<std::chrono::milliseconds>& max_time() const;
173
187
195 const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
196
211 find_one_and_replace& return_document(return_document return_document);
212
221 const stdx::optional<mongocxx::options::return_document>& return_document() const;
222
239
247 const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
248
264
272 const stdx::optional<bool>& upsert() const;
273
288
298 const stdx::optional<mongocxx::write_concern>& write_concern() const;
299
300 private:
301 stdx::optional<bool> _bypass_document_validation;
302 stdx::optional<bsoncxx::document::view_or_value> _collation;
303 stdx::optional<class hint> _hint;
304 stdx::optional<bsoncxx::document::view_or_value> _let;
305 stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
306 stdx::optional<std::chrono::milliseconds> _max_time;
307 stdx::optional<bsoncxx::document::view_or_value> _projection;
308 stdx::optional<mongocxx::options::return_document> _return_document;
309 stdx::optional<bsoncxx::document::view_or_value> _ordering;
310 stdx::optional<bool> _upsert;
311 stdx::optional<mongocxx::write_concern> _write_concern;
312};
313
314} // namespace options
315MONGOCXX_INLINE_NAMESPACE_END
316} // namespace mongocxx
317
318#include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition hint.hpp:32
Class representing the optional arguments to a MongoDB find_and_modify replace operation.
Definition find_one_and_replace.hpp:37
find_one_and_replace & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
find_one_and_replace & upsert(bool upsert)
Sets the upsert flag on the operation.
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
find_one_and_replace & 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_replace & projection(bsoncxx::document::view_or_value projection)
Sets a projection, which limits the fields to return.
find_one_and_replace & comment(bsoncxx::types::bson_value::view_or_value comment)
Set the value of the comment option.
find_one_and_replace & return_document(return_document return_document)
Set the desired version of the replaced document to return, either the original document,...
find_one_and_replace & hint(class hint index_hint)
Sets the index to use for this operation.
find_one_and_replace & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
const stdx::optional< mongocxx::write_concern > & write_concern() const
Gets the current write concern.
const stdx::optional< bsoncxx::document::view_or_value > & sort() const
Gets the current sort ordering.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
find_one_and_replace & sort(bsoncxx::document::view_or_value ordering)
Sets the order by which to search the collection for a matching document.
const stdx::optional< bsoncxx::document::view_or_value > & projection() const
Gets the current projection for this operation.
find_one_and_replace & write_concern(mongocxx::write_concern write_concern)
Sets the write concern for this operation.
find_one_and_replace & let(bsoncxx::document::view_or_value let)
Set the value of the let option.
const stdx::optional< bool > & upsert() const
Gets the current upsert setting.
const stdx::optional< bool > & bypass_document_validation() const
The current setting for bypassing document validation.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
const stdx::optional< class hint > & hint() const
Gets the current hint.
const stdx::optional< bsoncxx::document::view_or_value > let() const
Gets the current value of the let option.
const stdx::optional< mongocxx::options::return_document > & return_document() const
Which version of the replaced document to return.
Class representing the server-side requirement for reporting the success of a write operation.
Definition write_concern.hpp:56
Top level namespace for the MongoDB C++ driver.
Definition bulk_write.hpp:24