MongoDB C++ Driver
mongocxx-3.10.2
|
Class representing the optional arguments to a MongoDB find_and_modify update operation. More...
#include <find_one_and_update.hpp>
Public Member Functions | |
find_one_and_update & | collation (bsoncxx::v_noabi::document::view_or_value collation) |
Sets the collation for this operation. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & | collation () const |
Retrieves the current collation for this operation. More... | |
find_one_and_update & | bypass_document_validation (bool bypass_document_validation) |
Whether or not to bypass document validation for this operation. More... | |
const stdx::optional< bool > & | bypass_document_validation () const |
The current setting for bypassing document validation. More... | |
find_one_and_update & | hint (mongocxx::v_noabi::hint index_hint) |
Sets the index to use for this operation. More... | |
const stdx::optional< mongocxx::v_noabi::hint > & | hint () const |
Gets the current hint. More... | |
find_one_and_update & | let (bsoncxx::v_noabi::document::view_or_value let) |
Set the value of the let option. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > | let () const |
Gets the current value of the let option. More... | |
find_one_and_update & | comment (bsoncxx::v_noabi::types::bson_value::view_or_value comment) |
Set the value of the comment option. More... | |
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > | comment () const |
Gets the current value of the comment option. More... | |
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. More... | |
const stdx::optional< std::chrono::milliseconds > & | max_time () const |
The current max_time setting. More... | |
find_one_and_update & | projection (bsoncxx::v_noabi::document::view_or_value projection) |
Sets a projection, which limits the fields to return. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & | projection () const |
Gets the current projection for this operation. More... | |
find_one_and_update & | return_document (return_document return_document) |
Set the desired version of the updated document to return, either the original document, or the updated. More... | |
const stdx::optional< mongocxx::v_noabi::options::return_document > & | return_document () const |
Which version of the updated document to return. More... | |
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. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & | sort () const |
Gets the current sort ordering. More... | |
find_one_and_update & | upsert (bool upsert) |
Sets the upsert flag on the operation. More... | |
const stdx::optional< bool > & | upsert () const |
Gets the current upsert setting. More... | |
find_one_and_update & | write_concern (mongocxx::v_noabi::write_concern write_concern) |
Sets the write concern for this operation. More... | |
const stdx::optional< mongocxx::v_noabi::write_concern > & | write_concern () const |
Gets the current write concern. More... | |
find_one_and_update & | array_filters (bsoncxx::v_noabi::array::view_or_value array_filters) |
Set array filters for this operation. More... | |
const stdx::optional< bsoncxx::v_noabi::array::view_or_value > & | array_filters () const |
Get array filters for this operation. More... | |
Class representing the optional arguments to a MongoDB find_and_modify update operation.
const stdx::optional<bsoncxx::v_noabi::array::view_or_value>& mongocxx::v_noabi::options::find_one_and_update::array_filters | ( | ) | const |
Get array filters for this operation.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::array_filters | ( | bsoncxx::v_noabi::array::view_or_value | array_filters | ) |
Set array filters for this operation.
array_filters | Array representing filters determining which array elements to modify. |
const stdx::optional<bool>& mongocxx::v_noabi::options::find_one_and_update::bypass_document_validation | ( | ) | const |
The current setting for bypassing document validation.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::bypass_document_validation | ( | bool | bypass_document_validation | ) |
Whether or not to bypass document validation for this operation.
bypass_document_validation | Whether or not to bypass document validation. |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::find_one_and_update::collation | ( | ) | const |
Retrieves the current collation for this operation.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::collation | ( | bsoncxx::v_noabi::document::view_or_value | collation | ) |
Sets the collation for this operation.
collation | The new collation. |
const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> mongocxx::v_noabi::options::find_one_and_update::comment | ( | ) | const |
Gets the current value of the comment option.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::comment | ( | bsoncxx::v_noabi::types::bson_value::view_or_value | comment | ) |
Set the value of the comment option.
comment | The new comment option. |
const stdx::optional<mongocxx::v_noabi::hint>& mongocxx::v_noabi::options::find_one_and_update::hint | ( | ) | const |
Gets the current hint.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::hint | ( | mongocxx::v_noabi::hint | index_hint | ) |
Sets the index to use for this operation.
index_hint | Object representing the index to use. |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value> mongocxx::v_noabi::options::find_one_and_update::let | ( | ) | const |
Gets the current value of the let option.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::let | ( | bsoncxx::v_noabi::document::view_or_value | let | ) |
Set the value of the let option.
let | The new let option. |
const stdx::optional<std::chrono::milliseconds>& mongocxx::v_noabi::options::find_one_and_update::max_time | ( | ) | const |
The current max_time setting.
find_one_and_update& mongocxx::v_noabi::options::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.
max_time | The max amount of time (in milliseconds). |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::find_one_and_update::projection | ( | ) | const |
Gets the current projection for this operation.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::projection | ( | bsoncxx::v_noabi::document::view_or_value | projection | ) |
Sets a projection, which limits the fields to return.
projection | The projection document. |
const stdx::optional<mongocxx::v_noabi::options::return_document>& mongocxx::v_noabi::options::find_one_and_update::return_document | ( | ) | const |
Which version of the updated document to return.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::return_document | ( | return_document | return_document | ) |
Set the desired version of the updated document to return, either the original document, or the updated.
By default, the original document is returned.
return_document | Version of document to return, either original or updated. |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::find_one_and_update::sort | ( | ) | const |
Gets the current sort ordering.
find_one_and_update& mongocxx::v_noabi::options::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.
ordering | Document describing the order of the documents to be returned. |
const stdx::optional<bool>& mongocxx::v_noabi::options::find_one_and_update::upsert | ( | ) | const |
Gets the current upsert setting.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::upsert | ( | bool | upsert | ) |
Sets the upsert flag on the operation.
When true
, the operation creates a new document if no document matches the filter. When false
, this operation will do nothing if there are no matching documents. The server-side default is false.
upsert | Whether or not to perform an upsert. |
const stdx::optional<mongocxx::v_noabi::write_concern>& mongocxx::v_noabi::options::find_one_and_update::write_concern | ( | ) | const |
Gets the current write concern.
find_one_and_update& mongocxx::v_noabi::options::find_one_and_update::write_concern | ( | mongocxx::v_noabi::write_concern | write_concern | ) |
Sets the write concern for this operation.
write_concern | Object representing the write concern. |