MongoDB C++ Driver mongocxx-3.0.3
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 <mongocxx/options/find_one_common_options.hpp>
23#include <mongocxx/stdx.hpp>
24
25#include <mongocxx/config/prelude.hpp>
26
27namespace mongocxx {
28MONGOCXX_INLINE_NAMESPACE_BEGIN
29namespace options {
30
34class MONGOCXX_API find_one_and_replace {
35 public:
48 find_one_and_replace& bypass_document_validation(bool bypass_document_validation);
49
55 const stdx::optional<bool>& bypass_document_validation() const;
56
65 find_one_and_replace& max_time(std::chrono::milliseconds max_time);
66
74 const stdx::optional<std::chrono::milliseconds>& max_time() const;
75
85
93 const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
94
105 find_one_and_replace& return_document(return_document return_document);
106
115 const stdx::optional<mongocxx::options::return_document>& return_document() const;
116
129
137 const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
138
150
158 const stdx::optional<bool>& upsert() const;
159
160 private:
161 stdx::optional<bool> _bypass_document_validation;
162 stdx::optional<std::chrono::milliseconds> _max_time;
163 stdx::optional<bsoncxx::document::view_or_value> _projection;
164 stdx::optional<mongocxx::options::return_document> _return_document;
165 stdx::optional<bsoncxx::document::view_or_value> _ordering;
166 stdx::optional<bool> _upsert;
167};
168
169} // namespace options
170MONGOCXX_INLINE_NAMESPACE_END
171} // namespace mongocxx
172
173#include <mongocxx/config/postlude.hpp>
Class representing the optional arguments to a MongoDB find_and_modify replace operation.
Definition find_one_and_replace.hpp:34
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 & return_document(return_document return_document)
Set the desired version of the replaced document to return, either the original document,...
find_one_and_replace & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
const stdx::optional< bsoncxx::document::view_or_value > & sort() const
Gets the current sort ordering.
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.
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< mongocxx::options::return_document > & return_document() const
Which version of the replaced document to return.