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

#include <count.hpp>

Public Member Functions
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 a MongoDB count command.

Member Function Documentation

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.

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

Gets the current hint.

Returns: The current hint, if one is set.

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.

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

Gets the current limit.

Returns: The current limit.

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).

See also: http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS

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: http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS

count& mongocxx::options::count::read_preference ( class read_preference rp )

Sets the read_preference for this operation.

Parameters

rp	The new read_preference.

See also: http://docs.mongodb.org/manual/core/read-preference/

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: http://docs.mongodb.org/manual/core/read-preference/

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.

See also: http://docs.mongodb.org/manual/reference/method/cursor.skip/

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: http://docs.mongodb.org/manual/reference/method/cursor.skip/

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

src/mongocxx/options/count.hpp

Public Member Functions

Detailed Description

Member Function Documentation