MongoDB C++ Driver  mongocxx-3.7.0
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 <bsoncxx/types/bson_value/view_or_value.hpp>
23 #include <mongocxx/hint.hpp>
24 #include <mongocxx/write_concern.hpp>
25 
26 #include <mongocxx/config/prelude.hpp>
27 
28 namespace mongocxx {
29 MONGOCXX_INLINE_NAMESPACE_BEGIN
30 namespace options {
31 
35 class MONGOCXX_API find_one_and_delete {
36  public:
49 
58  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
59 
72  find_one_and_delete& max_time(std::chrono::milliseconds max_time);
73 
81  const stdx::optional<std::chrono::milliseconds>& max_time() const;
82 
96 
104  const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
105 
122 
130  const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
131 
146 
156  const stdx::optional<mongocxx::write_concern>& write_concern() const;
157 
171  find_one_and_delete& hint(class hint index_hint);
172 
178  const stdx::optional<class hint>& hint() const;
179 
191 
198  const stdx::optional<bsoncxx::document::view_or_value> let() const;
199 
211 
218  const stdx::optional<bsoncxx::types::bson_value::view_or_value> comment() const;
219 
220  private:
221  stdx::optional<bsoncxx::document::view_or_value> _collation;
222  stdx::optional<std::chrono::milliseconds> _max_time;
223  stdx::optional<bsoncxx::document::view_or_value> _projection;
224  stdx::optional<bsoncxx::document::view_or_value> _ordering;
225  stdx::optional<mongocxx::write_concern> _write_concern;
226  stdx::optional<class hint> _hint;
227  stdx::optional<bsoncxx::document::view_or_value> _let;
228  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
229 };
230 
231 } // namespace options
232 MONGOCXX_INLINE_NAMESPACE_END
233 } // namespace mongocxx
234 
235 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
bsoncxx::view_or_value< document::view, document::value >
mongocxx::write_concern
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:56
mongocxx::options::find_one_and_delete
Class representing the optional arguments to a MongoDB find_and_modify delete operation.
Definition: find_one_and_delete.hpp:35
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32