MongoDB C++ Driver  mongocxx-3.3.2
All Classes Namespaces Functions Enumerations Enumerator Friends Pages
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 <mongocxx/options/find_one_common_options.hpp>
24 #include <mongocxx/stdx.hpp>
25 #include <mongocxx/write_concern.hpp>
26 
27 #include <mongocxx/config/prelude.hpp>
28 
29 namespace mongocxx {
30 MONGOCXX_INLINE_NAMESPACE_BEGIN
31 namespace options {
32 
36 class MONGOCXX_API find_one_and_update {
37  public:
50 
59  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
60 
77  find_one_and_update& bypass_document_validation(bool bypass_document_validation);
78 
86  const stdx::optional<bool>& bypass_document_validation() const;
87 
100  find_one_and_update& max_time(std::chrono::milliseconds max_time);
101 
109  const stdx::optional<std::chrono::milliseconds>& max_time() const;
110 
124 
132  const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
133 
148  find_one_and_update& return_document(return_document return_document);
149 
158  const stdx::optional<mongocxx::options::return_document>& return_document() const;
159 
176 
184  const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
185 
200  find_one_and_update& upsert(bool upsert);
201 
209  const stdx::optional<bool>& upsert() const;
210 
225 
235  const stdx::optional<mongocxx::write_concern>& write_concern() const;
236 
249  find_one_and_update& array_filters(bsoncxx::array::view_or_value array_filters);
250 
259  const stdx::optional<bsoncxx::array::view_or_value>& array_filters() const;
260 
261  private:
262  stdx::optional<bool> _bypass_document_validation;
263  stdx::optional<bsoncxx::document::view_or_value> _collation;
264  stdx::optional<std::chrono::milliseconds> _max_time;
265  stdx::optional<bsoncxx::document::view_or_value> _projection;
266  stdx::optional<mongocxx::options::return_document> _return_document;
267  stdx::optional<bsoncxx::document::view_or_value> _ordering;
268  stdx::optional<bool> _upsert;
269  stdx::optional<mongocxx::write_concern> _write_concern;
270  stdx::optional<bsoncxx::array::view_or_value> _array_filters;
271 
272  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const find_one_and_update&,
273  const find_one_and_update&);
274  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const find_one_and_update&,
275  const find_one_and_update&);
276 };
277 
278 } // namespace options
279 MONGOCXX_INLINE_NAMESPACE_END
280 } // namespace mongocxx
281 
282 #include <mongocxx/config/postlude.hpp>
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:30
Class representing the server-side requirement for reporting the success of a write operation...
Definition: write_concern.hpp:55
Class representing the optional arguments to a MongoDB find_and_modify update operation.
Definition: find_one_and_update.hpp:36