HasLimit

interface HasLimit<Document : Any> : Pipeline<Document> 

Pipeline implementing the $limit stage.

Inheritors

• AggregationPipeline

Properties

context

@LowLevelApi



abstract val context: BsonContext

The context used to generate this pipeline.

Functions

limit

open fun limit(amount: Long): Pipeline<Document>

Limits the number of elements passed to the next stage to amount.

Using limit with sorted results

Sort results aren't stable with limit: if multiple documents are identical, their relative order is undefined and may change from one execution to the next.

To avoid surprises, include a unique field in your sort, for example _id.

External resources

• Official documentation

See also

• HasSkip.skip: Skip over an amount of elements.

• HasSample.sample: Randomly limit the number of elements.

open fun limit(amount: Int): Pipeline<Document>

Limits the number of elements passed to the next stage to amount.

Using limit with sorted results

Sort results aren't stable with limit: if multiple documents are identical, their relative order is undefined and may change from one execution to the next.

To avoid surprises, include a unique field in your sort, for example _id.

External resources

• Official documentation

See also

• HasSkip.skip: Skip over an amount of elements.

• HasSample.sample: Randomly limit the number of elements.

reinterpret

@DangerousMongoApi



@LowLevelApi



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

Changes the type of the returned document, with no type-safety.

toString

abstract override fun toString(): String

JSON representation of this pipeline.

withStage

@DangerousMongoApi



@LowLevelApi



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

Creates a new pipeline that expands on the current one by adding stage.

writeTo

@LowLevelApi



abstract fun writeTo(writer: BsonValueWriter)

Writes the entire pipeline into writer.