MongoDB driver for Kotlin (synchronous) • opensavvy.ktmongo.sync

Package-level declarations¶

Declaration and implementation of collections and iterables.

Types¶

`JvmMongoCollection`¶

class JvmMongoCollection<Document : Any> : MongoCollection<Document>

Implementation of MongoCollection based on MongoDB's MongoCollection.

`JvmMongoIterable`¶

class JvmMongoIterable<Document : Any> : MongoIterable<Document>

Implementation of MongoIterable based on MongoDB's MongoIterable.

`LazyMongoIterable`¶

interface LazyMongoIterable<Document : Any>

`MongoAggregationPipeline`¶

class MongoAggregationPipeline<Output : Any> : LazyMongoIterable<Output>

`MongoCollection`¶

interface MongoCollection<Document : Any> : FindOperations<Document> , CountOperations<Document> , UpdateOperations<Document> , DeleteOperations<Document> , CollectionOperations<Document> , InsertOperations<Document> , AggregationOperations<Document> , UpdatePipelineOperations<Document>

Methods to interact with a MongoDB collection.

`MongoIterable`¶

interface MongoIterable<Document : Any>

Streaming-ready iterable client to read data from the database.

Functions¶

`asIterable`¶

inline fun <Document : Any> LazyMongoIterable<Document>.asIterable(): MongoIterable<Document>

`asKtMongo`¶

fun <Document : Any> MongoCollection<Document>.asKtMongo(): JvmMongoCollection<Document>

Converts a MongoDB collection into a KtMongo collection.

fun <Document : Any> MongoIterable<Document>.asKtMongo(): JvmMongoIterable<Document>

Converts a MongoDB MongoIterable into a KtMongo MongoIterable.

`filter`¶

fun <Document : Any> MongoCollection<Document>.filter(filter: <Document>.() -> Unit): MongoCollection<Document>

Returns a filtered collection that only contains the elements that match filter.

`first`¶

inline fun <Document : Any> LazyMongoIterable<Document>.first(): Document

`firstOrNull`¶

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

`forEach`¶

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

`toList`¶

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

`toSet`¶

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