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

Modifier and Type	Method and Description
AggregatePublisher<TResult>	allowDiskUse(Boolean allowDiskUse) Enables writing to temporary files.
AggregatePublisher<TResult>	batchSize(int batchSize) Sets the number of documents to return per batch.
AggregatePublisher<TResult>	bypassDocumentValidation(Boolean bypassDocumentValidation) Sets the bypass document level validation flag.
AggregatePublisher<TResult>	collation(com.mongodb.client.model.Collation collation) Sets the collation options
AggregatePublisher<TResult>	comment(String comment) Sets the comment to the aggregation.
org.reactivestreams.Publisher<TResult>	first() Helper to return a publisher limited to the first result.
AggregatePublisher<TResult>	hint(org.bson.conversions.Bson hint) Sets the hint for which index to use.
AggregatePublisher<TResult>	maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit) The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation.
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) Deprecated. There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.

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

maxAwaitTime

AggregatePublisher<TResult> maxAwaitTime(long maxAwaitTime,
                                         TimeUnit timeUnit)

The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation. 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.6

Since server release

3.6

useCursor

@Deprecated
AggregatePublisher<TResult> useCursor(Boolean useCursor)

Deprecated. There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.

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

bypassDocumentValidation

AggregatePublisher<TResult> bypassDocumentValidation(Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Note: This only applies when an $out stage is specified

.

Parameters:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

Returns:

this

Since:

1.2

MongoDB documentation

Aggregation

Since server release

3.2

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

collation

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

AggregatePublisher<TResult> comment(String comment)

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

Parameters:

comment - the comment

Returns:

this

Since:

1.7

Since server release

3.6

hint

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

Since server release

3.6

batchSize

AggregatePublisher<TResult> batchSize(int batchSize)

Sets the number of documents to return per batch.

Overrides the Subscription.request(long) value for setting the batch size, allowing for fine grained control over the underlying cursor.

Parameters:

batchSize - the batch size

Returns:

this

Since:

1.8

MongoDB documentation

Batch Size

first

org.reactivestreams.Publisher<TResult> first()

Helper to return a publisher limited to the first result.

Returns:

a Publisher which will contain a single item.

Since:

1.8