Something went wrong. Try again.
The next MongoDB driver for Kotlin ktmongo.opensavvy.dev
kotlin mongodb multiplatform
Something went wrong. Try again.
2.8 kB · 81 lines
Kotlin
at main
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182/* * Copyright (c) 2026, OpenSavvy and contributors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */
package opensavvy.ktmongo.sync.api
import opensavvy.ktmongo.bson.BsonFactoryimport opensavvy.ktmongo.bson.types.ObjectIdGeneratorimport opensavvy.ktmongo.dsl.path.PropertyNameStrategyimport opensavvy.ktmongo.sync.api.operations.BaseOperations
/** * Entry-point to the KtMongo drivers. * * This interface exists to unify the API of the different KtMongo drivers. * Each implementation may add its own specificities. * * Each implementation provides its own way to obtain an instance of this interface. * * ### Organizing data * * Accessing MongoDB data happens in three steps: * - [MongoClient]: represents the connection to the MongoDB application, handles * the lifecycle and the configuration. * - [MongoDatabase] (accessed with [MongoClient.database]): each database groups data together. * This allows deploying multiple applications (or the same application multiple times) * without name collisions. * - [MongoCollection] (accessed with [MongoDatabase.collection]): each collection stores data together. * Documents in a collection may have a different structure. * * ### Example * * ```kotlin * @Serializable * class User( * val _id: ObjectId, * val name: String, * val age: Int, * ) * * fun main() = runBlocking { * val client: MongoClient = // Implementation-dependent accessor * * val database = client.database("my-app") * val users = database.collection<User>("users") * * println("The database contains ${users.count()} users.") * } * ``` */interface MongoClient : AutoCloseable, BaseOperations {
/** * Creates a [MongoDatabase] object. * * This method is purely a client-side operation, it does nothing in the MongoDB server. * In MongoDB, databases and collections are created implicitly on the first insert. * * To learn more about the restrictions on the database [name], see [MongoDatabase.name]. * * For an example, see [MongoClient]. */ fun database( name: String, factory: BsonFactory = this.factory, objectIdGenerator: ObjectIdGenerator = this.objectIdGenerator, propertyNameStrategy: PropertyNameStrategy = this.propertyNameStrategy, ): MongoDatabase}