MongoDB C++ Driver mongocxx-3.0.3
Loading...
Searching...
No Matches
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/write_concern.hpp>
23
24#include <mongocxx/config/prelude.hpp>
25
26namespace mongocxx {
27MONGOCXX_INLINE_NAMESPACE_BEGIN
28namespace options {
29
33class MONGOCXX_API find_one_and_delete {
34 public:
43 find_one_and_delete& max_time(std::chrono::milliseconds max_time);
44
52 const stdx::optional<std::chrono::milliseconds>& max_time() const;
53
63
71 const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
72
85
93 const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
94
95 private:
96 stdx::optional<std::chrono::milliseconds> _max_time;
97 stdx::optional<bsoncxx::document::view_or_value> _projection;
98 stdx::optional<bsoncxx::document::view_or_value> _ordering;
99};
100
101} // namespace options
102MONGOCXX_INLINE_NAMESPACE_END
103} // namespace mongocxx
104
105#include <mongocxx/config/postlude.hpp>
Class representing the optional arguments to a MongoDB find_and_modify delete operation.
Definition find_one_and_delete.hpp:33
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.
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< bsoncxx::document::view_or_value > & sort() const
Gets the current sort ordering.