MongoDB C++ Driver  mongocxx-3.3.0
All Classes Namespaces Functions Enumerations Enumerator Friends Pages
find_one_and_replace.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 <mongocxx/options/find_one_common_options.hpp>
23 #include <mongocxx/stdx.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_replace {
36  public:
49 
58  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
59 
76  find_one_and_replace& bypass_document_validation(bool bypass_document_validation);
77 
85  const stdx::optional<bool>& bypass_document_validation() const;
86 
99  find_one_and_replace& max_time(std::chrono::milliseconds max_time);
100 
108  const stdx::optional<std::chrono::milliseconds>& max_time() const;
109 
123 
131  const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
132 
147  find_one_and_replace& return_document(return_document return_document);
148 
157  const stdx::optional<mongocxx::options::return_document>& return_document() const;
158 
175 
183  const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
184 
199  find_one_and_replace& upsert(bool upsert);
200 
208  const stdx::optional<bool>& upsert() const;
209 
224 
234  const stdx::optional<mongocxx::write_concern>& write_concern() const;
235 
236  private:
237  stdx::optional<bool> _bypass_document_validation;
238  stdx::optional<bsoncxx::document::view_or_value> _collation;
239  stdx::optional<std::chrono::milliseconds> _max_time;
240  stdx::optional<bsoncxx::document::view_or_value> _projection;
241  stdx::optional<mongocxx::options::return_document> _return_document;
242  stdx::optional<bsoncxx::document::view_or_value> _ordering;
243  stdx::optional<bool> _upsert;
244  stdx::optional<mongocxx::write_concern> _write_concern;
245 
246  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const find_one_and_replace&,
247  const find_one_and_replace&);
248  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const find_one_and_replace&,
249  const find_one_and_replace&);
250 };
251 
252 } // namespace options
253 MONGOCXX_INLINE_NAMESPACE_END
254 } // namespace mongocxx
255 
256 #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 optional arguments to a MongoDB find_and_modify replace operation.
Definition: find_one_and_replace.hpp:35
Class representing the server-side requirement for reporting the success of a write operation...
Definition: write_concern.hpp:55