Konduct/io.github.denofbits.konduct.core/AggregationPipeline

AggregationPipeline

interface AggregationPipeline<T : Any>

Fluent interface for building MongoDB aggregation pipelines.

Each operation returns a new pipeline instance (immutable pattern).

Inheritors

AggregationPipelineImpl

Functions

addFields

abstract fun addFields(block: AddFieldsBuilder<T>.() -> Unit): AggregationPipeline<T>

Performs add fields operations

count

abstract fun count(): Long

Execute pipeline and return count of matching documents.

customStage

abstract fun customStage(stageName: String, block: CustomStageBuilder.() -> Unit): AggregationPipeline<T>

For building custom stages

facet

abstract fun <R : Any> facet(resultType: KClass<R>, block: FacetBuilder<T>.() -> Unit): AggregationPipeline<R>

firstOrNull

abstract fun firstOrNull(): T?

Execute pipeline and return first result or null.

group

abstract fun group(block: GroupBuilder<T>.() -> Unit): AggregationPipeline<Document>

abstract fun <R : Any> group(resultType: KClass<R>, block: GroupBuilder<T>.() -> Unit): AggregationPipeline<R>

Perform grouping operations in pipeline

into

abstract fun <R : Any> into(resultType: KClass<R>): AggregationPipeline<R>

limit

abstract fun limit(count: Int): AggregationPipeline<T>

Limit to N documents ($limit stage).

match

abstract fun match(block: MatchBuilder<T>.() -> Unit): AggregationPipeline<T>

Filter documents ($match stage).

paginate

abstract fun paginate(page: Int, pageSize: Int): AggregationPipeline<PagedResult<T>>

Paginate result of previous stages output

skip

abstract fun skip(count: Int): AggregationPipeline<T>

Skip N documents ($skip stage).

sort

abstract fun sort(block: SortBuilder<T>.() -> Unit): AggregationPipeline<T>

Sort documents ($sort stage).

toAggregation

abstract fun toAggregation(): Aggregation

Get raw Spring Data Aggregation for debugging.

toJson

abstract fun toJson(): String

Get pipeline as JSON string for debugging.

toList

abstract fun toList(): List<T>

Execute pipeline and return all results.