Specify MongoClient Settings

Overview

In this guide, you can learn about the different settings to control the behavior of your MongoClient.

The following sections describe commonly used settings:

• MongoClient Settings

• Cluster Settings

• Socket Settings

• Connection Pool Settings

• Server Settings

• TLS/SSL Settings

MongoClient Settings

You can control the behavior of your MongoClient by creating and passing in a MongoClientSettings object to the MongoClient.create() method.

To create a MongoClientSettings object, use the MongoClientSettings.builder() method and chain methods to specify your settings. After chaining them, use the build() method to create the MongoClientSettings object.

The following table describes all the methods you can chain to modify your connection behavior:

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyConnectionString(ConnectionString("<your connection string>"))
        .build()
)

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyConnectionString(ConnectionString("mongodb+srv:/<db_username>:<db_password>@<hostname>:<port>?connectTimeoutMS(2000)"))
        .applyToSocketSettings{ builder ->
            builder.connectTimeout(5, TimeUnit.SECONDS)
        }
        .build()
)

Cluster Settings

Chain the applyToClusterSettings() method to modify the driver's behavior when interacting with your MongoDB cluster.

The following table describes all the methods you can chain to your settings to modify the driver's behavior:

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyConnectionString(ConnectionString("mongodb+srv://host1.acme.com"))
        .build()
)

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyToClusterSettings{ builder ->
            builder.mode(ClusterConnectionMode.SINGLE)
        }
        .build()
)

Socket Settings

Chain the applyToSocketSettings() method to modify the driver's behavior when connecting and communicating with your MongoDB server.

The following table describes all the methods you can chain to your settings to modify the driver's behavior:

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyConnectionString(ConnectionString("<your connection string>"))
        .applyToSocketSettings{ builder ->
            builder
                .connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(15, TimeUnit.SECONDS)
        }
        .build()
)

Connection Pool Settings

Chain the applyToConnectionPoolSettings() method to modify the way the driver manages its connection pool.

The following table describes all the methods you can chain to your settings to modify the driver's behavior:

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyConnectionString(ConnectionString("<your connection string>"))
        .applyToConnectionPoolSettings{ builder ->
            builder
                .maxWaitTime(10, TimeUnit.SECONDS)
                .maxSize(200)
        }
        .build()
)

Server Settings

Chain the applyToServerSettings() method to modify the driver's behavior when monitoring each MongoDB server.

The following table describes all the methods you can chain to your settings to modify the driver's behavior:

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyConnectionString(ConnectionString("<your connection string>"))
        .applyToServerSettings{ builder ->
            builder
                .minHeartbeatFrequency(700, TimeUnit.MILLISECONDS)
                .heartbeatFrequency(15, TimeUnit.SECONDS)
        }
        .build()
)

TLS/SSL Settings

Chain the applyToSslSettings() method to modify the driver's behavior when using TLS/SSL to secure a connection between your application and MongoDB.

The following table describes all the methods you can chain to your settings to modify the driver's behavior:

val mongoClient = MongoClient.create(
    MongoClientSettings.builder()
        .applyConnectionString(ConnectionString("<your connection string>"))
        .applyToSslSettings{ builder ->
            builder.enabled(true)
        }
        .build()
)