MongoDB C++ Driver mongocxx-3.10.1
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 <mongocxx/options/find_one_and_replace-fwd.hpp>
21
22#include <bsoncxx/document/view_or_value.hpp>
23#include <bsoncxx/stdx/optional.hpp>
24#include <bsoncxx/types/bson_value/view_or_value.hpp>
25#include <mongocxx/hint.hpp>
26#include <mongocxx/options/find_one_common_options.hpp>
27#include <mongocxx/stdx.hpp>
28#include <mongocxx/write_concern.hpp>
29
30#include <mongocxx/config/prelude.hpp>
31
32namespace mongocxx {
33namespace v_noabi {
34namespace options {
35
40 public:
53
62 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& collation() const;
63
81
89 const stdx::optional<bool>& bypass_document_validation() const;
90
105
111 const stdx::optional<mongocxx::v_noabi::hint>& hint() const;
112
124
131 const stdx::optional<bsoncxx::v_noabi::document::view_or_value> let() const;
132
144
151 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> comment() const;
152
165 find_one_and_replace& max_time(std::chrono::milliseconds max_time);
166
174 const stdx::optional<std::chrono::milliseconds>& max_time() const;
175
189
197 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& projection() const;
198
213 find_one_and_replace& return_document(return_document return_document);
214
223 const stdx::optional<mongocxx::v_noabi::options::return_document>& return_document() const;
224
241
249 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& sort() const;
250
266
274 const stdx::optional<bool>& upsert() const;
275
290
300 const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern() const;
301
302 private:
303 stdx::optional<bool> _bypass_document_validation;
304 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
305 stdx::optional<mongocxx::v_noabi::hint> _hint;
306 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
307 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
308 stdx::optional<std::chrono::milliseconds> _max_time;
309 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
310 stdx::optional<mongocxx::v_noabi::options::return_document> _return_document;
311 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
312 stdx::optional<bool> _upsert;
313 stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
314};
315
316} // namespace options
317} // namespace v_noabi
318} // namespace mongocxx
319
320#include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition hint.hpp:34
Class representing the optional arguments to a MongoDB find_and_modify replace operation.
Definition find_one_and_replace.hpp:39
find_one_and_replace & upsert(bool upsert)
Sets the upsert flag on the operation.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
find_one_and_replace & 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_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 & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
find_one_and_replace & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
find_one_and_replace & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation 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.
find_one_and_replace & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection, which limits the fields to return.
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.
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
find_one_and_replace & write_concern(mongocxx::v_noabi::write_concern write_concern)
Sets the write concern for this operation.
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.
find_one_and_replace & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & projection() const
Gets the current projection for this operation.
const stdx::optional< mongocxx::v_noabi::write_concern > & write_concern() const
Gets the current write concern.
find_one_and_replace & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< bool > & upsert() const
Gets the current upsert setting.
const stdx::optional< mongocxx::v_noabi::options::return_document > & return_document() const
Which version of the replaced document to return.
const stdx::optional< mongocxx::v_noabi::hint > & hint() const
Gets the current hint.
Class representing the server-side requirement for reporting the success of a write operation.
Definition write_concern.hpp:58
The top-level namespace for mongocxx library entities.
Definition bulk_write-fwd.hpp:19