What's New

Deprecations in 5.1

• Support for MongoDB Server v3.6 is deprecated and will be removed in the next driver version release. To learn how to upgrade your MongoDB Server deployment, see Release Notes in the MongoDB Server manual.

Improvements in 5.1

• Internal testing of GraalVM native image technology. These tests involve building native applications by using the GraalVM native-image tool.

• Enhanced support for the MONGODB-OIDC authentication mechanism. For more information about OIDC, see the MONGODB-OIDC section of the Enterprise Authentication Mechanisms guide.

New Features in 5.1

• Introduces the serverMonitoringMode connection URI option. For more information about this option, see the Connection Options guide.

Deprecations in 5.0

• The org.mongodb.scala.Observable.completeWithUnit() method is deprecated. This method is not useful anymore because the driver now exposes org.mongodb.scala.Observable[Unit] instead of org.mongodb.scala.Observable[Void]. This relates to a breaking change about Observables in this release.

Behavioral changes in 5.0

• The getElapsedTime() method on com.mongodb.event.ConnectionReadyEvent includes the time taken to deliver the ConnectionCreatedEvent. That is, the time returned includes the duration of the com.mongodb.event.ConnectionPoolListener.connectionCreated() method.

  The getElapsedTime() methods on com.mongodb.event.ConnectionCheckedOutFailedEvent and com.mongodb.event.ConnectionCheckedOutEvent include the time taken to deliver the com.mongodb.event.ConnectionCheckOutStartedEvent. That is, the time returned includes the duration of the com.mongodb.eventConnectionPoolListener.connectionCheckOutStarted() method.

New features in 5.0

The 5.0 driver release introduces the following features:

• Adds support for the authorizedCollection option of the listCollections command. This was done by changing the com.mongodb.client.MongoDatabase.listCollectionNames() methods. The return type is now com.mongodb.client.ListCollectionNamesIterable, while previously it was a MongoIterable<String>. This change allows the return value to be configured using the ListCollectionNamesIterable.authorizedCollections() method and specifying the authorizedCollections option. Equivalent changes were made to following classes and interfaces:

  • com.mongodb.reactivestreams.client.MongoDatabase

  • org.mongodb.scala.MongoDatabase

  • com.mongodb.kotlin.client.MongoDatabase

  • com.mongodb.kotlin.client.coroutine.MongoDatabase

  These changes introduce a binary breaking change to the listCollectionsNames() method. For more information about the MongoDatabase.listCollectionNames() method and the authorizedCollections option, see the listCollections Server manual page or Get a List of Collections.

Deprecations in 4.11

The 4.11 driver release deprecates the following items:

• The getStats() and isCapped() instance methods of the DBCollection class are deprecated. The corresponding server commands are deprecated in MongoDB v6.2 and later. Use the $collStats aggregation pipeline stage to retrieve the information provided by these methods instead. You can run the aggregation as shown in the following code example:

  Cursor cursor = collection.aggregate(Arrays.asList(
          new BasicDBObject("$collStats",
                  new BasicDBObject("storageStats", new BasicDBObject()))),
          AggregationOptions.builder().build()
  );

  To determine whether a collection is a capped collection, access the value of the storageStats.capped field returned by Cursor instance in the preceding example aggregation.

  To learn more about the $collStats aggregation operator, see the $collStats (aggregation) Server manual entry.

• The following network address-related methods are deprecated and will be removed in v5.0:

  • The ServerAddress methods getSocketAddress() and getSocketAddresses().

    Instead of getSocketAddress(), use the getByName() instance method of java.net.InetAddress.

    Instead of getSocketAddresses(), use the getAllByName() instance method of java.net.InetAddress.

  • The UnixServerAddress method getUnixSocketAddress().

    Instead of getUnixSocketAddress(), construct an instance of jnr.unixsocket.UnixSocketAddress. Pass the full path of the UNIX socket file to the constructor. By default, MongoDB creates a UNIX socket file located at "/tmp/mongodb-27017.sock". To learn more about the UnixSocketAddress, see the UnixSocketAddress API documentation.

• The following methods and types related to the StreamFactory interface are deprecated and scheduled for removal in v5.0:

  • streamFactoryFactory() method from MongoClientSettings.Builder

  • getStreamFactoryFactory() method from MongoClientSettings

  • NettyStreamFactoryFactory class

  • NettyStreamFactory class

  • AsynchronousSocketChannelStreamFactory class

  • AsynchronousSocketChannelStreamFactoryFactory class

  • BufferProvider class

  • SocketStreamFactory class

  • Stream class

  • StreamFactory class

  • StreamFactoryFactory class

  • TlsChannelStreamFactoryFactory class

  If you configure Netty by using MongoClientSettings.Builder.streamFactoryFactory(), your code might resemble the following:

  import com.mongodb.connection.netty.NettyStreamFactoryFactory;
  // ...
  MongoClientSettings settings = MongoClientSettings.builder()
          .streamFactoryFactory(NettyStreamFactoryFactory.builder().build())
          .build();

  Replace this code with the TransportSettings.nettyBuilder() as shown in the following example:

  import com.mongodb.connection.TransportSettings;
  // ...
  MongoClientSettings settings = MongoClientSettings.builder()
          .transportSettings(TransportSettings.nettyBuilder().build())
          .build();

New Features in 4.11

New features of the 4.11 driver release include:

• Support for connecting to MongoDB by using a SOCKS5 proxy. To learn more see Connect to MongoDB by Using a SOCKS5 Proxy.

• Added the getSplitEvent() method to the ChangeStreamDocument class to identify fragments of a change stream event that exceeds 16MB. You must use the aggregation stage $changeStreamSplitLargeEvent in your change stream to handle events that exceed 16MB. To learn more, see Split Large Change Stream Events.

• Added an aggregation stage builder for $vectorSearch. To learn more, see Atlas Vector Search.

• Added Atlas Search index management helpers. To learn more, see Atlas Search Indexes.

• Updated Snappy and Zstd compression library dependency versions. To learn more about the current dependency versions, see Network Compression.

• Added getElapsedTime() methods to the following classes to monitor the duration of connection pool events:

  • ConnectionCheckOutFailedEvent

  • ConnectionCheckedOutEvent

  • ConnectionReadyEvent

• Support for Java 21 virtual threads and structured concurrency. The driver internals were updated to avoid unnecessary pinning of virtual threads and to preserve interrupted status of a thread, as the latter matters for structured concurrency where it is used for cancellation.

  To learn more about virtual threads, see the Virtual Threads JDK enhancement proposal. To learn more about structured concurrency, see the Structured Concurrency JDK enhancement proposal.

• Updated API documentation for the following types:

  • ClusterListener

  • ServerListener

  • ServerMonitorListener