com.mongodb.client

接口 FindIterable<TResult>

类型参数:

TResult - The type of the result.

所有超级接口:

java.lang.Iterable<TResult>, MongoIterable<TResult>

public interface FindIterable<TResult>
extends MongoIterable<TResult>

Iterable for find.

从以下版本开始:

3.0

方法概要

限定符和类型	方法和说明
FindIterable<TResult>	batchSize(int batchSize) Sets the number of documents to return per batch.
FindIterable<TResult>	cursorType(CursorType cursorType) Sets the cursor type.
FindIterable<TResult>	filter(Bson filter) Sets the query filter to apply to the query.
FindIterable<TResult>	limit(int limit) Sets the limit to apply.
FindIterable<TResult>	maxAwaitTime(long maxAwaitTime, java.util.concurrent.TimeUnit timeUnit) The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
FindIterable<TResult>	maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
FindIterable<TResult>	modifiers(Bson modifiers) Sets the query modifiers to apply to this operation.
FindIterable<TResult>	noCursorTimeout(boolean noCursorTimeout) The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
FindIterable<TResult>	oplogReplay(boolean oplogReplay) Users should not set this under normal circumstances.
FindIterable<TResult>	partial(boolean partial) Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
FindIterable<TResult>	projection(Bson projection) Sets a document describing the fields to return for all matching documents.
FindIterable<TResult>	skip(int skip) Sets the number of documents to skip.
FindIterable<TResult>	sort(Bson sort) Sets the sort criteria to apply to the query.

从接口继承的方法 com.mongodb.client.MongoIterable

first, forEach, into, iterator, map

从接口继承的方法 java.lang.Iterable

forEach, spliterator

方法详细资料

filter

FindIterable<TResult> filter(Bson filter)

Sets the query filter to apply to the query.

参数:

filter - the filter, which may be null.

返回:

this

MongoDB documentation

Filter

limit

FindIterable<TResult> limit(int limit)

Sets the limit to apply.

参数:

limit - the limit, which may be null

返回:

this

MongoDB documentation

Limit

skip

FindIterable<TResult> skip(int skip)

Sets the number of documents to skip.

参数:

skip - the number of documents to skip

返回:

this

MongoDB documentation

Skip

maxTime

FindIterable<TResult> maxTime(long maxTime,
                              java.util.concurrent.TimeUnit timeUnit)

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

参数:

maxTime - the max time

timeUnit - the time unit, which may not be null

返回:

this

MongoDB documentation

Max Time

maxAwaitTime

FindIterable<TResult> maxAwaitTime(long maxAwaitTime,
                                   java.util.concurrent.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.

参数:

maxAwaitTime - the max await time

timeUnit - the time unit to return the result in

返回:

the maximum await execution time in the given time unit

从以下版本开始:

3.2

MongoDB documentation

Max Time

modifiers

FindIterable<TResult> modifiers(Bson modifiers)

Sets the query modifiers to apply to this operation.

参数:

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

返回:

this

MongoDB documentation

Query Modifiers

projection

FindIterable<TResult> projection(Bson projection)

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

参数:

projection - the project document, which may be null.

返回:

this

MongoDB documentation

Projection

sort

FindIterable<TResult> sort(Bson sort)

Sets the sort criteria to apply to the query.

参数:

sort - the sort criteria, which may be null.

返回:

this

MongoDB documentation

Sort

noCursorTimeout

FindIterable<TResult> 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.

参数:

noCursorTimeout - true if cursor timeout is disabled

返回:

this

oplogReplay

FindIterable<TResult> oplogReplay(boolean oplogReplay)

Users should not set this under normal circumstances.

参数:

oplogReplay - if oplog replay is enabled

返回:

this

partial

FindIterable<TResult> partial(boolean partial)

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

参数:

partial - if partial results for sharded clusters is enabled

返回:

this

cursorType

FindIterable<TResult> cursorType(CursorType cursorType)

Sets the cursor type.

参数:

cursorType - the cursor type

返回:

this

batchSize

FindIterable<TResult> batchSize(int batchSize)

Sets the number of documents to return per batch.

指定者:

batchSize 在接口中 MongoIterable<TResult>

参数:

batchSize - the batch size

返回:

this

MongoDB documentation

Batch Size