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

Package-level declarations

Types

MongoAggregationPipeline

interface MongoAggregationPipeline<Document : Any> : AggregationPipeline<Document>

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

interface MongoClient : AutoCloseable

Entry-point to the KtMongo drivers.

MongoCollection

A collection stores related documents together.

interface MongoDatabase

A grouping of collections with the same theme.

interface MongoIterable<Document : Any>

Streaming-capable iterable cursor to read data from the database.

Functions

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

Streams the results into a Flow.

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

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

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

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

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

Executes action for each document returned by this query.

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

Reads the entirety of this iterable into a List.

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

Reads the entirety of this iterable into a Set.