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

Class representing the optional arguments to a MongoDB query. More...

#include <find.hpp>

Public Member Functions

findallow_partial_results (bool allow_partial)
 Sets whether to allow partial results from a mongos if some shards are down (instead of throwing an error). More...
 
const stdx::optional< bool > & allow_partial_results () const
 Gets the current setting for allowing partial results from mongos. More...
 
findbatch_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...
 
findcomment (bsoncxx::string::view_or_value comment)
 Attaches a comment to the query. More...
 
const stdx::optional< bsoncxx::string::view_or_value > & comment () const
 Gets the current comment attached to this query. More...
 
findcursor_type (cursor::type cursor_type)
 Indicates the type of cursor to use for this query. More...
 
const stdx::optional< cursor::type > & cursor_type () const
 Gets the current cursor type. More...
 
findhint (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...
 
findlimit (std::int32_t limit)
 Sets maximum number of documents to return. More...
 
const stdx::optional< std::int32_t > & limit () const
 Gets the current limit. More...
 
findmax_await_time (std::chrono::milliseconds max_await_time)
 The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. More...
 
const stdx::optional< std::chrono::milliseconds > & max_await_time () const
 The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. More...
 
findmax_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_ms setting. More...
 
findmodifiers (bsoncxx::document::view_or_value modifiers)
 Sets the meta-operators modifying the output or behavior of the query. More...
 
const stdx::optional< bsoncxx::document::view_or_value > & modifiers () const
 Gets the current query modifiers. More...
 
findno_cursor_timeout (bool no_cursor_timeout)
 Sets the cursor flag to prevent cursor from timing out server-side due to a period of inactivity. More...
 
const stdx::optional< bool > & no_cursor_timeout () const
 Gets the current no_cursor_timeout setting. More...
 
findprojection (bsoncxx::document::view_or_value projection)
 Sets a projection which limits the returned fields for all matching documents. More...
 
const stdx::optional< bsoncxx::document::view_or_value > & projection () const
 Gets the current projection set on this query. More...
 
findread_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...
 
findskip (std::int32_t skip)
 Sets the number of documents to skip before returning results. More...
 
const stdx::optional< std::int32_t > & skip () const
 Gets the current number of documents to skip. More...
 
findsort (bsoncxx::document::view_or_value ordering)
 The order in which to return matching documents. More...
 
const stdx::optional< bsoncxx::document::view_or_value > & sort () const
 Gets the current sort ordering for this query. More...
 

Detailed Description

Class representing the optional arguments to a MongoDB query.

Member Function Documentation

find& mongocxx::options::find::allow_partial_results ( bool  allow_partial)

Sets whether to allow partial results from a mongos if some shards are down (instead of throwing an error).

Parameters
allow_partialWhether to allow partial results from mongos.
See also
http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-query
const stdx::optional<bool>& mongocxx::options::find::allow_partial_results ( ) const

Gets the current setting for allowing partial results from mongos.

Returns
Whether partial results from mongos are allowed.
See also
http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-query
find& mongocxx::options::find::batch_size ( std::int32_t  batch_size)

Sets the number of documents to return per batch.

Parameters
batch_sizeThe size of the batches to request.
See also
http://docs.mongodb.org/manual/reference/method/cursor.batchSize/
const stdx::optional<std::int32_t>& mongocxx::options::find::batch_size ( ) const

The current batch size setting.

Returns
The current batch size.
See also
http://docs.mongodb.org/manual/reference/method/cursor.batchSize/
find& mongocxx::options::find::comment ( bsoncxx::string::view_or_value  comment)

Attaches a comment to the query.

If $comment also exists in the modifiers document then the comment field overwrites $comment.

Parameters
commentThe comment to attach to this query.
See also
http://docs.mongodb.org/manual/reference/operator/meta/comment/
const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::find::comment ( ) const

Gets the current comment attached to this query.

Returns
The comment attached to this query.
See also
http://docs.mongodb.org/manual/reference/operator/meta/comment/
find& mongocxx::options::find::cursor_type ( cursor::type  cursor_type)

Indicates the type of cursor to use for this query.

Parameters
cursor_typeThe cursor type to set.
See also
http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-query
const stdx::optional<cursor::type>& mongocxx::options::find::cursor_type ( ) const

Gets the current cursor type.

Returns
The current cursor type.
See also
http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-query
find& mongocxx::options::find::hint ( class hint  index_hint)

Sets the index to use for this operation.

See also
https://docs.mongodb.org/manual/reference/operator/meta/hint/
Note
if the server already has a cached shape for this query, it may ignore a hint.
Parameters
index_hintObject representing the index to use.
const stdx::optional<class hint>& mongocxx::options::find::hint ( ) const

Gets the current hint.

Returns
The current hint, if one is set.
find& mongocxx::options::find::limit ( std::int32_t  limit)

Sets maximum number of documents to return.

Parameters
limitThe maximum number of documents to return.
const stdx::optional<std::int32_t>& mongocxx::options::find::limit ( ) const

Gets the current limit.

Returns
The current limit.
find& mongocxx::options::find::max_await_time ( std::chrono::milliseconds  max_await_time)

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored. The default on the server is to wait for one second.

Note
On servers < 3.2, this option is ignored.
Parameters
max_await_timeThe max amount of time (in milliseconds) to wait for new documents.
See also
http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS
const stdx::optional<std::chrono::milliseconds>& mongocxx::options::find::max_await_time ( ) const

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

Returns
The current max await time (in milliseconds).
find& mongocxx::options::find::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).
See also
http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS
const stdx::optional<std::chrono::milliseconds>& mongocxx::options::find::max_time ( ) const

