Release Notes

What's New in 5.11.1

To learn more about this release, see the v5.11.1 Release Notes on GitHub.

What's New in 5.11

The 5.11 driver release does not include any changes, fixes, or features that apply to the Kotlin driver.

To learn more about this release, see the v5.11 Release Notes on GitHub.

What's New in 5.10

The 5.10 driver release includes the following changes, fixes, and features:

• Fixes an issue where a ByteArray field in a Kotlin data class was encoded as a BSON array of Int32 values instead of BSON Binary, which could significantly increase document size. This release restores BSON Binary encoding, matching the behavior before v5.1.3. The driver still decodes data written in the array format, but any non-driver consumers of this data might require updates to handle the new encoding.

• Adds the $scoreFusion aggregation stage, which combines and normalizes the scores of multiple search pipelines. This stage requires MongoDB 8.2 or later.

• Adds a fluent builder API for the $score aggregation stage. Use this API to configure score normalization, weighting, and score details. This feature requires MongoDB 8.2 or later.

• Adds the parentFilter and nestedOptions options, which allow nested embeddings and arrays of embeddings in $vectorSearch queries.

To learn more about this release, see the v5.10 Release Notes on GitHub.

What's New in 5.9.2

The 5.9.2 driver patch release includes the following changes:

To learn more about this release, see the v5.9.2 Release Notes on GitHub.

What's New in 5.9

The 5.9 driver release includes the following changes, fixes, and features:

• Promotes Queryable Encryption (QE) prefix, suffix, and substring queries to general availability (GA). These query types are supported on MongoDB 9.0 and later. To learn more about QE, see In-Use Encryption.

• Renames the explicit encryption API for QE string queries from Text to String. To perform a QE string query, make the following changes:

  • Use the StringOptions class instead of TextOptions.

  • Use the EncryptOptions.stringOptions() method instead of textOptions().

  • Use the EncryptOptions.getStringOptions() method instead of getTextOptions().

  • Set the encryption algorithm to "String".

• Upgrades the libmongocrypt version to 1.20.0.

To learn more about this release, see the v5.9 Release Notes on GitHub.

What's New in 5.8

The 5.8 driver release includes the following changes, fixes, and features:

To learn more about this release, see the v5.8 Release Notes on GitHub.

What's New in 5.7.1

The 5.7.1 driver patch release includes the following changes:

• Fixes Javadoc warnings in the Micrometer integration.

• Marks Micrometer OSGi imports as optional to resolve bundle resolution issues in OSGi runtime environments.

To learn more about this release, see the v5.7.1 Release Notes on GitHub.

What's New in 5.7

The 5.7 driver release includes the following changes, fixes, and features:

What's New in 5.6

The 5.6 driver release includes the following changes, fixes, and features:

• Adds experimental support for Queryable Encryption prefix, suffix, and substring queries. To learn more about QE, see In-Use Encryption.

  Note

  Experimental Feature

  Queryable Encryption prefix, suffix, and substring queries are unstable, and their security is not guaranteed until they're generally available (GA). Use them in experimental workloads only.

• Adds an nsType field to ChangeStreamDocument objects. This field contains the namespace type (COLLECTION, TIMESERIES, or VIEW) of the change event.

• Adds experimental client-side operation timeout (CSOT) support for OIDC authentication.

  Note

  Experimental Feature

  The CSOT feature is experimental and might change in future driver releases.

• When timeoutMS is set for CSOT, the driver ignores the value of the maxWaitTime connection setting.

• Adds an appendMetadata() method to the MongoClient class. You can use this method to append metadata to an existing client's metadata. The maximum metadata size is 512 MB.

• Adds a public constructor to the RewrapManyDataKeyOptions class.

• Merges the AsyncReadOperation and AsyncWriteOperation interfaces into the ReadOperation and WriteOperation interfaces. You can create read and write operations by using builder methods in the Operations class.

