Package com.mongodb.client.model

Class DBCollectionFindOptions

java.lang.Object

com.mongodb.client.model.DBCollectionFindOptions

public final class DBCollectionFindOptions
extends Object

The options to apply to a find operation (also commonly referred to as a query).

Since:

3.4

MongoDB documentation

Find

OP_QUERY

Constructor Summary

Constructors

Constructor	Description
DBCollectionFindOptions()	Construct a new instance

Method Summary

Modifier and Type	Method	Description
DBCollectionFindOptions	batchSize(int batchSize)	Sets the number of documents to return per batch.
DBCollectionFindOptions	collation(Collation collation)	Sets the collation
DBCollectionFindOptions	copy()	Copy this DBCollectionFindOptions instance into a new instance.
DBCollectionFindOptions	cursorType(CursorType cursorType)	Sets the cursor type.
int	getBatchSize()	Gets the number of documents to return per batch.
Collation	getCollation()	Returns the collation options
CursorType	getCursorType()	Get the cursor type.
int	getLimit()	Gets the limit to apply.
long	getMaxAwaitTime(TimeUnit timeUnit)	The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
DBObject	getModifiers()	Gets the query modifiers to apply to this operation.
DBObject	getProjection()	Gets a document describing the fields to return for all matching documents.
ReadConcern	getReadConcern()	Returns the readConcern
ReadPreference	getReadPreference()	Returns the readPreference
int	getSkip()	Gets the number of documents to skip.
DBObject	getSort()	Gets the sort criteria to apply to the query.
boolean	isNoCursorTimeout()	The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
boolean	isOplogReplay()	Users should not set this under normal circumstances.
boolean	isPartial()	Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
DBCollectionFindOptions	limit(int limit)	Sets the limit to apply.
DBCollectionFindOptions	maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit)	Sets the maximum await execution time on the server for this operation.
DBCollectionFindOptions	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
DBCollectionFindOptions	modifiers(DBObject modifiers)	Sets the query modifiers to apply to this operation.
DBCollectionFindOptions	noCursorTimeout(boolean noCursorTimeout)	The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
DBCollectionFindOptions	oplogReplay(boolean oplogReplay)	Users should not set this under normal circumstances.
DBCollectionFindOptions	partial(boolean partial)	Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
DBCollectionFindOptions	projection(DBObject projection)	Sets a document describing the fields to return for all matching documents.
DBCollectionFindOptions	readConcern(ReadConcern readConcern)	Sets the readConcern
DBCollectionFindOptions	readPreference(ReadPreference readPreference)	Sets the readPreference
DBCollectionFindOptions	skip(int skip)	Sets the number of documents to skip.
DBCollectionFindOptions	sort(DBObject sort)	Sets the sort criteria to apply to the query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBCollectionFindOptions

public DBCollectionFindOptions()

Construct a new instance

Method Detail

copy

public DBCollectionFindOptions copy()

Copy this DBCollectionFindOptions instance into a new instance.

Returns:

the new DBCollectionFindOptions with the same settings as this instance.

getLimit

public int getLimit()

Gets the limit to apply. The default is null.

Returns:

the limit

MongoDB documentation

Limit

limit

public DBCollectionFindOptions limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit, which may be null

Returns:

this

MongoDB documentation

Limit

getSkip

public int getSkip()

Gets the number of documents to skip. The default is 0.

Returns:

the number of documents to skip, which may be null

MongoDB documentation

Skip

skip

public DBCollectionFindOptions skip(int skip)

Sets the number of documents to skip.

Parameters:

skip - the number of documents to skip

Returns:

this

MongoDB documentation

Skip

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

MongoDB documentation

Max Time

maxTime

