AggregateFlow

Flow for aggregate.

3.0

Parameters

The type of the result.

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

Sets the number of documents to return per batch.

Sets the bypass document level validation flag.

abstract fun collation(collation: Collation?): AggregateFlow<TResult>

Sets the collation options

abstract suspend fun collect(collector: FlowCollector<TResult>)

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

abstract suspend fun firstOrNull(): TResult?

Helper to return first result.

abstract fun hint(hint: Bson?): AggregateFlow<TResult>

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

abstract fun maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit): AggregateFlow<TResult>

The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation.

abstract fun maxTime(maxTime: Long, timeUnit: TimeUnit): AggregateFlow<TResult>

Sets the maximum execution time on the server for this operation.

abstract suspend fun toCollection()

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