MultiplatformMongoAggregationPipeline

interface MultiplatformMongoAggregationPipeline<Document : Any> : MongoAggregationPipeline<Document> 

An aggregation pipeline built on top of the Multiplatform driver.

To start a pipeline, call opensavvy.ktmongo.api.MongoCollection.aggregate.

External resources

• Official documentation

Properties

context

@LowLevelApi
abstract val context: BsonContext

Functions

asIterable

@LowLevelApi
abstract override fun asIterable(type: KType): MultiplatformMongoIterable<Document>

asIterable

inline fun <Document : Any> MultiplatformMongoAggregationPipeline<Document>.asIterable(): MultiplatformMongoIterable<Document>

Access the data of this pipeline as a MongoIterable.

The methods of MongoIterable are available directly on this type as extension methods, there is no need to convert to a MongoIterable yourself.

countTo

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

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

debug

abstract suspend fun debug(limit: Int): MongoAggregationPipeline.PipelineDebugReport

embedInLookup

@LowLevelApi
abstract fun embedInLookup(writer: BsonFieldWriter)

embedInUnionWith

@LowLevelApi
abstract fun embedInUnionWith(writer: BsonFieldWriter)

group

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

limit

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

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

lookup

abstract override fun <ForeignDocument : Any> lookup(block: LookupStageOperators<Document, ForeignDocument>.() -> Unit): MultiplatformMongoAggregationPipeline<Document>

match

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

matchExpr

abstract override fun matchExpr(filter: AggregationOperators.() -> Value<Document, Boolean>): MultiplatformMongoAggregationPipeline<Document>

project

abstract override fun <Out : Any> project(block: ProjectStageOperators<Document, Out>.() -> Unit): MultiplatformMongoAggregationPipeline<Out>

sample

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

set

abstract override fun <Out : Any> set(block: SetStageOperators<Document, Out>.() -> Unit): MultiplatformMongoAggregationPipeline<Out>

skip

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

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

sort

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

toString

abstract override fun toString(): String

unionWith

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

unsafeCast

@LowLevelApi
@DangerousMongoApi
abstract override fun <New : Any> unsafeCast(): MultiplatformMongoAggregationPipeline<New>

unset

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

unwind

abstract override fun <Item, Out : Any> unwind(block: UnwindStageOperators<Document, Item, Out>.() -> Unit): MultiplatformMongoAggregationPipeline<Out>

withStage

@LowLevelApi
@DangerousMongoApi
abstract override fun withStage(stage: BsonNode): MultiplatformMongoAggregationPipeline<Document>

writeTo

@LowLevelApi
abstract fun writeTo(writer: BsonValueWriter)