Upgrade Driver Versions
Overview
In this section, you can identify the changes you might need to make to your application to upgrade your driver to a new version.
Before you upgrade, perform the following actions:
Ensure the new version is compatible with the MongoDB Server versions your application connects to and the Java Runtime Environment (JRE) your application runs on. See the Java Compatibility page for this information.
Address any breaking changes between the current version of the driver your application is using and your planned upgrade version in the Breaking Changes section. To learn more about the MongoDB Server release compatibility changes, see the Server Release Compatibility Changes section.
Tip
To minimize the amount of changes your application might require when upgrading driver versions in the future, use the Stable API.
Breaking Changes
A breaking change is a modification in a convention or behavior in a specific version of the driver that might prevent your application from working properly if not addressed before upgrading.
The breaking changes in this section are categorized by the driver version that introduced them. When upgrading driver versions, address all the breaking changes between the current and upgrade versions. For example, if you are upgrading the driver from v4.0 to v4.5, address all breaking changes from the version after v4.0 including any listed under v4.5.
Version 5.0 Breaking Changes
This driver version introduces the following breaking changes:
Introduces the following changes to the
ConnectionId
class:The
ConnectionId
constructor now accepts a value of typelong
as its second parameter instead of typeint
. Similarly, the constructor now accepts a value of typeLong
as its third parameter instead of typeInteger
. Because this change breaks binary compatibility, recompile any existing code that calls theConnectionId
constructor.The
withServerValue()
method now accepts a parameter of typelong
rather than typeint
. This change breaks binary compatibility, so you must recompile any code that calls thewithServerValue()
method.The
getServerValue()
method now returns a value of typeLong
instead of typeInteger
. Similarly, thegetLocalValue()
method returns a value of typelong
instead of typeint
. Because this change breaks both binary and source compatibility, update any source code that uses these methods and rebuild your binary.
Replaces the following record annotations from the
org.bson.codecs.record.annotations
package with annotations of the same name from theorg.bson.codecs.pojo.annotations
package:BsonId
BsonProperty
BsonRepresentation
Changes the data type of the timeout duration parameter in the
SocketSettings.Builder.connectTimeout()
andSocketSettings.Builder.readTimeout()
methods. The data type of this parameter is nowlong
instead ofint
.In earlier versions, this parameter is of type
int
for both methods. This change breaks binary compatibility and requires recompiling, but does not require code changes. To view an example that shows how to callSocketSettings
methods, see the SocketSettings Example in the Specify MongoClient Settings guide.Removes the
Filters.eqFull()
method, released exclusively inBeta
, which allowed you to construct an equality filter when performing a vector search. You can use theFilters.eq()
method when instantiating aVectorSearchOptions
type, as shown in the following code:VectorSearchOptions opts = vectorSearchOptions().filter(eq("x", 8));
Removes the
org.mongodb.scala.ObservableImplicits.ToSingleObservableVoid
implicit class. This means theorg.reactivestreams.Publisher[Void]
type no longer converts automatically toorg.mongodb.scala.SingleObservable[Void]
. The API also exposesorg.mongodb.scala.Observable[Unit]
instead oforg.mongodb.scala.Observable[Void]
.For more information, see the Observable trait in the Scala API documentation.
Changes how
ClusterSettings
computesClusterConnectionMode
, making it more consistent by using the specified replica set name, regardless of how it is configured. Previously, replica set name was only considered if it was set by the connection string.For example, the following two code samples both return the value
ClusterConnectionMode.MULTIPLE
, while previously the second one returnedClusterConnectionMode.SINGLE
.ClusterSettings.builder() .applyConnectionString(new ConnectionString("mongodb://127.0.0.1:27017/?replicaSet=replset")) .build() .getMode() ClusterSettings.builder() .hosts(Collections.singletonList( new ServerAddress("127.0.0.1", 27017) )) .requiredReplicaSetName("replset") .build() .getMode() Changes how
BsonDecimal128
values respond to method calls, by responding in the same way asDecimal128
values. In particular,BsonDecimal128.isNumber()
now returnstrue
, andBsonDecimal128.asNumber()
returns the equivalentBsonNumber
.Removes the ServerAddress methods
getSocketAddress()
andgetSocketAddresses()
.Instead of
getSocketAddress()
, use thegetByName()
instance method ofjava.net.InetAddress
.Instead of
getSocketAddresses()
, use thegetAllByName()
instance method ofjava.net.InetAddress
.Removes the UnixServerAddress methods
getSocketAddress()
andgetUnixSocketAddress()
.Instead of
getUnixSocketAddress()
, construct an instance ofjnr.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 theUnixSocketAddress
, see the UnixSocketAddress API documentation.Removes the
Parameterizable
interface. Instead of implementing this interface on a customCodec
type, override theCodecProvider.get()
method on the codec'sCodecProvider
if the codec is intended for a parameterized type.Removes the
isSlaveOk()
method from theReadPreference
andTaggableReadPreference
classes. To check whether a read preference allows reading from a secondary member of a replica set, use theisSecondaryOk()
methods from these classes instead.Removes the
DBCollection.getStats()
andDBCollection.isCapped()
helper methods for thecollStats
command. Instead of these methods, you can use the$collStats
aggregation pipeline stage. For an example of how to use this pipeline stage, see What's New in 4.11 for the Java driver.Removes the
MapCodec
andIterableCodec
classes. Instead ofMapCodec
, useMapCodecProvider
. Instead ofIterableCodec
, useCollectionCodecProvider
, orIterableCodecProvider
forIterable
types that aren'tCollection
types.Removes the
sharded()
andnonAtomic()
methods from theMapReducePublisher
andMapReduceIterable
classes.Removes the following methods for use with
geoHaystack
indexes:Indexes.geoHaystack()
IndexOptions.getBucketSize()
IndexOptions.bucketSize()
Instead, you can use the
$geoNear
aggregation pipeline stage or a geospatial query operator on a 2d index. For more information, see the Geospatial Queries page in the MongoDB Server manual.Removes the
oplogReplay
option from find operations. This includes the following methods:DBCursor.oplogReplay()
DBCollectionFindOptions.isOplogReplay()
DBCollectionFindOptions.oplogReplay()
FindPublisher.oplogReplay()
FindIterable.oplogReplay()
Removes the following
Exception
constructors:MongoBulkWriteException(BulkWriteResult, List<BulkWriteError>, WriteConcernError, ServerAddress)
MongoCursorNotFoundException(long, ServerAddress)
MongoQueryException(ServerAddress, int, String)
MongoQueryException(ServerAddress, int, String, String)
MongoQueryException(MongoCommandException)
Removes the following overloads for the
BulkWriteResult.acknowledged()
method:acknowledged(Type, int, List<BulkWriteUpsert>)
acknowledged(Type, int, Integer, List<BulkWriteUpsert>)
acknowledged(int, int, int, Integer, List<BulkWriteUpsert>)
Removes the following
ChangeStreamDocument
constructors:ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, TDocument, BsonDocument, ...)
ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)
ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)
Removes the following constructors for events:
CommandEvent(RequestContext, int, ConnectionDescription, String)
CommandEvent(int, ConnectionDescription, String)
CommandEvent(RequestContext, long, int, ConnectionDescription, String)
CommandFailedEvent(RequestContext, int, ConnectionDescription, String, long, Throwable)
CommandFailedEvent(int, ConnectionDescription, String, long, Throwable)
CommandStartedEvent(RequestContext, int, ConnectionDescription, String, String, BsonDocument)
CommandStartedEvent(int, ConnectionDescription, String, String, BsonDocument)
CommandSucceededEvent(RequestContext, int, ConnectionDescription, String, BsonDocument, long)
CommandSucceededEvent(int, ConnectionDescription, String, BsonDocument, long)
ConnectionCheckedInEvent(ConnectionId)
ConnectionCheckedOutEvent(ConnectionId, long)
ConnectionCheckedOutEvent(ConnectionId)
ConnectionCheckOutFailedEvent(ServerId, long, Reason)
ConnectionCheckOutFailedEvent(ServerId, Reason)
ConnectionCheckOutStartedEvent(ServerId)
ConnectionReadyEvent(ConnectionId)
ServerHeartbeatFailedEvent(ConnectionId, long, Throwable)
ServerHeartbeatSucceededEvent(ConnectionId, BsonDocument, long)
Removes the
errorLabels
option from theWriteConcernError
class. This includes theaddLabel()
andgetErrorLabels()
methods and the constructor that includes anerrorLabels
parameter. Instead, you can use the error labels included in theMongoException
object that contains theWriteConcernError
.Removes the following classes from the
com.mongodb.event
package:ConnectionAddedEvent
ConnectionPoolOpenedEvent
ConnectionRemovedEvent
ClusterListenerAdapter
ConnectionPoolListenerAdapter
ServerListenerAdapter
ServerMonitorListenerAdapter
Because of these removals, the following methods were also removed from the
ConnectionPoolListener
interface:connectionAdded
connectionPoolOpened
connectionRemoved
For more information about the events package, see the com.mongodb.event package documentation
Adds support for a new
authorizedCollection
option of thelistCollections
command. This introduces a breaking binary change in theMongoDatabase.listCollectionNames()
methods, meaning any code using these methods must be recompiled. This change does not require any changes to source code.Removes the following methods and types related to the Stream interface:
streamFactoryFactory()
method fromMongoClientSettings.Builder
. Use theMongoClientSettings.Builder.transportSettings()
method instead.getStreamFactoryFactory()
method fromMongoClientSettings
. Use theMongoClientSettings.getTransportSettings()
method instead.NettyStreamFactoryFactory
class. Use theNettyTransportSettings
, creatable byTransportSettings.nettyBuilder()
and applied throughMongoClientSettings.Builder.transportSettings()
.NettyStreamFactory
classAsynchronousSocketChannelStreamFactory
classAsynchronousSocketChannelStreamFactoryFactory
classBufferProvider
interfaceSocketStreamFactory
classStream
interfaceStreamFactory
interfaceStreamFactoryFactory
interfaceTlsChannelStreamFactoryFactory
class
Version 4.8 Breaking Changes
The driver ends support for connecting to MongoDB Server versions v3.4 and earlier. To learn more about this change, see the Driver Version 4.8 Server Support Changes section.
You must add an explicit dependency on the
org.bson.codecs.record
module if your application deploys the driver in an OSGi container and relies on the driver for encoding and decoding Java records.The
RecordCodec
, implemented in v4.6, deserialized POJOs and record classes that are specified as type parameters ofList
orMap
fields of a record asDocument
values instead of their respective classes. This version now deserializes them to the proper record and POJO types.For example, the following record class definitions show a
Book
record that contains aList
that receives aChapter
type parameter:public record Book(String title, List<Chapter> chapters) {} public record Chapter(Integer number, String text) {} Starting in this version, the codec deserializes data in the
List
intoChapter
record classes instead ofDocument
values.
Version 4.7 Breaking Changes
The
setWindowFields
builder API is no longer beta. The new builder breaks binary and source compatibility. See the Aggregates API documentation for information the newsetWindowFields()
method signatures.If your application uses this builder in a version prior to v4.7, update your source code to use the new method signature and rebuild your binary.
Version 4.2 Breaking Changes
The
ObjectId
class and itsserialVersionUID
field were updated to use a new format that minimizes serialization compatibility issues across different versions of the driver.If an application using this version or later of the driver attempts to perform Java Object Serialization on any objects that contain an
ObjectId
and were serialized by a prior version of the driver, Java throws anInvalidClassException
.To learn more about Java Object Serialization, see the Java Documentation on Serializable Objects.
Version 4.0 Breaking Changes
Several classes and methods marked as deprecated in the 3.12 release were removed in this version.
The insert helper methods return an insert result object instead of
void
.The
toJson()
methods onBsonDocument
,Document
, andDbObject
return a relaxed JSON format instead of a strict JSON format. This makes the JSON documents more readable, but can make it more difficult to identify the BSON type information, such as the difference between a 32-bit and 64-bit integer. If your application relies on the strict JSON format, use the strict mode when reading or writing data. Learn how to specify the JSON format in the current API in the Document Data Format: Extended JSON guide.The default BSON representation of
java.util.UUID
value was changed fromJAVA_LEGACY
toUNSPECIFIED
. Applications that store or retrieve UUID values must explicitly specify which representation to use. You can specify the representation in theuuidRepresentation
property ofMongoClientSettings
.The UUID representation that you specify strictly controls how the driver decodes UUIDs. In previous versions of the driver, if you specified the
JAVA_LEGACY
representation, the driver would decode binary objects of subtypes 3 and 4 as UUIDs. In version 4.0, theJAVA_LEGACY
representation works only with subtype 3.For a list of members in the
UuidRepresentation
enum, see the v4.0 API documentation.The connection pool no longer restricts the number of wait queue threads or asynchronous tasks that require a connection to MongoDB. The application should throttle requests as necessary rather than depend on the driver to throw a
MongoWaitQueueFullException
.The driver no longer logs using the
java.util.logging
(JUL) package and only supports the SLF4J logging framework.The embedded and Android drivers were removed. If your application relies on these drivers, you must continue to use a 3.x Java driver version.
The uber JARs,
mongo-java-driver
andmongodb-driver
, are no longer published. If your application relies on one of these, you must switch to eithermongodb-driver-sync
ormongodb-driver-legacy
depending on which API the application uses. Make sure you remove the uber JARs from your dependencies.Updates to several classes introduced binary compatibility breaks, such as the method signature change to the insert helper methods. Recompile any classes that link to the driver against this version or later to ensure that they continue to work.
Server Release Compatibility Changes
A server release compatibility change is a modification to the MongoDB Java Driver that discontinues support for a set of MongoDB Server versions.
The driver discontinues support for a MongoDB Server version after it reaches end-of-life (EOL).
To learn more about the MongoDB support for EOL products, see the Legacy Support Policy.
Server Version 8.1 Support Changes
You cannot use a 3.x version of the Java driver to connect to a
deployment running MongoDB Server v8.1. Starting in MongoDB Server v8.1,
the buildinfo
command requires authentication, causing an
incompatibility with the v3.x driver.
Driver Version 4.8 Server Support Changes
The v4.8 driver drops support for MongoDB Server v3.4 and earlier. To use the v4.8 driver, your MongoDB Server must be v3.6 or later. To learn how to upgrade your MongoDB Server deployment, see Release Notes in the MongoDB Server manual.