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>	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>	limit(int limit) Sets the limit to apply.
FindPublisher<TResult>	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
FindPublisher<TResult>	modifiers(org.bson.conversions.Bson modifiers) Sets the query modifiers to apply to this operation.
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>	skip(int skip) Sets the number of documents to skip.
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

modifiers

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

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