MongoDB C++ Driver mongocxx-3.10.1
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 <mongocxx/options/find_one_and_delete-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/write_concern.hpp>
27
28#include <mongocxx/config/prelude.hpp>
29
30namespace mongocxx {
31namespace v_noabi {
32namespace options {
33
38 public:
51
60 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& collation() const;
61
74 find_one_and_delete& max_time(std::chrono::milliseconds max_time);
75
83 const stdx::optional<std::chrono::milliseconds>& max_time() const;
84
98
106 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& projection() const;
107
124
132 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& sort() const;
133
148
158 const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern() const;
159
174
180 const stdx::optional<mongocxx::v_noabi::hint>& hint() const;
181
193
200 const stdx::optional<bsoncxx::v_noabi::document::view_or_value> let() const;
201
213
220 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> comment() const;
221
222 private:
223 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
224 stdx::optional<std::chrono::milliseconds> _max_time;
225 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
226 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
227 stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
228 stdx::optional<mongocxx::v_noabi::hint> _hint;
229 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
230 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
231};
232
233} // namespace options
234} // namespace v_noabi
235} // namespace mongocxx
236
237#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 delete operation.
Definition find_one_and_delete.hpp:37
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
find_one_and_delete & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
const stdx::optional< mongocxx::v_noabi::hint > & hint() const
Gets the current hint.
find_one_and_delete & sort(bsoncxx::v_noabi::document::view_or_value ordering)
Sets the order to search for a matching document.
find_one_and_delete & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< mongocxx::v_noabi::write_concern > & write_concern() const
Gets the current write concern.
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_delete & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & sort() const
Gets the current sort ordering.
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_delete & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
find_one_and_delete & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection that limits the fields to return.
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.
find_one_and_delete & write_concern(mongocxx::v_noabi::write_concern write_concern)
Sets the write concern for this operation.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & projection() const
Gets the current projection set on this operation.
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