com.mongodb.reactivestreams.client

Interface FindPublisher<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

org.reactivestreams.Publisher<TResult>

public interface FindPublisher<TResult>
extends org.reactivestreams.Publisher<TResult>

Publisher interface for find.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
FindPublisher<TResult>	collation(com.mongodb.client.model.Collation collation) Sets the collation options
FindPublisher<TResult>	comment(String comment) Sets the comment to the query.
FindPublisher<TResult>	cursorType(com.mongodb.CursorType cursorType) Sets the cursor type.
FindPublisher<TResult>	filter(org.bson.conversions.Bson filter) Sets the query filter to apply to the query.
org.reactivestreams.Publisher<TResult>	first() Helper to return a publisher limited first from the query.
FindPublisher<TResult>	hint(org.bson.conversions.Bson hint) Sets the hint for which index to use.
FindPublisher<TResult>	limit(int limit) Sets the limit to apply.
FindPublisher<TResult>	max(org.bson.conversions.Bson max) Sets the exclusive upper bound for a specific index.
FindPublisher<TResult>	maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit) The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
FindPublisher<TResult>	maxScan(long maxScan) Sets the maximum number of documents or index keys to scan when executing the query.
FindPublisher<TResult>	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
FindPublisher<TResult>	min(org.bson.conversions.Bson min) Sets the minimum inclusive lower bound for a specific index.
FindPublisher<TResult>	modifiers(org.bson.conversions.Bson modifiers) Deprecated. use the individual setters instead
FindPublisher<TResult>	noCursorTimeout(boolean noCursorTimeout) The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
FindPublisher<TResult>	oplogReplay(boolean oplogReplay) Users should not set this under normal circumstances.
FindPublisher<TResult>	partial(boolean partial) Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
FindPublisher<TResult>	projection(org.bson.conversions.Bson projection) Sets a document describing the fields to return for all matching documents.
FindPublisher<TResult>	returnKey(boolean returnKey) Sets the returnKey.
FindPublisher<TResult>	showRecordId(boolean showRecordId) Sets the showRecordId.
FindPublisher<TResult>	skip(int skip) Sets the number of documents to skip.
FindPublisher<TResult>	snapshot(boolean snapshot) Sets the snapshot.
FindPublisher<TResult>	sort(org.bson.conversions.Bson sort) Sets the sort criteria to apply to the query.

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Detail

first

org.reactivestreams.Publisher<TResult> first()

Helper to return a publisher limited first from the query.

Returns:

a Publisher which will

filter

FindPublisher<TResult> filter(org.bson.conversions.Bson filter)

Sets the query filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

MongoDB documentation

Filter

limit

FindPublisher<TResult> limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit, which may be null

Returns:

this

MongoDB documentation

Limit

skip

FindPublisher<TResult> skip(int skip)

Sets the number of documents to skip.

Parameters:

skip - the number of documents to skip

Returns:

this

MongoDB documentation

Skip

maxTime

FindPublisher<TResult> 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

maxAwaitTime

FindPublisher<TResult> maxAwaitTime(long maxAwaitTime,
                                  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:

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:

1.2

MongoDB documentation

Max Time

modifiers

@Deprecated
FindPublisher<TResult> modifiers(org.bson.conversions.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

FindPublisher<TResult> projection(org.bson.conversions.Bson 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

FindPublisher<TResult> sort(org.bson.conversions.Bson 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

FindPublisher<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.

Parameters:

noCursorTimeout - true if cursor timeout is disabled

Returns:

this

oplogReplay

FindPublisher<TResult> oplogReplay(boolean oplogReplay)

Users should not set this under normal circumstances.

Parameters:

oplogReplay - if oplog replay is enabled

Returns:

this

partial

FindPublisher<TResult> 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

FindPublisher<TResult> cursorType(com.mongodb.CursorType cursorType)

Sets the cursor type.

Parameters:

cursorType - the cursor type

Returns:

this

collation

FindPublisher<TResult> collation(com.mongodb.client.model.Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

1.3

Since server release

3.4

comment

FindPublisher<TResult> comment(String comment)

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

Parameters:

comment - the comment

Returns:

this

Since:

1.6

hint

FindPublisher<TResult> hint(org.bson.conversions.Bson hint)

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

Parameters:

hint - the hint

Returns:

this

Since:

1.6

max

FindPublisher<TResult> max(org.bson.conversions.Bson max)

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

Parameters:

max - the max

Returns:

this

Since:

1.6

min

FindPublisher<TResult> min(org.bson.conversions.Bson min)

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:

1.6

maxScan

FindPublisher<TResult> maxScan(long maxScan)

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:

1.6

returnKey

FindPublisher<TResult> returnKey(boolean returnKey)

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:

1.6

showRecordId

FindPublisher<TResult> showRecordId(boolean showRecordId)

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

Parameters:

showRecordId - the showRecordId

Returns:

this

Since:

1.6

snapshot

FindPublisher<TResult> snapshot(boolean snapshot)

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:

1.6