MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
mongocxx::v_noabi::options::estimated_document_count Class Reference

#include <mongocxx/v_noabi/mongocxx/options/estimated_document_count.hpp>

Description

Class representing the optional arguments to mongocxx::v_noabi::collection::estimated_document_count.

Public Member Functions

const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & comment () const
 The current comment for this operation.
 
estimated_document_countcomment (bsoncxx::v_noabi::types::bson_value::view_or_value comment)
 Sets the comment for this operation.
 
const bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > & max_time () const
 The current max_time setting.
 
estimated_document_countmax_time (std::chrono::milliseconds max_time)
 Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
 
const bsoncxx::v_noabi::stdx::optional< mongocxx::v_noabi::read_preference > & read_preference () const
 The current read_preference for this operation.
 
estimated_document_countread_preference (mongocxx::v_noabi::read_preference rp)
 Sets the read_preference for this operation.
 

Member Function Documentation

◆ comment() [1/2]

const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & mongocxx::v_noabi::options::estimated_document_count::comment ( ) const

The current comment for this operation.

Returns
The current comment
See also

◆ comment() [2/2]

estimated_document_count & mongocxx::v_noabi::options::estimated_document_count::comment ( bsoncxx::v_noabi::types::bson_value::view_or_value comment)

Sets the comment for this operation.

Parameters
commentThe new comment.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
See also

◆ max_time() [1/2]

const bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > & mongocxx::v_noabi::options::estimated_document_count::max_time ( ) const

The current max_time setting.

Returns
The current max time (in milliseconds).
See also

◆ max_time() [2/2]

estimated_document_count & mongocxx::v_noabi::options::estimated_document_count::max_time ( std::chrono::milliseconds max_time)

Sets the maximum amount of time for this operation to run (server-side) in milliseconds.

Parameters
max_timeThe max amount of time (in milliseconds).
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
See also

◆ read_preference() [1/2]

const bsoncxx::v_noabi::stdx::optional< mongocxx::v_noabi::read_preference > & mongocxx::v_noabi::options::estimated_document_count::read_preference ( ) const

The current read_preference for this operation.

Returns
the current read_preference
See also

◆ read_preference() [2/2]

estimated_document_count & mongocxx::v_noabi::options::estimated_document_count::read_preference ( mongocxx::v_noabi::read_preference rp)

Sets the read_preference for this operation.

Parameters
rpThe new read_preference.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
See also

The documentation for this class was generated from the following file: