com.mongodb.client

Interface FindFluent<T>

Type Parameters:

T - The type of the result.

All Superinterfaces:

Iterable<T>, MongoIterable<T>

public interface FindFluent<T>
extends MongoIterable<T>

Fluent interface for find.

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
FindFluent<T>	batchSize(int batchSize) Sets the number of documents to return per batch.
FindFluent<T>	cursorType(CursorType cursorType) Sets the cursor type.
FindFluent<T>	filter(Object filter) Sets the query filter to apply to the query.
FindFluent<T>	limit(int limit) Sets the limit to apply.
FindFluent<T>	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
FindFluent<T>	modifiers(Object modifiers) Sets the query modifiers to apply to this operation.
FindFluent<T>	noCursorTimeout(boolean noCursorTimeout) The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
FindFluent<T>	oplogReplay(boolean oplogReplay) Users should not set this under normal circumstances.
FindFluent<T>	partial(boolean partial) Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
FindFluent<T>	projection(Object projection) Sets a document describing the fields to return for all matching documents.
FindFluent<T>	skip(int skip) Sets the number of documents to skip.
FindFluent<T>	sort(Object sort) Sets the sort criteria to apply to the query.

Methods inherited from interface com.mongodb.client.MongoIterable

first, forEach, into, iterator, map

Method Detail

filter

FindFluent<T> filter(Object filter)

Sets the query filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

MongoDB documentation

Filter

limit

FindFluent<T> limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit, which may be null

Returns:

this

MongoDB documentation

Limit

skip

FindFluent<T> skip(int skip)

Sets the number of documents to skip.

Parameters:

skip - the number of documents to skip

Returns:

this

MongoDB documentation

Skip

maxTime

FindFluent<T> 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

batchSize

FindFluent<T> batchSize(int batchSize)

Sets the number of documents to return per batch.

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

modifiers

FindFluent<T> modifiers(Object 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

projection

FindFluent<T> projection(Object 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

sort

FindFluent<T> sort(Object sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

noCursorTimeout

FindFluent<T> 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

oplogReplay

FindFluent<T> oplogReplay(boolean oplogReplay)

Users should not set this under normal circumstances.

Parameters:

oplogReplay - if oplog replay is enabled

Returns:

this

partial

FindFluent<T> 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

cursorType

FindFluent<T> cursorType(CursorType cursorType)

Sets the cursor type.

Parameters:

cursorType - the cursor type

Returns:

this