• Deprecates the MongoNamespace.COMMAND_COLLECTION_NAME constant.

• Fixes a bug that prevented OIDC reauthentication within a session.

• When serializing a POJO annotated with @BsonDiscriminator, if the property's readName matches the discriminator key, the driver serializes the field only once.

• After you call the next() or tryNext() method on a CommandCursorResult instance, the driver clears the CommandCursorResult.results property to free memory.

• The PojoBuilderHelper class creates property models that include properties from abstract classes and interfaces.

• The driver publishes and logs the following events when the cluster topology changes:

  • ClusterOpeningEvent: Published when the topology opens

  • ClusterDescriptionChangedEvent: Published when the topology description changes

  • ClusterClosedEvent: Published when the topology closes

• The driver throws a MongoStalePrimaryException when the primary replica set member becomes stale for one of the following reasons:

  • A new primary member is elected or discovered.

  • The value of the electionId or setVersion field in the primary member doesn't match the values of these fields in the other replica set members.

  To learn more about replica sets, see Replication in the MongoDB server manual.

What's New in 5.5.1

The 5.5.1 driver patch release includes the following changes:

What's New in 5.5

The 5.5 driver release includes the following changes, fixes, and features:

• Adds support for the connectTimeoutMS option when using the default TLS transport layer.

What's New in 5.4

The 5.4 driver release includes the following changes, fixes, and features:

• Adds BsonConfiguration support for bson-kotlinx snake case conversion during serialization. To learn more, see the Implement Snake Case Naming Strategy section on the Serialization page.

What's New in 5.3

The 5.3 driver release includes the following new features, improvements, and fixes:

• Support for using builders class methods directly with data class properties. To learn more, see the Use Builders with Data Classes guide. This functionality is supported by the Kotlin driver Extensions package published with this release.

• Implements a client bulk write API that allows you to perform write operations on multiple databases and collections in the same call. To learn more about this feature, see the Client Bulk Write section of the Bulk Operations guide.

What's New in 5.2

The 5.2 driver release includes the following new features, improvements, and fixes:

• Adds support for serializers from the kotlinx-datetime library that let you map Kotlin date and time types to BSON as the expected types instead of as strings. To learn more, see the Serialize Dates and Times section of the Kotlin Serialization guide.

• Supports serialization of JsonElement values. To work with the JsonElement type, you must add the kotlinx-serialization-json library as a dependency in your application.

What's New in 5.1.3

The 5.1.3 driver patch release includes the following changes:

What's New in 5.1.2

The 5.1.2 driver patch release includes the following changes:

• Support for encoding Kotlin data classes with nullable generic parameter types. For example, you can encode the Container class in the following code:

  @Serializable
  data class Box<T>(
      val boxed: T
  )
  @Serializable
  data class Container(
      val box: Box<String?>
  )

What's New in 5.1.1

The 5.1.1 driver patch release includes the following changes:

• When using the MONGODB-OIDC authentication mechanism, you must not include comma characters in the authMechanismProperties connection string value. To learn more about this behavior, see the MONGODB-OIDC section of the Enterprise Authentication guide.

What's New in 5.1

This section includes the following information:

• Deprecations in 5.1
• Improvements in 5.1
• New Features in 5.1

What's New in 5.0

New features of the 5.0 driver release include:

• The KotlinSerializerCodecProvider constructor now accepts serializersModule and bsonConfiguration objects:

  KotlinSerializerCodec.create(clazz.kotlin, serializersModule=serializersModule, bsonConfiguration=bsonConfiguration)

  This makes it easier to customize your configuration.

• Fixes a Kotlin reflection bug that resulted in container type erasure.

What's New in 4.11

This section includes the following information:

• Deprecations in 4.11
• New Features in 4.11

What's New in 4.10

• Support for Kotlin server-side usage, both for coroutines and for synchronous applications.

• Codec support for Kotlin data classes.

• Support for the kotlinx.serialization library