Package com.mongodb.async.client

Interface FindIterable<T>

Type Parameters:

T - The type of the result.

All Superinterfaces:

MongoIterable<T>

@Deprecated
public interface FindIterable<T>
extends MongoIterable<T>

Deprecated.

Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)

Iterable for find.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
FindIterable<T>	batchSize(int batchSize)	Deprecated. Sets the number of documents to return per batch.
FindIterable<T>	collation(Collation collation)	Deprecated. Sets the collation options
FindIterable<T>	comment(String comment)	Deprecated. Sets the comment to the query.
FindIterable<T>	cursorType(CursorType cursorType)	Deprecated. Sets the cursor type.
FindIterable<T>	filter(Bson filter)	Deprecated. Sets the query filter to apply to the query.
FindIterable<T>	hint(Bson hint)	Deprecated. Sets the hint for which index to use.
FindIterable<T>	hintString(String hint)	Deprecated. Sets the hint to apply.
FindIterable<T>	limit(int limit)	Deprecated. Sets the limit to apply.
FindIterable<T>	max(Bson max)	Deprecated. Sets the exclusive upper bound for a specific index.
FindIterable<T>	maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit)	Deprecated. The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
FindIterable<T>	maxScan(long maxScan)	Deprecated. Deprecated as of MongoDB 4.0 release
FindIterable<T>	maxTime(long maxTime, TimeUnit timeUnit)	Deprecated. Sets the maximum execution time on the server for this operation.
FindIterable<T>	min(Bson min)	Deprecated. Sets the minimum inclusive lower bound for a specific index.
FindIterable<T>	modifiers(Bson modifiers)	Deprecated. use the individual setters instead
FindIterable<T>	noCursorTimeout(boolean noCursorTimeout)	Deprecated. The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
FindIterable<T>	oplogReplay(boolean oplogReplay)	Deprecated. Users should not set this under normal circumstances.
FindIterable<T>	partial(boolean partial)	Deprecated. Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
FindIterable<T>	projection(Bson projection)	Deprecated. Sets a document describing the fields to return for all matching documents.
FindIterable<T>	returnKey(boolean returnKey)	Deprecated. Sets the returnKey.
FindIterable<T>	showRecordId(boolean showRecordId)	Deprecated. Sets the showRecordId.
FindIterable<T>	skip(int skip)	Deprecated. Sets the number of documents to skip.
FindIterable<T>	snapshot(boolean snapshot)	Deprecated. Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
FindIterable<T>	sort(Bson sort)	Deprecated. Sets the sort criteria to apply to the query.

Methods inherited from interface com.mongodb.async.client.MongoIterable

batchCursor, first, forEach, getBatchSize, into, map

Method Detail

filter

FindIterable<T> filter(@Nullable
                       Bson filter)

Deprecated.

Sets the query filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

MongoDB documentation

Filter

limit

FindIterable<T> limit(int limit)

Deprecated.

Sets the limit to apply.

Parameters:

limit - the limit, which may be null

Returns:

this

MongoDB documentation

Limit

skip

FindIterable<T> skip(int skip)

Deprecated.

Sets the number of documents to skip.

Parameters:

skip - the number of documents to skip

Returns:

this

MongoDB documentation

Skip

maxTime

FindIterable<T> maxTime(long maxTime,
                        TimeUnit timeUnit)

Deprecated.

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

maxAwaitTime

FindIterable<T> maxAwaitTime(long maxAwaitTime,
                             TimeUnit timeUnit)

Deprecated.

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:

maxAwaitTime - the max await time

timeUnit - the time unit to return the result in

Returns:

the maximum await execution time in the given time unit

Since:

3.2

MongoDB documentation

Max Time

modifiers

@Deprecated
FindIterable<T> modifiers(@Nullable
                          Bson modifiers)

Deprecated.

use the individual setters instead

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

FindIterable<T> projection(@Nullable
                           Bson projection)

Deprecated.

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

FindIterable<T> sort(@Nullable
                     Bson sort)

Deprecated.

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

noCursorTimeout

FindIterable<T> noCursorTimeout(boolean noCursorTimeout)

Deprecated.

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

FindIterable<T> oplogReplay(boolean oplogReplay)

Deprecated.

Users should not set this under normal circumstances.

Parameters:

oplogReplay - if oplog replay is enabled

Returns:

this

partial

FindIterable<T> partial(boolean partial)

Deprecated.

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

FindIterable<T> cursorType(CursorType cursorType)

Deprecated.

Sets the cursor type.

Parameters:

cursorType - the cursor type

Returns:

this

batchSize

FindIterable<T> batchSize(int batchSize)

Deprecated.

Sets the number of documents to return per batch.

Specified by:

batchSize in interface MongoIterable<T>

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

collation

FindIterable<T> collation(@Nullable
                          Collation collation)

Deprecated.

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

3.4

Since server release

3.4

comment

FindIterable<T> comment(@Nullable
                        String comment)

Deprecated.

Sets the comment to the query. A null value means no comment is set.

Parameters:

comment - the comment

Returns:

this

Since:

3.5

hint

FindIterable<T> hint(@Nullable
                     Bson hint)

Deprecated.

Sets the hint for which index to use. A null value means no hint is set.

Parameters:

hint - the hint

Returns:

this

Since:

3.5

hintString

FindIterable<T> hintString(@Nullable
                           String hint)

Deprecated.

Sets the hint to apply.

Note: If hint(Bson) is set that will be used instead of any hint string.

Parameters:

hint - the name of the index which should be used for the operation

Returns:

this

Since:

3.12

max

FindIterable<T> max(@Nullable
                    Bson max)

Deprecated.

Sets the exclusive upper bound for a specific index. A null value means no max is set.

Parameters:

max - the max

Returns:

this

Since:

3.5

min

FindIterable<T> min(@Nullable
                    Bson min)

Deprecated.

Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.

Parameters:

min - the min

Returns:

this

Since:

3.5

maxScan

@Deprecated
FindIterable<T> maxScan(long maxScan)

Deprecated.

Deprecated as of MongoDB 4.0 release

Sets the maximum number of documents or index keys to scan when executing the query. A zero value or less will be ignored, and indicates that the driver should respect the server's default value.

Parameters:

maxScan - the maxScan

Returns:

this

Since:

3.5

returnKey

FindIterable<T> returnKey(boolean returnKey)

Deprecated.

Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.

Parameters:

returnKey - the returnKey

Returns:

this

Since:

3.5

showRecordId

FindIterable<T> showRecordId(boolean showRecordId)

Deprecated.

Sets the showRecordId. Set to true to add a field $recordId to the returned documents.

Parameters:

showRecordId - the showRecordId

Returns:

this

Since:

3.5

snapshot

@Deprecated
FindIterable<T> snapshot(boolean snapshot)

Deprecated.

Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release

Sets the snapshot. If true it prevents the cursor from returning a document more than once because of an intervening write operation.

Parameters:

snapshot - the snapshot

Returns:

this

Since:

3.5