MongoDB C++ Driver  mongocxx-3.6.2
All Classes Namespaces Functions Typedefs 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/hint.hpp>
24 #include <mongocxx/options/find_one_common_options.hpp>
25 #include <mongocxx/stdx.hpp>
26 #include <mongocxx/write_concern.hpp>
27 
28 #include <mongocxx/config/prelude.hpp>
29 
30 namespace mongocxx {
31 MONGOCXX_INLINE_NAMESPACE_BEGIN
32 namespace options {
33 
37 class MONGOCXX_API find_one_and_update {
38  public:
51 
60  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
61 
78  find_one_and_update& bypass_document_validation(bool bypass_document_validation);
79 
87  const stdx::optional<bool>& bypass_document_validation() const;
88 
103  find_one_and_update& hint(class hint index_hint);
104 
110  const stdx::optional<class hint>& hint() const;
111 
124  find_one_and_update& max_time(std::chrono::milliseconds max_time);
125 
133  const stdx::optional<std::chrono::milliseconds>& max_time() const;
134 
148 
156  const stdx::optional<bsoncxx::document::view_or_value>& projection() const;
157 
172  find_one_and_update& return_document(return_document return_document);
173 
182  const stdx::optional<mongocxx::options::return_document>& return_document() const;
183 
200 
208  const stdx::optional<bsoncxx::document::view_or_value>& sort() const;
209 
225 
233  const stdx::optional<bool>& upsert() const;
234 
249 
259  const stdx::optional<mongocxx::write_concern>& write_concern() const;
260 
274 
283  const stdx::optional<bsoncxx::array::view_or_value>& array_filters() const;
284 
285  private:
286  stdx::optional<bool> _bypass_document_validation;
287  stdx::optional<bsoncxx::document::view_or_value> _collation;
288  stdx::optional<class hint> _hint;
289  stdx::optional<std::chrono::milliseconds> _max_time;
290  stdx::optional<bsoncxx::document::view_or_value> _projection;
291  stdx::optional<mongocxx::options::return_document> _return_document;
292  stdx::optional<bsoncxx::document::view_or_value> _ordering;
293  stdx::optional<bool> _upsert;
294  stdx::optional<mongocxx::write_concern> _write_concern;
295  stdx::optional<bsoncxx::array::view_or_value> _array_filters;
296 };
297 
298 } // namespace options
299 MONGOCXX_INLINE_NAMESPACE_END
300 } // namespace mongocxx
301 
302 #include <mongocxx/config/postlude.hpp>
mongocxx::options::find_one_and_update::sort
const stdx::optional< bsoncxx::document::view_or_value > & sort() const
Gets the current sort ordering.
mongocxx::options::find_one_and_update::collation
find_one_and_update & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
bsoncxx::view_or_value
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:30
mongocxx::options::find_one_and_update::collation
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
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::write_concern
find_one_and_update & write_concern(mongocxx::write_concern write_concern)
Sets the write concern for this operation.
mongocxx::options::find_one_and_update::write_concern
const stdx::optional< mongocxx::write_concern > & write_concern() const
Gets the current write concern.
mongocxx::options::find_one_and_update::hint
const stdx::optional< class hint > & hint() const
Gets the current hint.
mongocxx::options::find_one_and_update::projection
const stdx::optional< bsoncxx::document::view_or_value > & projection() const
Gets the current projection for this operation.
mongocxx::options::find_one_and_update::upsert
find_one_and_update & upsert(bool upsert)
Sets the upsert flag on the operation.
mongocxx::options::find_one_and_update::hint
find_one_and_update & hint(class hint index_hint)
Sets the index to use for this operation.
mongocxx::options::find_one_and_update::array_filters
const stdx::optional< bsoncxx::array::view_or_value > & array_filters() const
Get array filters for this operation.
mongocxx::options::find_one_and_update::max_time
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
mongocxx::options::find_one_and_update::upsert
const stdx::optional< bool > & upsert() const
Gets the current upsert setting.
mongocxx::options::find_one_and_update::max_time
find_one_and_update & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
mongocxx::options::find_one_and_update::return_document
find_one_and_update & return_document(return_document return_document)
Set the desired version of the updated document to return, either the original document,...
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:37
mongocxx::options::find_one_and_update::bypass_document_validation
find_one_and_update & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
mongocxx::options::find_one_and_update::return_document
const stdx::optional< mongocxx::options::return_document > & return_document() const
Which version of the updated document to return.
mongocxx::options::find_one_and_update::projection
find_one_and_update & projection(bsoncxx::document::view_or_value projection)
Sets a projection, which limits the fields to return.
mongocxx::options::find_one_and_update::sort
find_one_and_update & sort(bsoncxx::document::view_or_value ordering)
Sets the order by which to search the collection for a matching document.
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
mongocxx::options::find_one_and_update::array_filters
find_one_and_update & array_filters(bsoncxx::array::view_or_value array_filters)
Set array filters for this operation.
mongocxx::options::find_one_and_update::bypass_document_validation
const stdx::optional< bool > & bypass_document_validation() const
The current setting for bypassing document validation.