MongoDB C++ Driver  mongocxx-3.4.0
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...
 
findcollation (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...
 
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::int64_t limit)
 Sets maximum number of documents to return. More...
 
const stdx::optional< std::int64_t > & limit () const
 Gets the current limit. More...
 
findmax (bsoncxx::document::view_or_value max)
 Gets the current exclusive upper bound for a specific index. More...
 
const stdx::optional< bsoncxx::document::view_or_value > & max () const
 Sets the current exclusive upper bound for a specific index. 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...
 
MONGOCXX_DEPRECATED findmax_scan (std::int64_t max)
 Sets the maximum number of documents or index keys to scan when executing the query. More...
 
MONGOCXX_DEPRECATED const stdx::optional< std::int64_t > & max_scan () const
 Gets the current setting for the maximum number of documents to scan when executing the 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...
 
findmin (bsoncxx::document::view_or_value min)
 Gets the current inclusive lower bound for a specific index. More...
 
const stdx::optional< bsoncxx::document::view_or_value > & min () const
 Sets the current inclusive lower bound for a specific index. More...
 
MONGOCXX_DEPRECATED findmodifiers (bsoncxx::document::view_or_value modifiers)
 Sets the meta-operators modifying the output or behavior of the query. More...
 
MONGOCXX_DEPRECATED 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...
 
findreturn_key (bool return_key)
 Sets whether to return the index keys associated with the query results, instead of the actual query results themselves. More...
 
const stdx::optional< bool > & return_key () const
 Gets the current setting for returning the index keys associated with the query results, instead of the actual query results themselves. More...
 
findshow_record_id (bool show_record_id)
 Sets whether to include the record identifier for each document in the query results. More...
 
const stdx::optional< bool > & show_record_id () const
 Gets the current setting for whether the record identifier is returned for each document in the query results. More...
 
findskip (std::int64_t skip)
 Sets the number of documents to skip before returning results. More...
 
const stdx::optional< std::int64_t > & skip () const
 Gets the current number of documents to skip. More...
 
MONGOCXX_DEPRECATED findsnapshot (bool snapshot)
 Sets whether snapshot mode should be used. More...
 
MONGOCXX_DEPRECATED const stdx::optional< bool > & snapshot () const
 Gets the current setting for whether snapshot mode is being used. 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...
 
MONGOCXX_PRIVATE findmodifiers_clear ()
 Clears the modifiers member. More...
 

Detailed Description

Class representing the optional arguments to a MongoDB query.

Examples:
examples/mongocxx/client_session.cpp.

Member Function Documentation

◆ allow_partial_results() [1/2]

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.
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/find/

◆ allow_partial_results() [2/2]

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
https://docs.mongodb.com/master/reference/command/find/

◆ batch_size() [1/2]

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.
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/find/

◆ batch_size() [2/2]

const stdx::optional<std::int32_t>& mongocxx::options::find::batch_size ( ) const

The current batch size setting.

Returns
The current batch size.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ collation() [1/2]

find& mongocxx::options::find::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/find/

◆ collation() [2/2]

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

Retrieves the current collation for this operation.

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

◆ comment() [1/2]

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.
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/find/

◆ comment() [2/2]

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
https://docs.mongodb.com/master/reference/command/find/

◆ cursor_type() [1/2]

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.
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/find/

◆ cursor_type() [2/2]

const stdx::optional<cursor::type>& mongocxx::options::find::cursor_type ( ) const

Gets the current cursor type.

Returns
The current cursor type.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ hint() [1/2]

find& mongocxx::options::find::hint ( class hint  index_hint)

Sets the index to use for this operation.

See also
https://docs.mongodb.com/master/reference/command/find/
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.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ hint() [2/2]

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

Gets the current hint.

Returns
The current hint, if one is set.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ limit() [1/2]

find& mongocxx::options::find::limit ( std::int64_t  limit)

Sets maximum number of documents to return.

Parameters
limitThe maximum number of documents to return.
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/find/

◆ limit() [2/2]

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

Gets the current limit.

Returns
The current limit.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ max() [1/2]

find& mongocxx::options::find::max ( bsoncxx::document::view_or_value  max)

Gets the current exclusive upper bound for a specific index.

Parameters
maxThe exclusive upper bound for a specific index.
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/find/

◆ max() [2/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::find::max ( ) const

Sets the current exclusive upper bound for a specific index.

Returns
The exclusive upper bound for a specific index.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ max_await_time() [1/2]

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.
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/find/

◆ max_await_time() [2/2]

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).
See also
https://docs.mongodb.com/master/reference/command/find/

◆ max_scan() [1/2]

MONGOCXX_DEPRECATED find& mongocxx::options::find::max_scan ( std::int64_t  max)

