MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
find_one_and_delete.hpp
Go to the documentation of this file.
1// Copyright 2009-present 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
21
25
26#include <mongocxx/hint.hpp>
28
30
31namespace mongocxx {
32namespace v_noabi {
33namespace options {
34
39 public:
53 collation(bsoncxx::v_noabi::document::view_or_value collation);
54
64 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
65 collation() const;
66
81
90 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::chrono::milliseconds>&) max_time() const;
91
106 projection(bsoncxx::v_noabi::document::view_or_value projection);
107
116 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
117 projection() const;
118
136 sort(bsoncxx::v_noabi::document::view_or_value ordering);
137
146 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
147 sort() const;
148
164
174 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::write_concern>&)
176
191
197 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::hint>&) hint() const;
198
210 let(bsoncxx::v_noabi::document::view_or_value let);
211
218 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>)
219 let() const;
220
232 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
233
241 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>)
242 comment() const;
243
244 private:
245 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
246 stdx::optional<std::chrono::milliseconds> _max_time;
247 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
248 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
249 stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
250 stdx::optional<mongocxx::v_noabi::hint> _hint;
251 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
252 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
253};
254
255} // namespace options
256} // namespace v_noabi
257} // namespace mongocxx
258
259#include <mongocxx/config/postlude.hpp>
260
Class representing a hint to be passed to a database operation.
Definition hint.hpp:37
Class representing the optional arguments to a MongoDB find_and_modify delete operation.
Definition find_one_and_delete.hpp:38
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation 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.
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.
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:61
Provides bsoncxx::v_noabi::document::view_or_value.
Declares mongocxx::v_noabi::options::find_one_and_delete.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:222
Provides mongocxx::v_noabi::hint.
The mongocxx macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
The top-level namespace within which all mongocxx library entities are declared.
The top-level namespace reserved for the C++ standard library.
Provides std::optional-related polyfills for library API usage.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides mongocxx::v_noabi::write_concern.