com.mongodb.reactivestreams.client

Interface AggregatePublisher<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

org.reactivestreams.Publisher<TResult>

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

Publisher for aggregate.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
AggregatePublisher<TResult>	allowDiskUse(Boolean allowDiskUse) Enables writing to temporary files.
AggregatePublisher<TResult>	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
org.reactivestreams.Publisher<Success>	toCollection() Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.
AggregatePublisher<TResult>	useCursor(Boolean useCursor) Sets whether the server should use a cursor to return results.

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Detail

allowDiskUse

AggregatePublisher<TResult> allowDiskUse(Boolean allowDiskUse)

Enables writing to temporary files. A null value indicates that it's unspecified.

Parameters:

allowDiskUse - true if writing to temporary files is enabled

Returns:

this

MongoDB documentation

Aggregation

Since server release

2.6

maxTime

AggregatePublisher<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

useCursor

AggregatePublisher<TResult> useCursor(Boolean useCursor)

Sets whether the server should use a cursor to return results.

Parameters:

useCursor - whether the server should use a cursor to return results

Returns:

this

MongoDB documentation

Aggregation

Since server release

2.6

toCollection

org.reactivestreams.Publisher<Success> toCollection()

Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.

Returns:

a publisher with a single element indicating when the operation has completed

MongoDB documentation

Aggregation