MongoDB C++ Driver 4.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
65 collation() const;
66
81
90 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> const&)
91 max_time() const;
92
107 projection(bsoncxx::v_noabi::document::view_or_value projection);
108
117 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
118 projection() const;
119
137 sort(bsoncxx::v_noabi::document::view_or_value ordering);
138
147 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
148 sort() const;
149
165
177
192
199 hint() const;
200
212 let(bsoncxx::v_noabi::document::view_or_value let);
213
220 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const)
221 let() const;
222
234 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
235
243 bsoncxx::v_noabi::types::bson_value::view_or_value> const)
244 comment() const;
245
246 private:
247 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
248 bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
249 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
250 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
251 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
252 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::hint> _hint;
253 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
254 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
255};
256
257} // namespace options
258} // namespace v_noabi
259} // namespace mongocxx
260
261#include <mongocxx/config/postlude.hpp>
262
Used by mongocxx::v_noabi::collection.
Definition find_one_and_delete.hpp:38
find_one_and_delete & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
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.
find_one_and_delete & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the 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.
Provides bsoncxx::v_noabi::document::view_or_value.
Declares mongocxx::v_noabi::options::find_one_and_delete.
Provides mongocxx::v_noabi::hint.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v_noabi macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
The top-level namespace within which all mongocxx library entities are declared.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides std::optional-related polyfills for library API usage.
Provides mongocxx::v_noabi::write_concern.