MongoDB C++ Driver
mongocxx-3.10.2
|
Class representing the optional arguments to a MongoDB aggregation operation. More...
#include <aggregate.hpp>
Public Member Functions | |
aggregate & | allow_disk_use (bool allow_disk_use) |
Enables writing to temporary files. More... | |
const stdx::optional< bool > & | allow_disk_use () const |
Retrieves the current allow_disk_use setting. More... | |
aggregate & | batch_size (std::int32_t batch_size) |
Sets the number of documents to return per batch. More... | |
const stdx::optional< std::int32_t > & | batch_size () const |
The current batch size setting. More... | |
aggregate & | 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... | |
aggregate & | let (bsoncxx::v_noabi::document::view_or_value let) |
Sets the variable mapping for this operation. More... | |
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & | let () const |
Retrieves the current variable mapping for this operation. More... | |
aggregate & | 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... | |
aggregate & | read_preference (mongocxx::v_noabi::read_preference rp) |
Sets the read_preference for this operation. More... | |
const stdx::optional< mongocxx::v_noabi::read_preference > & | read_preference () const |
The current read_preference for this operation. More... | |
aggregate & | bypass_document_validation (bool bypass_document_validation) |
Sets whether the $out stage should bypass document validation. More... | |
const stdx::optional< bool > & | bypass_document_validation () const |
The current bypass_document_validation setting. More... | |
aggregate & | 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... | |
aggregate & | write_concern (mongocxx::v_noabi::write_concern write_concern) |
Sets the write concern to use for this operation. More... | |
const stdx::optional< mongocxx::v_noabi::write_concern > & | write_concern () const |
Gets the current write concern. More... | |
aggregate & | read_concern (mongocxx::v_noabi::read_concern read_concern) |
Sets the read concern to use for this operation. More... | |
const stdx::optional< mongocxx::v_noabi::read_concern > & | read_concern () const |
Gets the current read concern. More... | |
aggregate & | comment (bsoncxx::v_noabi::types::bson_value::view_or_value comment) |
Sets the comment to use for this operation. More... | |
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & | comment () const |
Gets the current comment. More... | |
Class representing the optional arguments to a MongoDB aggregation operation.
const stdx::optional<bool>& mongocxx::v_noabi::options::aggregate::allow_disk_use | ( | ) | const |
Retrieves the current allow_disk_use setting.
aggregate& mongocxx::v_noabi::options::aggregate::allow_disk_use | ( | bool | allow_disk_use | ) |
Enables writing to temporary files.
When set to true
, aggregation stages can write data to the _tmp subdirectory in the dbPath directory. The server-side default is false
.
allow_disk_use | Whether or not to allow disk use. |
const stdx::optional<std::int32_t>& mongocxx::v_noabi::options::aggregate::batch_size | ( | ) | const |
The current batch size setting.
aggregate& mongocxx::v_noabi::options::aggregate::batch_size | ( | std::int32_t | batch_size | ) |
Sets the number of documents to return per batch.
batch_size | The size of the batches to request. |
const stdx::optional<bool>& mongocxx::v_noabi::options::aggregate::bypass_document_validation | ( | ) | const |
The current bypass_document_validation setting.
aggregate& mongocxx::v_noabi::options::aggregate::bypass_document_validation | ( | bool | bypass_document_validation | ) |
Sets whether the $out stage should bypass document validation.
bypass_document_validation | whether or not to bypass validation. |
const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::aggregate::collation | ( | ) | const |
Retrieves the current collation for this operation.
aggregate& mongocxx::v_noabi::options::aggregate::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::aggregate::comment | ( | ) | const |
Gets the current comment.
aggregate& mongocxx::v_noabi::options::aggregate::comment | ( | bsoncxx::v_noabi::types::bson_value::view_or_value | comment | ) |
Sets the comment to use for this operation.
comment | Object representing the comment. |
const stdx::optional<mongocxx::v_noabi::hint>& mongocxx::v_noabi::options::aggregate::hint | ( | ) | const |
Gets the current hint.
aggregate& mongocxx::v_noabi::options::aggregate::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::aggregate::let | ( | ) | const |
Retrieves the current variable mapping for this operation.
aggregate& mongocxx::v_noabi::options::aggregate::let | ( | bsoncxx::v_noabi::document::view_or_value | let | ) |
Sets the variable mapping for this operation.
let | The new variable mapping. |
const stdx::optional<std::chrono::milliseconds>& mongocxx::v_noabi::options::aggregate::max_time | ( | ) | const |
The current max_time setting.
aggregate& mongocxx::v_noabi::options::aggregate::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<mongocxx::v_noabi::read_concern>& mongocxx::v_noabi::options::aggregate::read_concern | ( | ) | const |
Gets the current read concern.
aggregate& mongocxx::v_noabi::options::aggregate::read_concern | ( | mongocxx::v_noabi::read_concern | read_concern | ) |
Sets the read concern to use for this operation.
read_concern | Object representing the read_concern. |
const stdx::optional<mongocxx::v_noabi::read_preference>& mongocxx::v_noabi::options::aggregate::read_preference | ( | ) | const |
The current read_preference for this operation.
aggregate& mongocxx::v_noabi::options::aggregate::read_preference | ( | mongocxx::v_noabi::read_preference | rp | ) |
Sets the read_preference for this operation.
rp | the new read_preference |
const stdx::optional<mongocxx::v_noabi::write_concern>& mongocxx::v_noabi::options::aggregate::write_concern | ( | ) | const |
Gets the current write concern.
aggregate& mongocxx::v_noabi::options::aggregate::write_concern | ( | mongocxx::v_noabi::write_concern | write_concern | ) |
Sets the write concern to use for this operation.
Only has an effect if $out is a part of the pipeline.
write_concern | Object representing the write_concern. |