MongoDB C++ Driver 4.2.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 <mongocxx/options/find_one_and_delete-fwd.hpp> // IWYU pragma: export
18
19//
20
23
24#include <mongocxx/v1/find_one_and_delete_options.hpp> // IWYU pragma: export
25
26#include <chrono>
27#include <cstdint> // IWYU pragma: keep: backward compatibility, to be removed.
28#include <utility>
29
35
36#include <mongocxx/hint.hpp>
38
40
41namespace mongocxx {
42namespace v_noabi {
43namespace options {
44
49 public:
54
59
63 explicit operator v1::find_one_and_delete_options() const {
66
68
69 if (_collation) {
70 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
71 }
72
73 if (_max_time) {
74 ret.max_time(*_max_time);
75 }
76
77 if (_projection) {
78 ret.projection(bsoncxx::v1::document::value{to_v1(_projection->view())});
79 }
80
81 if (_ordering) {
82 ret.sort(bsoncxx::v1::document::value{to_v1(_ordering->view())});
83 }
84
85 if (_write_concern) {
86 ret.write_concern(to_v1(*_write_concern));
87 }
88
89 if (_hint) {
90 ret.hint(to_v1(*_hint));
91 }
92
93 if (_let) {
94 ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
95 }
96
97 if (_comment) {
98 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
99 }
100
101 return ret;
102 }
103
117 _collation = std::move(collation);
118 return *this;
119 }
120
133
147 find_one_and_delete& max_time(std::chrono::milliseconds max_time) {
148 _max_time = max_time;
149 return *this;
150 }
151
161 return _max_time;
162 }
163
178 _projection = std::move(projection);
179 return *this;
180 }
181
193
211 _ordering = std::move(ordering);
212 return *this;
213 }
214
226
241 _write_concern = std::move(write_concern);
242 return *this;
243 }
244
255 return _write_concern;
256 }
257
272 _hint = std::move(index_hint);
273 return *this;
274 }
275
282 return _hint;
283 }
284
296 _let = std::move(let);
297 return *this;
298 }
299
309
324
334
335 private:
344};
345
346} // namespace options
347} // namespace v_noabi
348} // namespace mongocxx
349
350namespace mongocxx {
351namespace v_noabi {
352
359
366
367} // namespace v_noabi
368} // namespace mongocxx
369
371
A BSON document.
Definition value.hpp:46
A polyfill for std::optional<T>.
Definition optional.hpp:799
A union of BSON type values.
Definition value.hpp:54
find_one_and_delete()=default
Default initialization.
Options for a "findOneAndDelete" operation.
Definition find_one_and_delete_options.hpp:59
find_one_and_delete_options & write_concern(v1::write_concern write_concern)
Set the "writeConcern" field.
find_one_and_delete_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
find_one_and_delete_options & let(bsoncxx::v1::document::value let)
Set the "let" field.
find_one_and_delete_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
find_one_and_delete_options & max_time(std::chrono::milliseconds max_time)
Set the "maxTimeMS" field.
find_one_and_delete_options & projection(bsoncxx::v1::document::value projection)
Set the "projection" field.
find_one_and_delete_options & sort(bsoncxx::v1::document::value ordering)
Set the "sort" field.
find_one_and_delete_options & hint(v1::hint index_hint)
Set the "hint" field.
The index to "hint" or force a MongoDB server to use when performing a query.
Definition hint.hpp:42
Used by mongocxx::v_noabi::collection.
Definition find_one_and_delete.hpp:48
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition find_one_and_delete.hpp:130
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & projection() const
Gets the current projection set on this operation.
Definition find_one_and_delete.hpp:190
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > const comment() const
Gets the current value of the comment option.
Definition find_one_and_delete.hpp:331
find_one_and_delete & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition find_one_and_delete.hpp:295
find_one_and_delete & sort(bsoncxx::v_noabi::document::view_or_value ordering)
Sets the order to search for a matching document.
Definition find_one_and_delete.hpp:210
find_one_and_delete & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition find_one_and_delete.hpp:116
operator v1::find_one_and_delete_options() const
Convert to the mongocxx::v1 equivalent.
Definition find_one_and_delete.hpp:63
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition find_one_and_delete.hpp:160
find_one_and_delete & write_concern(v_noabi::write_concern write_concern)
Sets the write concern for this operation.
Definition find_one_and_delete.hpp:240
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
Gets the current write concern.
Definition find_one_and_delete.hpp:254
find_one_and_delete & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition find_one_and_delete.hpp:271
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const let() const
Gets the current value of the let option.
Definition find_one_and_delete.hpp:306
find_one_and_delete & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition find_one_and_delete.hpp:320
find_one_and_delete()=default
Default initialization.
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Gets the current sort ordering.
Definition find_one_and_delete.hpp:223
find_one_and_delete & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection that limits the fields to return.
Definition find_one_and_delete.hpp:177
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.
Definition find_one_and_delete.hpp:147
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition find_one_and_delete.hpp:281
The level of acknowledgment requested for write operations to a MongoDB server.
Definition write_concern.hpp:54
Provides bsoncxx::v_noabi::document::view_or_value.
Declares mongocxx::v_noabi::options::find_one_and_delete.
Provides mongocxx::v1::find_one_and_delete_options.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v_noabi macro guard postlude header.
The mongocxx v_noabi macro guard prelude header.
v_noabi::view_or_value< v_noabi::document::view, v_noabi::document::value > view_or_value
Equivalent to v_noabi::view_or_value<v_noabi::document::view, v_noabi::document::value>.
Definition view_or_value.hpp:30
v_noabi::view_or_value< view, value > view_or_value
Equivalent to v_noabi::view_or_value<view, value>.
Definition view_or_value.hpp:31
v1::element::view to_v1(v_noabi::array::element const &v)
Convert to the bsoncxx::v1 equivalent of v.
Definition element.hpp:132
Declares entities whose ABI stability is guaranteed for documented symbols.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
v1::bulk_write to_v1(v_noabi::bulk_write v)
Convert to the mongocxx::v1 equivalent of v.
Definition bulk_write.hpp:162
v_noabi::bulk_write from_v1(v1::bulk_write v)
Convert to the mongocxx::v_noabi equivalent of v.
Definition bulk_write.hpp:155
The top-level namespace within which all mongocxx library entities are declared.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides bsoncxx::v1::document::value.
Provides bsoncxx::v1::types::value.
Provides bsoncxx::v_noabi::document::view.
Provides std::optional-related polyfills for library API usage.
Provides bsoncxx::v_noabi::types::bson_value::view.
Provides mongocxx::v_noabi::hint.
Provides mongocxx::v_noabi::write_concern.