KtMongo: MongoDB driver for Kotlin • API/opensavvy.ktmongo.api/MongoAggregationPipeline

MongoAggregationPipeline

interface MongoAggregationPipeline<Document : Any> : AggregationPipeline<Document> (source)

A multi-stage aggregation pipeline that transforms documents from a MongoDB collection.

Pipelines are immutable. Each stage method returns a new pipeline with the stage appended.

To obtain a pipeline, use MongoCollection.aggregate.

Example

class User(
    val name: String,
    val age: Int,
)

users.aggregate()
    .match { User::age gt 18 }
    .sort { ascending(User::name) }
    .toList()

External resources

Official documentation

Properties

context

@LowLevelApi

abstract val context: BsonContext

Functions

asFlow

inline fun <Document : Any> MongoAggregationPipeline<Document>.asFlow(): Flow<Document>

Streams the results into a Flow.

asIterable

@LowLevelApi

abstract fun asIterable(type: KType): MongoIterable<Document>

Access the data of this pipeline as a MongoIterable.

countTo

abstract override fun <Out : Any> countTo(field: KProperty1<Out, Number>): MongoAggregationPipeline<Out>

abstract override fun <Out : Any> countTo(field: Field<Out, Number>): MongoAggregationPipeline<Out>

embedInLookup

@LowLevelApi

abstract fun embedInLookup(writer: BsonFieldWriter)

embedInUnionWith

@LowLevelApi

abstract fun embedInUnionWith(writer: BsonFieldWriter)

first

inline suspend fun <Document : Any> MongoAggregationPipeline<Document>.first(): Document

Returns the first document found by this query, or throws an exception.

firstOrNull

inline suspend fun <Document : Any> MongoAggregationPipeline<Document>.firstOrNull(): Document?

Returns the first document found by this query, or returns null.

forEach

inline suspend fun <Document : Any> MongoAggregationPipeline<Document>.forEach(noinline action: suspend (Document) -> Unit)

Executes action for each document returned by this query.

group

abstract override fun <Out : Any> group(block: GroupStageOperators<Document, Out>.() -> Unit): MongoAggregationPipeline<Out>

limit

abstract override fun limit(amount: Int): MongoAggregationPipeline<Document>

abstract override fun limit(amount: Long): MongoAggregationPipeline<Document>

lookup

open fun <ForeignDocument : Any> lookup(block: LookupStageOperators<Document, ForeignDocument>.() -> Unit): Pipeline<Document>

match

abstract override fun match(filter: FilterQuery<Document>.() -> Unit): MongoAggregationPipeline<Document>

matchExpr

open fun matchExpr(filter: AggregationOperators.() -> Value<Document, Boolean>): Pipeline<Document>

project

abstract override fun project(block: ProjectStageOperators<Document>.() -> Unit): MongoAggregationPipeline<Document>

reinterpret

@DangerousMongoApi

@LowLevelApi

abstract fun <New : Any> reinterpret(): Pipeline<New>

sample

abstract override fun sample(size: Int): MongoAggregationPipeline<Document>

set

abstract override fun set(block: SetStageOperators<Document>.() -> Unit): MongoAggregationPipeline<Document>

skip

abstract override fun skip(amount: Int): MongoAggregationPipeline<Document>

abstract override fun skip(amount: Long): MongoAggregationPipeline<Document>

sort

abstract override fun sort(block: SortOptionDsl<Document>.() -> Unit): MongoAggregationPipeline<Document>

toList

inline suspend fun <Document : Any> MongoAggregationPipeline<Document>.toList(): List<Document>

Reads the entirety of this iterable into a List.

toSet

inline suspend fun <Document : Any> MongoAggregationPipeline<Document>.toSet(): Set<Document>

Reads the entirety of this iterable into a Set.

toString

abstract override fun toString(): String

unionWith

abstract override fun unionWith(other: HasUnionWithCompatibility<Document>): MongoAggregationPipeline<Document>

unset

abstract override fun unset(block: UnsetStageOperators<Document>.() -> Unit): MongoAggregationPipeline<Document>

withStage

@DangerousMongoApi

@LowLevelApi

abstract fun withStage(stage: BsonNode): Pipeline<Document>

writeTo

@LowLevelApi

abstract fun writeTo(writer: BsonValueWriter)