MongoDB C++ Driver  mongocxx-3.7.0
find_one_and_update.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/array/view_or_value.hpp>
21 #include <bsoncxx/document/view_or_value.hpp>
22 #include <bsoncxx/stdx/optional.hpp>
23 #include <bsoncxx/types/bson_value/view_or_value.hpp>
24 #include <mongocxx/hint.hpp>
25 #include <mongocxx/options/find_one_common_options.hpp>
26 #include <mongocxx/stdx.hpp>
27 #include <mongocxx/write_concern.hpp>
28 
29 #include <mongocxx/config/prelude.hpp>
30 
31 namespace mongocxx {
32 MONGOCXX_INLINE_NAMESPACE_BEGIN
33 namespace options {
34 
38 class MONGOCXX_API find_one_and_update {
39  public:
52 
61  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
62 
79  find_one_and_update& bypass_document_validation(bool bypass_document_validation);
80 
88  const stdx::optional<bool>& bypass_document_validation() const;
89 
104  find_one_and_update& hint(class hint index_hint);
105 
111  const stdx::optional<class hint>& hint() const;
112 
124 
131  const stdx::optional<bsoncxx::document::view_or_value> let() const;
132 
144 
151  const stdx::optional<bsoncxx::types::bson_value::view_or_value> comment() const;
152 
165  find_one_and_update& max_time(std::chrono::milliseconds max_time);
166 
174  const stdx::optional<std::chrono::milliseconds>& max_time() const;
175 
189 
197  const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
198 
213  find_one_and_update& return_document(return_document return_document);
214 
223  const stdx::optional<mongocxx::options::return_document>& return_document() const;
224 
241 
249  const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
250 
265  find_one_and_update& upsert(bool upsert);
266 
274  const stdx::optional<bool>& upsert() const;
275 
290 
300  const stdx::optional<mongocxx::write_concern>& write_concern() const;
301 
314  find_one_and_update& array_filters(bsoncxx::array::view_or_value array_filters);
315 
324  const stdx::optional<bsoncxx::array::view_or_value>& array_filters() const;
325 
326  private:
327  stdx::optional<bool> _bypass_document_validation;
328  stdx::optional<bsoncxx::document::view_or_value> _collation;
329  stdx::optional<class hint> _hint;
330  stdx::optional<bsoncxx::document::view_or_value> _let;
331  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
332  stdx::optional<std::chrono::milliseconds> _max_time;
333  stdx::optional<bsoncxx::document::view_or_value> _projection;
334  stdx::optional<mongocxx::options::return_document> _return_document;
335  stdx::optional<bsoncxx::document::view_or_value> _ordering;
336  stdx::optional<bool> _upsert;
337  stdx::optional<mongocxx::write_concern> _write_concern;
338  stdx::optional<bsoncxx::array::view_or_value> _array_filters;
339 };
340 
341 } // namespace options
342 MONGOCXX_INLINE_NAMESPACE_END
343 } // namespace mongocxx
344 
345 #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_update
Class representing the optional arguments to a MongoDB find_and_modify update operation.
Definition: find_one_and_update.hpp:38
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32