HasMatch

interface HasMatch<Document : Any> : Pipeline<Document> 

Pipeline implementing the $match stage.

Inheritors

• AggregationPipeline

Properties

context

@LowLevelApi
abstract val context: BsonContext

The context used to generate this pipeline.

Functions

match

open fun match(filter: FilterQuery<Document>.() -> Unit): Pipeline<Document>

Filters documents based on a specified filter.

Matched documents are passed to the next pipeline stage.

Pipeline optimization

Place the match call as early in the pipeline as possible. Because match limits the total number of elements being processed, earlier match operations minimize the amount of processing down the pipe.

If you place a match at the very beginning of a pipeline, the query can take advantage of indexes.

External resources

• Official documentation

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.