KtMongo: MongoDB driver for Kotlin • Coroutines/opensavvy.ktmongo.coroutines

Package-level declarations

Types

CoroutineMongoAggregateIterable

interface CoroutineMongoAggregateIterable<Document : Any> : MongoIterable<Document>

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

CoroutineMongoAggregationPipeline

interface CoroutineMongoAggregationPipeline<Document : Any> : MongoAggregationPipeline<Document>

An aggregation pipeline built on top of the official Kotlin driver.

CoroutineMongoClient

interface CoroutineMongoClient : MongoClient

Entry-point to the KtMongo Coroutines driver.

CoroutineMongoCollection

interface CoroutineMongoCollection<Document : Any> : MongoCollection<Document>

A collection stores related documents together.

CoroutineMongoDatabase

interface CoroutineMongoDatabase : MongoDatabase

A grouping of collections with the same theme.

CoroutineMongoFindIterable

interface CoroutineMongoFindIterable<Document : Any> : MongoIterable<Document>

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

Functions

inline fun <Document : Any> CoroutineMongoAggregationPipeline<Document>.asIterable(): CoroutineMongoAggregateIterable<Document>

Access the data of this pipeline as a MongoIterable.

fun <Document : Any> AggregateFlow<Document>.asKtMongo(): CoroutineMongoAggregateIterable<Document>

Instantiates a KtMongo CoroutineMongoAggregateIterable using an existing flow from the official Kotlin driver.

fun <Document : Any> FindFlow<Document>.asKtMongo(): CoroutineMongoFindIterable<Document>

Instantiates a KtMongo CoroutineMongoFindIterable using an existing flow from the official Kotlin driver.

fun MongoClient.asKtMongo(): CoroutineMongoClient

Instantiates a KtMongo CoroutineMongoClient using an existing client from the official Kotlin driver.

fun MongoDatabase.asKtMongo(): CoroutineMongoDatabase

Instantiates a KtMongo CoroutineMongoDatabase using an existing client from the official Kotlin driver.

inline fun <Document : Any> MongoCollection<Document>.asKtMongo(factory: BsonFactory = BsonFactory(this.codecRegistry), propertyNameStrategy: PropertyNameStrategy = PropertyNameStrategy.Default, objectIdGenerator: ObjectIdGenerator = ObjectIdGenerator.Jvm()): CoroutineMongoCollection<Document>

fun <Document : Any> MongoCollection<Document>.asKtMongo(factory: BsonFactory = BsonFactory(this.codecRegistry), propertyNameStrategy: PropertyNameStrategy = PropertyNameStrategy.Default, objectIdGenerator: ObjectIdGenerator = ObjectIdGenerator.Jvm(), type: KType): CoroutineMongoCollection<Document>

Instantiates a KtMongo CoroutineMongoCollection using an existing collection from the official Kotlin driver.

CoroutineMongoClient

fun CoroutineMongoClient(connectionString: String = "mongodb://localhost:27017"): CoroutineMongoClient

Instantiates a KtMongo CoroutineMongoClient using an existing client from the official Kotlin driver.