Kotlin Sync Driver

Introduction

Welcome to the documentation site for the Kotlin Sync Driver, the official MongoDB driver for synchronous Kotlin applications.

• API Documentation

• Source Code

Installation

The recommended way to get started using the driver in your project is with a dependency management system.

If you are using Gradle, add the following to your build.gradle.kts dependencies list:

dependencies {
 implementation("org.mongodb:mongodb-driver-kotlin-sync:5.0.0")
}

If you are using Maven, add the following to your pom.xml dependencies list:

<dependencies>
   <dependency>
      <groupId>org.mongodb</groupId>
      <artifactId>mongodb-driver-kotlin-sync</artifactId>
      <version>5.0.0</version>
   </dependency>
</dependencies>

Connect to MongoDB Atlas

To connect to a MongoDB Atlas cluster, use the Atlas connection string for your cluster:

import com.mongodb.ConnectionString
import com.mongodb.kotlin.client.sync.MongoClient
import com.mongodb.kotlin.client.sync.MongoDatabase
import com.mongodb.MongoClientSettings
// Replace the placeholder with your Atlas connection string
val uri = "<connection string>"
val settings = MongoClientSettings.builder()
   .applyConnectionString(ConnectionString(uri))
   .retryWrites(true)
   .build()
// Create a new client and connect to the server
val mongoClient = MongoClient.create(settings)
val database = mongoClient.getDatabase("test")

Stable API

You can use the Stable API feature starting with MongoDB Server version 5.0 and Kotlin Sync Driver. When you use the Stable API feature, you can update your driver or server without worrying about backward compatibility issues with any commands covered by the Stable API.

To use this feature, construct a MongoDB client instance, specifying a version of the Stable API:

import com.mongodb.ConnectionString
import com.mongodb.MongoClientSettings
import com.mongodb.ServerApi
import com.mongodb.ServerApiVersion
import com.mongodb.kotlin.client.sync.MongoClient
import com.mongodb.kotlin.client.sync.MongoDatabase
// Replace the placeholder with your MongoDB deployment's connection string
val uri = "<connection string>"
// Set the Stable API version on the client
val serverApi = ServerApi.builder()
    .version(ServerApiVersion.V1)
    .build()
val settings = MongoClientSettings.builder()
    .applyConnectionString(ConnectionString(uri))
    .serverApi(serverApi)
    .build()
// Create a new client and connect to the server
val mongoClient = MongoClient.create(settings)
val database = mongoClient.getDatabase("test")

Connect to a MongoDB Server on Your Local Machine

If you need to run a MongoDB server on your local machine for development purposes instead of using an Atlas cluster, you need to complete the following:

1. Download the Community or Enterprise version of MongoDB Server.

2. Install and configure MongoDB Server.

3. Start the server.

After you successfully start your MongoDB server, specify your connection string in your driver connection code.

If your MongoDB Server is running locally, you can use the connection string "mongodb://localhost:<port>" where <port> is the port number you configured your server to listen for incoming connections.

If you need to specify a different hostname or IP address, see our Server Manual entry on Connection Strings.

To test whether you can connect to your server, replace the connection string in the Connect to MongoDB Atlas code example and run it.

Compatibility