Sets the maximum number of documents or index keys to scan when executing the query.

Deprecated:
This method is deprecated.
Parameters
maxThe maximum number of documents or index keys to scan.
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/find/

◆ max_scan() [2/2]

MONGOCXX_DEPRECATED const stdx::optional<std::int64_t>& mongocxx::options::find::max_scan ( ) const

Gets the current setting for the maximum number of documents to scan when executing the query.

Deprecated:
This method is deprecated.
Returns
The current setting for the maximum number of documents or index keys to scan.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ max_time() [1/2]

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).
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/find/
Examples:
examples/mongocxx/client_session.cpp.

◆ max_time() [2/2]

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
https://docs.mongodb.com/master/reference/command/find/

◆ min() [1/2]

find& mongocxx::options::find::min ( bsoncxx::document::view_or_value  min)

Gets the current inclusive lower bound for a specific index.

Parameters
minThe inclusive lower bound for a specific index.
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/find/

◆ min() [2/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::find::min ( ) const

Sets the current inclusive lower bound for a specific index.

Returns
The inclusive lower bound for a specific index.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ modifiers() [1/2]

MONGOCXX_DEPRECATED 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.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
Deprecated:
The modifiers option has been deprecated, and has been replaced by new top-level options that have been introduced. For example, users should call find::snapshot() instead of calling find::modifiers() with a document containing a "$snapshot" field.
See also
https://docs.mongodb.com/master/reference/operator/query-modifier/

◆ modifiers() [2/2]

MONGOCXX_DEPRECATED const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::find::modifiers ( ) const

Gets the current query modifiers.

Returns
The current query modifiers.
Deprecated:
The modifiers option has been deprecated, and has been replaced by new top-level options that have been introduced. For example, users should call find::snapshot() instead of calling find::modifiers() with a document containing a "$snapshot" field.

◆ modifiers_clear()

MONGOCXX_PRIVATE find& mongocxx::options::find::modifiers_clear ( )

Clears the modifiers member.

Internal-only.

◆ no_cursor_timeout() [1/2]

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.
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/find/

◆ no_cursor_timeout() [2/2]

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
https://docs.mongodb.com/master/reference/command/find/

◆ projection() [1/2]

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.
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/find/

◆ projection() [2/2]

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
https://docs.mongodb.com/master/reference/command/find/

◆ read_preference() [1/2]

find& mongocxx::options::find::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/find/
Examples:
examples/mongocxx/client_session.cpp.

◆ read_preference() [2/2]

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
https://docs.mongodb.com/master/reference/command/find/

◆ return_key() [1/2]

find& mongocxx::options::find::return_key ( bool  return_key)

Sets whether to return the index keys associated with the query results, instead of the actual query results themselves.

Parameters
return_keyWhether to return the index keys associated with the query results, instead of the actual query results themselves.
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/find/

◆ return_key() [2/2]

const stdx::optional<bool>& mongocxx::options::find::return_key ( ) const

Gets the current setting for returning the index keys associated with the query results, instead of the actual query results themselves.

Returns
Whether index keys associated with the query results are returned, instead of the actual query results themselves.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ show_record_id() [1/2]

find& mongocxx::options::find::show_record_id ( bool  show_record_id)

Sets whether to include the record identifier for each document in the query results.

Parameters
show_record_idWhether to include the record identifier.
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/find/

◆ show_record_id() [2/2]

const stdx::optional<bool>& mongocxx::options::find::show_record_id ( ) const

Gets the current setting for whether the record identifier is returned for each document in the query results.

Returns
Whether the record identifier is included.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ skip() [1/2]

find& mongocxx::options::find::skip ( std::int64_t  skip)

Sets the number of documents to skip before returning results.

Parameters
skipThe 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/find/

◆ skip() [2/2]

const stdx::optional<std::int64_t>& mongocxx::options::find::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/find/

◆ snapshot() [1/2]

MONGOCXX_DEPRECATED find& mongocxx::options::find::snapshot ( bool  snapshot)

Sets whether snapshot mode should be used.

Deprecated:
This method is deprecated.
Parameters
snapshotWhether to enable snapshot mode.
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/find/

◆ snapshot() [2/2]

MONGOCXX_DEPRECATED const stdx::optional<bool>& mongocxx::options::find::snapshot ( ) const

Gets the current setting for whether snapshot mode is being used.

Deprecated:
This method is deprecated.
Returns
Whether snapshot mode is being used.
See also
https://docs.mongodb.com/master/reference/command/find/

◆ sort() [1/2]

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.
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/find/

◆ sort() [2/2]

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
https://docs.mongodb.com/master/reference/command/find/

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