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> : <ERROR CLASS> ERROR CLASS: Symbol not found for AbstractPipeline<Output>, <ERROR CLASS> ERROR CLASS: Symbol not found for AggregationPipeline<Output>, 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.

interface MongoIterable<Document : Any>

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

Functions

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

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

Converts a MongoDB MongoIterable into a KtMongo MongoIterable.

fun <Document : Any> MongoCollection<Document>.asKtMongo(nameStrategy: PropertyNameStrategy = PropertyNameStrategy.Default): JvmMongoCollection<Document>

Converts a MongoDB collection into a KtMongo collection.

fun <Document : Any> MongoCollection<Document>.filter(filter: ERROR CLASS: Symbol not found for FilterQuery<Document>.() -> Unit): MongoCollection<Document>

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

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

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

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

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

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