mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/AggregateFlow

AggregateFlow

class AggregateFlow<T : Any>(wrapped: AggregatePublisher<T>) : Flow<T>

Flow implementation for aggregate operations.

Parameters

T

The type of the result.

See also

Aggregation command

Constructors

constructor(wrapped: AggregatePublisher<T>)

Functions

fun allowDiskUse(allowDiskUse: Boolean?): AggregateFlow<T>

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

fun batchSize(batchSize: Int): AggregateFlow<T>

Sets the number of documents to return per batch.

bypassDocumentValidation

fun bypassDocumentValidation(bypassDocumentValidation: Boolean?): AggregateFlow<T>

Sets the bypass document level validation flag.

fun collation(collation: Collation?): AggregateFlow<T>

Sets the collation options

open suspend override fun collect(collector: FlowCollector<T>)

Requests AggregateFlow to start streaming data according to the specified aggregation pipeline.

fun comment(comment: String?): AggregateFlow<T>

fun comment(comment: BsonValue?): AggregateFlow<T>

Sets the comment for this operation. A null value means no comment is set.

@JvmName(name = "explainDocument")

suspend fun explain(verbosity: ExplainVerbosity? = null): Document

inline suspend fun <R : Any> explain(verbosity: ExplainVerbosity? = null): R

suspend fun <R : Any> explain(resultClass: Class<R>, verbosity: ExplainVerbosity? = null): R

Explain the execution plan for this operation with the given verbosity level

fun hint(hint: Bson?): AggregateFlow<T>

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

fun hintString(hint: String?): AggregateFlow<T>

Sets the hint to apply.

fun let(variables: Bson?): AggregateFlow<T>

Add top-level variables to the aggregation.

fun maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): AggregateFlow<T>

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

fun maxTime(maxTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): AggregateFlow<T>

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

@Alpha(value = [Reason.CLIENT])

fun timeoutMode(timeoutMode: TimeoutMode): AggregateFlow<T>

Sets the timeoutMode for the cursor.

suspend fun toCollection()

Aggregates documents according to the specified aggregation pipeline, which must end with an $out or $merge stage. Calling this method is the preferred alternative to consuming this AggregateFlow, because this method does what is explicitly requested without executing implicit operations.