MongoDB C++ Driver  mongocxx-3.4.0
Public Member Functions | List of all members
mongocxx::options::distinct Class Reference

Class representing the optional arguments to a MongoDB distinct command. More...

#include <distinct.hpp>

Public Member Functions

distinctcollation (bsoncxx::document::view_or_value collation)
 Sets the collation for this operation. More...
 
const stdx::optional< bsoncxx::document::view_or_value > & collation () const
 Retrieves the current collation for this operation. More...
 
distinctmax_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...
 
distinctread_preference (class read_preference rp)
 Sets the read_preference for this operation. More...
 
const stdx::optional< class read_preference > & read_preference () const
 The current read_preference for this operation. More...
 

Detailed Description

Class representing the optional arguments to a MongoDB distinct command.

Member Function Documentation

◆ collation() [1/2]

distinct& mongocxx::options::distinct::collation ( bsoncxx::document::view_or_value  collation)

Sets the collation for this operation.

Parameters
collationThe new collation.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
See also
https://docs.mongodb.com/master/reference/command/distinct/

◆ collation() [2/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::distinct::collation ( ) const

Retrieves the current collation for this operation.

Returns
The current collation.
See also
https://docs.mongodb.com/master/reference/command/distinct/

◆ max_time() [1/2]

distinct& mongocxx::options::distinct::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
https://docs.mongodb.com/master/reference/command/distinct/

◆ max_time() [2/2]

const stdx::optional<std::chrono::milliseconds>& mongocxx::options::distinct::max_time ( ) const

The current max_time setting.

Returns
The current max time (in milliseconds).
See also
https://docs.mongodb.com/master/reference/command/distinct/

◆ read_preference() [1/2]

distinct& mongocxx::options::distinct::read_preference ( class 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
https://docs.mongodb.com/master/reference/command/distinct/

◆ read_preference() [2/2]

const stdx::optional<class read_preference>& mongocxx::options::distinct::read_preference ( ) const

The current read_preference for this operation.

Returns
the current read_preference.
See also
https://docs.mongodb.com/master/reference/command/distinct/

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