MongoDB C++ Driver mongocxx-3.6.7
find_one_and_delete.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/hint.hpp>
23#include <mongocxx/write_concern.hpp>
24
25#include <mongocxx/config/prelude.hpp>
26
27namespace mongocxx {
28MONGOCXX_INLINE_NAMESPACE_BEGIN
29namespace options {
30
34class MONGOCXX_API find_one_and_delete {
35 public:
48
57 const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
58
71 find_one_and_delete& max_time(std::chrono::milliseconds max_time);
72
80 const stdx::optional<std::chrono::milliseconds>& max_time() const;
81
95
103 const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
104
121
129 const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
130
145
155 const stdx::optional<mongocxx::write_concern>& write_concern() const;
156
170 find_one_and_delete& hint(class hint index_hint);
171
177 const stdx::optional<class hint>& hint() const;
178
179 private:
180 stdx::optional<bsoncxx::document::view_or_value> _collation;
181 stdx::optional<std::chrono::milliseconds> _max_time;
182 stdx::optional<bsoncxx::document::view_or_value> _projection;
183 stdx::optional<bsoncxx::document::view_or_value> _ordering;
184 stdx::optional<mongocxx::write_concern> _write_concern;
185 stdx::optional<class hint> _hint;
186};
187
188} // namespace options
189MONGOCXX_INLINE_NAMESPACE_END
190} // namespace mongocxx
191
192#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 delete operation.
Definition: find_one_and_delete.hpp:34
find_one_and_delete & hint(class hint index_hint)
Sets the index to use for this operation.
find_one_and_delete & write_concern(mongocxx::write_concern write_concern)
Sets the write concern for this operation.
find_one_and_delete & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< mongocxx::write_concern > & write_concern() const
Gets the current write concern.
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
find_one_and_delete & projection(bsoncxx::document::view_or_value projection)
Sets a projection that limits the fields to return.
const stdx::optional< bsoncxx::document::view_or_value > & projection() const
Gets the current projection set on this operation.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
find_one_and_delete & sort(bsoncxx::document::view_or_value ordering)
Sets the order to search for a matching document.
find_one_and_delete & 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< class hint > & hint() const
Gets the current hint.
const stdx::optional< bsoncxx::document::view_or_value > & sort() const
Gets the current sort ordering.
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