mongocxx::options::count Class Reference

Class representing the optional arguments to mongocxx::collection::count_documents. More...

#include <count.hpp>

Public Member Functions
count &	collation (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...
count &	hint (class hint index_hint)
	Sets the index to use for this operation. More...
const stdx::optional< class hint > &	hint () const
	Gets the current hint. More...
count &	limit (std::int64_t limit)
	Sets the maximum number of documents to count. More...
const stdx::optional< std::int64_t > &	limit () const
	Gets the current limit. More...
count &	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...
count &	skip (std::int64_t skip)
	Sets the number of documents to skip before counting documents. More...
const stdx::optional< std::int64_t > &	skip () const
	Gets the current number of documents to skip. More...
count &	read_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 mongocxx::collection::count_documents.

Member Function Documentation

collation() [1/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::count::collation

(

)

const

Retrieves the current collation for this operation.

Returns

The current collation.

See also

https://docs.mongodb.com/master/reference/command/aggregate/

collation() [2/2]

count& mongocxx::options::count::collation

(

bsoncxx::document::view_or_value

collation

)

Sets the collation for this operation.

Parameters

collation

The 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/aggregate/

hint() [1/2]

const stdx::optional<class hint>& mongocxx::options::count::hint

(

)

const

Gets the current hint.

Returns

The current hint, if one is set.

See also

https://docs.mongodb.com/master/reference/command/aggregate/

hint() [2/2]

count& mongocxx::options::count::hint

(

class hint

index_hint

)

Sets the index to use for this operation.

Parameters

index_hint

Object representing the index to use.

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/aggregate/

limit() [1/2]

const stdx::optional<std::int64_t>& mongocxx::options::count::limit

(

)

const

Gets the current limit.

Returns

The current limit.

See also

https://docs.mongodb.com/master/reference/command/aggregate/

limit() [2/2]

count& mongocxx::options::count::limit

(

std::int64_t

limit

)

Sets the maximum number of documents to count.

Parameters

limit

The max number of documents to count.

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/aggregate/

max_time() [1/2]

const stdx::optional<std::chrono::milliseconds>& mongocxx::options::count::max_time

(

)

const

The current max_time setting.

Returns

The current max time (in milliseconds).

See also

https://docs.mongodb.com/master/reference/command/aggregate/

max_time() [2/2]

count& mongocxx::options::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_time

The 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/aggregate/

read_preference() [1/2]

const stdx::optional<class read_preference>& mongocxx::options::count::read_preference

(

)

const

The current read_preference for this operation.

Returns

the current read_preference

See also

https://docs.mongodb.com/master/reference/command/aggregate/

read_preference() [2/2]

count& mongocxx::options::count::read_preference

(

class read_preference

rp

)

Sets the read_preference for this operation.

Parameters

rp	The 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/aggregate/

skip() [1/2]

const stdx::optional<std::int64_t>& mongocxx::options::count::skip

(

)

const

Gets the current number of documents to skip.

Returns

The number of documents to skip.

See also

https://docs.mongodb.com/master/reference/command/aggregate/

skip() [2/2]

count& mongocxx::options::count::skip

(

std::int64_t

skip

)

Sets the number of documents to skip before counting documents.

Parameters

skip	The number of documents to skip.

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/aggregate/

---

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

• src/mongocxx/options/count.hpp