Package com.mongodb.client

Interface MongoClient

All Superinterfaces:

AutoCloseable, Closeable, MongoCluster

@Immutable
public interface MongoClient
extends MongoCluster, Closeable

A client-side representation of a MongoDB cluster. Instances can represent either a standalone MongoDB instance, a replica set, or a sharded cluster. Instance of this class are responsible for maintaining an up-to-date state of the cluster, and possibly cache resources related to this, including background threads for monitoring, and connection pools.

Instances of this class serve as factories for MongoDatabase instances.

Instances of this class can be created via the MongoClients factory.

Since:

3.7

See Also:

• MongoClients

Method Summary

Modifier and Type	Method	Description
void	appendMetadata(com.mongodb.MongoDriverInformation mongoDriverInformation)	Appends the provided MongoDriverInformation to the existing metadata.
void	close()	Close the client, which will close all underlying cached resources, including, for example, sockets and background monitoring threads.
com.mongodb.connection.ClusterDescription	getClusterDescription()	Gets the current cluster description.

Methods inherited from interface com.mongodb.client.MongoCluster

bulkWrite, bulkWrite, bulkWrite, bulkWrite, getCodecRegistry, getDatabase, getReadConcern, getReadPreference, getTimeout, getWriteConcern, listDatabaseNames, listDatabaseNames, listDatabases, listDatabases, listDatabases, listDatabases, startSession, startSession, watch, watch, watch, watch, watch, watch, watch, watch, withCodecRegistry, withReadConcern, withReadPreference, withTimeout, withWriteConcern

Method Details

close

void close()

Close the client, which will close all underlying cached resources, including, for example, sockets and background monitoring threads.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getClusterDescription

com.mongodb.connection.ClusterDescription getClusterDescription()

Gets the current cluster description.

This method will not block, meaning that it may return a ClusterDescription whose clusterType is unknown and whose ServerDescriptions are all in the connecting state. If the application requires notifications after the driver has connected to a member of the cluster, it should register a ClusterListener via the ClusterSettings in MongoClientSettings.

Returns:

the current cluster description

Since:

3.11

See Also:

• ClusterSettings.Builder.addClusterListener(ClusterListener)
• MongoClientSettings.Builder.applyToClusterSettings(com.mongodb.Block)

appendMetadata

void appendMetadata(com.mongodb.MongoDriverInformation mongoDriverInformation)

Appends the provided MongoDriverInformation to the existing metadata.

This enables frameworks and libraries to include identifying metadata (e.g., name, version, platform) which might be visible in the MongoD/MongoS logs. This can assist with diagnostics by making client identity visible to the server.

Note: Metadata is limited to 512 bytes; any excess will be truncated.

Parameters:

mongoDriverInformation - the driver information to append to the existing metadata

Since:

5.6