The current max_time_ms setting.

Returns
The current max time (in milliseconds).
See also
http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS
find& mongocxx::options::find::modifiers ( bsoncxx::document::view_or_value  modifiers)

Sets the meta-operators modifying the output or behavior of the query.

Parameters
modifiersThe query modifiers.
See also
http://docs.mongodb.org/manual/reference/operator/query-modifier/
const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::find::modifiers ( ) const

Gets the current query modifiers.

Returns
The current query modifiers.
find& mongocxx::options::find::no_cursor_timeout ( bool  no_cursor_timeout)

Sets the cursor flag to prevent cursor from timing out server-side due to a period of inactivity.

Parameters
no_cursor_timeoutWhen true prevents the cursor from timing out.
See also
http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-query
const stdx::optional<bool>& mongocxx::options::find::no_cursor_timeout ( ) const

Gets the current no_cursor_timeout setting.

Returns
The current no_cursor_timeout setting.
See also
http://docs.mongodb.org/meta-driver/latest/legacy/mongodb-wire-protocol/#op-query
find& mongocxx::options::find::projection ( bsoncxx::document::view_or_value  projection)

Sets a projection which limits the returned fields for all matching documents.

Parameters
projectionThe projection document.
See also
http://docs.mongodb.org/manual/tutorial/project-fields-from-query-results/
const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::find::projection ( ) const

Gets the current projection set on this query.

Returns
The current projection.
See also
http://docs.mongodb.org/manual/tutorial/project-fields-from-query-results/
find& mongocxx::options::find::read_preference ( class read_preference  rp)

Sets the read_preference for this operation.

Parameters
rpThe new read_preference.
See also
http://docs.mongodb.org/manual/core/read-preference/
const stdx::optional<class read_preference>& mongocxx::options::find::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/
find& mongocxx::options::find::skip ( std::int32_t  skip)

Sets the number of documents to skip before returning results.

Parameters
skipThe number of documents to skip.
See also
http://docs.mongodb.org/manual/reference/method/cursor.skip/
const stdx::optional<std::int32_t>& mongocxx::options::find::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/
find& mongocxx::options::find::sort ( bsoncxx::document::view_or_value  ordering)

The order in which to return matching documents.

If $orderby also exists in the modifiers document, the sort field takes precedence over $orderby.

Parameters
orderingDocument describing the order of the documents to be returned.
See also
http://docs.mongodb.org/manual/reference/method/cursor.sort/
const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::find::sort ( ) const

Gets the current sort ordering for this query.

Returns
The current sort ordering.
See also
http://docs.mongodb.org/manual/reference/method/cursor.sort/

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