public DBCollectionFindOptions maxTime(long maxTime,
                                       TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

MongoDB documentation

Max Time

getMaxAwaitTime

public long getMaxAwaitTime(TimeUnit timeUnit)

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. On servers >= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default is no value: no "maxTimeMS" is sent to the server with the getMore command. On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value A zero value will be ignored.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum await execution time in the given time unit

MongoDB documentation

Max Time

maxAwaitTime

public DBCollectionFindOptions maxAwaitTime(long maxAwaitTime,
                                            TimeUnit timeUnit)

Sets the maximum await execution time on the server for this operation.

Parameters:

maxAwaitTime - the max await time. A zero value will be ignored, and indicates that the driver should respect the server's default value

timeUnit - the time unit, which may not be null

Returns:

this

MongoDB documentation

Max Time

getBatchSize

public int getBatchSize()

Gets the number of documents to return per batch. Default to 0, which indicates that the server chooses an appropriate batch size.

Returns:

the batch size, which may be null

MongoDB documentation

Batch Size

batchSize

public DBCollectionFindOptions batchSize(int batchSize)

Sets the number of documents to return per batch.

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

getModifiers

public DBObject getModifiers()

Gets the query modifiers to apply to this operation. The default is not to apply any modifiers.

Returns:

the query modifiers, which may be null

MongoDB documentation

Query Modifiers

modifiers

public DBCollectionFindOptions modifiers(@Nullable
                                         DBObject modifiers)

Sets the query modifiers to apply to this operation.

Parameters:

modifiers - the query modifiers to apply, which may be null.

Returns:

this

MongoDB documentation

Query Modifiers

getProjection

@Nullable
public DBObject getProjection()

Gets a document describing the fields to return for all matching documents.

Returns:

the project document, which may be null

MongoDB documentation

Projection

projection

public DBCollectionFindOptions projection(@Nullable
                                          DBObject projection)

Sets a document describing the fields to return for all matching documents.

Parameters:

projection - the project document, which may be null.

Returns:

this

MongoDB documentation

Projection

getSort

@Nullable
public DBObject getSort()

Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.

Returns:

a document describing the sort criteria

MongoDB documentation

Sort

sort

public DBCollectionFindOptions sort(@Nullable
                                    DBObject sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

isNoCursorTimeout

public boolean isNoCursorTimeout()

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. If true, that timeout is disabled.

Returns:

true if cursor timeout is disabled

noCursorTimeout

public DBCollectionFindOptions noCursorTimeout(boolean noCursorTimeout)

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

Parameters:

noCursorTimeout - true if cursor timeout is disabled

Returns:

this

isOplogReplay

public boolean isOplogReplay()

Users should not set this under normal circumstances.

Returns:

if oplog replay is enabled

oplogReplay

public DBCollectionFindOptions oplogReplay(boolean oplogReplay)

Users should not set this under normal circumstances.

Parameters:

oplogReplay - if oplog replay is enabled

Returns:

this

isPartial

public boolean isPartial()

Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).

Returns:

if partial results for sharded clusters is enabled

partial

public DBCollectionFindOptions partial(boolean partial)

Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).

Parameters:

partial - if partial results for sharded clusters is enabled

Returns:

this

getCursorType

public CursorType getCursorType()

Get the cursor type.

Returns:

the cursor type

cursorType

public DBCollectionFindOptions cursorType(CursorType cursorType)

Sets the cursor type.

Parameters:

cursorType - the cursor type

Returns:

this

getReadPreference

@Nullable
public ReadPreference getReadPreference()

Returns the readPreference

Returns:

the readPreference

readPreference

public DBCollectionFindOptions readPreference(@Nullable
                                              ReadPreference readPreference)

Sets the readPreference

Parameters:

readPreference - the readPreference

Returns:

this

getReadConcern

@Nullable
public ReadConcern getReadConcern()

Returns the readConcern

Returns:

the readConcern

Since server release

3.2

readConcern

public DBCollectionFindOptions readConcern(@Nullable
                                           ReadConcern readConcern)

Sets the readConcern

Parameters:

readConcern - the readConcern

Returns:

this

Since server release

3.2

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since server release

3.4

collation

public DBCollectionFindOptions collation(@Nullable
                                         Collation collation)

Sets the collation

Parameters:

collation - the collation

Returns:

this

Since server release

3.4