MongoDB C++ Driver mongocxx-3.10.1
Loading...
Searching...
No Matches
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 <mongocxx/options/find_one_and_update-fwd.hpp>
21
22#include <bsoncxx/array/view_or_value.hpp>
23#include <bsoncxx/document/view_or_value.hpp>
24#include <bsoncxx/stdx/optional.hpp>
25#include <bsoncxx/types/bson_value/view_or_value.hpp>
26#include <mongocxx/hint.hpp>
27#include <mongocxx/options/find_one_common_options.hpp>
28#include <mongocxx/stdx.hpp>
29#include <mongocxx/write_concern.hpp>
30
31#include <mongocxx/config/prelude.hpp>
32
33namespace mongocxx {
34namespace v_noabi {
35namespace options {
36
41 public:
54
63 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& collation() const;
64
82
90 const stdx::optional<bool>& bypass_document_validation() const;
91
107
113 const stdx::optional<mongocxx::v_noabi::hint>& hint() const;
114
126
133 const stdx::optional<bsoncxx::v_noabi::document::view_or_value> let() const;
134
146
153 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> comment() const;
154
167 find_one_and_update& max_time(std::chrono::milliseconds max_time);
168
176 const stdx::optional<std::chrono::milliseconds>& max_time() const;
177
191
199 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& projection() const;
200
215 find_one_and_update& return_document(return_document return_document);
216
225 const stdx::optional<mongocxx::v_noabi::options::return_document>& return_document() const;
226
243
251 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& sort() const;
252
268
276 const stdx::optional<bool>& upsert() const;
277
292
302 const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern() const;
303
317
326 const stdx::optional<bsoncxx::v_noabi::array::view_or_value>& array_filters() const;
327
328 private:
329 stdx::optional<bool> _bypass_document_validation;
330 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
331 stdx::optional<mongocxx::v_noabi::hint> _hint;
332 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
333 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
334 stdx::optional<std::chrono::milliseconds> _max_time;
335 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
336 stdx::optional<mongocxx::v_noabi::options::return_document> _return_document;
337 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
338 stdx::optional<bool> _upsert;
339 stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
340 stdx::optional<bsoncxx::v_noabi::array::view_or_value> _array_filters;
341};
342
343} // namespace options
344} // namespace v_noabi
345} // namespace mongocxx
346
347#include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition hint.hpp:34
Class representing the optional arguments to a MongoDB find_and_modify update operation.
Definition find_one_and_update.hpp:40
const stdx::optional< mongocxx::v_noabi::hint > & hint() const
Gets the current hint.
find_one_and_update & write_concern(mongocxx::v_noabi::write_concern write_concern)
Sets the write concern for this operation.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
find_one_and_update & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection, which limits the fields to return.
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
const stdx::optional< mongocxx::v_noabi::options::return_document > & return_document() const
Which version of the updated document to return.
const stdx::optional< mongocxx::v_noabi::write_concern > & write_concern() const
Gets the current write concern.
find_one_and_update & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
find_one_and_update & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
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.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & projection() const
Gets the current projection for this operation.
find_one_and_update & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
find_one_and_update & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & sort() const
Gets the current sort ordering.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > let() const
Gets the current value of the let option.
find_one_and_update & array_filters(bsoncxx::v_noabi::array::view_or_value array_filters)
Set array filters for this operation.
find_one_and_update & sort(bsoncxx::v_noabi::document::view_or_value ordering)
Sets the order by which to search the collection for a matching document.
find_one_and_update & upsert(bool upsert)
Sets the upsert flag on the operation.
const stdx::optional< bsoncxx::v_noabi::array::view_or_value > & array_filters() const
Get array filters for this operation.
const stdx::optional< bool > & bypass_document_validation() const
The current setting for bypassing document validation.
find_one_and_update & return_document(return_document return_document)
Set the desired version of the updated document to return, either the original document,...
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
const stdx::optional< bool > & upsert() const
Gets the current upsert setting.
find_one_and_update & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
Class representing the server-side requirement for reporting the success of a write operation.
Definition write_concern.hpp:58
The top-level namespace for mongocxx library entities.
Definition bulk_write-fwd.hpp:19