mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/AggregateIterable

AggregateIterable

class AggregateIterable<T : Any>(wrapped: AggregateIterable<T>) : MongoIterable<T>

Iterable like implementation for aggregate operations.

Parameters

T

The type of the result.

See also

Aggregation command

Constructors

AggregateIterable

constructor(wrapped: AggregateIterable<T>)

Functions

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

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

open override fun batchSize(batchSize: Int): AggregateIterable<T>

Sets the number of documents to return per batch.

bypassDocumentValidation

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

Sets the bypass document level validation flag.

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

Sets the collation options

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

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

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

open override fun cursor(): MongoCursor<T>

Aggregates documents according to the specified aggregation pipeline.

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

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

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

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

fun first(): T

fun firstOrNull(): T?

fun forEach(action: (T) -> Unit)

Performs the given action on each element and safely closes the cursor.

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

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

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

Sets the hint to apply.

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

Add top-level variables to the aggregation.

fun <R> map(transform: (T) -> R): MongoIterable<R>

Maps this iterable from the source document type to the target document type.

fun maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): AggregateIterable<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): AggregateIterable<T>

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

@Alpha(value = [Reason.CLIENT])

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

Sets the timeoutMode for the cursor.

fun toCollection()

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

fun <C : MutableCollection<in T>> toCollection(destination: C): C

Appends all elements to the given destination collection.

fun toList(): List<T>

fun <R> use(consumer: (Sequence<T>) -> R): R

Creates a new cursor and treats it as a Sequence, invokes the given consumer function and closes the cursor down correctly whether an exception is thrown or not.