Spring Data Azure Cosmos DB v2 for API for NoSQL (legacy): Release notes and resources

APPLIES TO: NoSQL

Spring Data Azure Cosmos DB version 2 for NoSQL allows developers to use Azure Cosmos DB in Spring applications. Spring Data Azure Cosmos DB exposes the Spring Data interface for manipulating databases and collections, working with documents, and issuing queries. Both Sync and Async (Reactive) APIs are supported in the same Maven artifact.

The Spring Framework is a programming and configuration model that streamlines Java application development. Spring streamlines the "plumbing" of applications by using dependency injection. Many developers like Spring because it makes building and testing applications more straightforward. Spring Boot extends this handling of the plumbing with an eye toward web application and microservices development. Spring Data is a programming model for accessing datastores like Azure Cosmos DB from the context of a Spring or Spring Boot application.

You can use Spring Data Azure Cosmos DB in your applications hosted in Azure Spring Apps.

• Updates Spring Boot version to 2.3.0.

• Updates Azure Cosmos DB version to 3.7.3.

• Contains memory leak fixes and Netty version upgrades from Azure Cosmos DB SDK 3.7.3.

• Fixes allowTelemetry flag to take into account from CosmosDbConfig.
• Fixes TTL property on container.

• Adds new findAll by partition key API.
• Updates Azure Cosmos DB version to 3.7.0.

• Fixes collectionName -> containerName.
• Fixes entityClass and domainClass -> domainType.
• Fixes "Return entity collection saved by repository instead of input entity."

• Backports fix for "Return entity collection saved by repository instead of input entity."

• Updates Azure Cosmos DB version to 3.6.0.

• Updates Azure Cosmos DB SDK version to 3.5.0.
• Adds annotation field to enable or disable automatic collection creation.
• Improves exception handling. Exposes CosmosClientException through CosmosDBAccessException.
• Exposes requestCharge and activityId through ResponseDiagnostics.

• SDK 3.5.0 update fixes "Exception when Azure Cosmos DB HTTP response header is larger than 8192 bytes," "ConsistencyPolicy.defaultConsistencyLevel() fails on Bounded Staleness and Consistent Prefix."
• Fixes findById method's behavior. Previously, this method returned empty if the entity wasn't found instead of throwing an exception.
• Fixes a bug in which sorting wasn't applied on the next page when CosmosPageRequest was used.

• Adds annotation field to enable or disable automatic collection creation.

• Fixes findById method's behavior. Previously, this method returned empty if the entity wasn't found instead of throwing an exception.

• Complete Reactive Azure Cosmos DB Repository support.
• Azure Cosmos DB Request Diagnostics String and Query Metrics support.
• Azure Cosmos DB SDK version update to 3.3.1.
• Spring Framework version upgrade to 5.2.0.RELEASE.
• Spring Data Commons version upgrade to 2.2.0.RELEASE.
• Adds findByIdAndPartitionKey and deleteByIdAndPartitionKey APIs.
• Removes dependency from azure-documentdb.
• Rebrands DocumentDB to Azure Cosmos DB.

• Fixes "Sorting throws exception when pageSize is less than total items in repository."

• Deprecates DocumentDB APIs.
• Adds findByIdAndPartitionKey and deleteByIdAndPartitionKey APIs.
• Adds optimistic locking based on _etag.
• Enables SpEL expression for document collection name.
• Adds ObjectMapper improvements.

• Adds Azure Cosmos DB SDK version 3 dependency.
• Adds Reactive Azure Cosmos DB Repository.
• Updates implementation of DocumentDbTemplate to use Azure Cosmos DB SDK version 3.
• Adds other configuration changes for Reactive Azure Cosmos DB Repository support.

• Removes applicationInsights dependency for:
  • Potential risk of dependencies polluting.
  • Java 11 incompatibility.
  • Avoiding potential performance impact to CPU and/or memory.

• Backport removes applicationInsights dependency for:
  • Potential risk of dependencies polluting.
  • Java 11 incompatibility.
  • Avoiding potential performance impact to CPU and/or memory.

• Updates main version to 2.1.1.

• Ignore all exceptions from telemetry.

• Updates version to 2.1.0 to address problem.

• Adds keywords exists and startsWith.
• Updates Readme.

• Fixes "Can't call self href directly for Entity."
• Fixes "findAll will fail if collection is not created."

• Renames package from documentdb to cosmosdb.
• Adds new feature of query method keyword. 16 keywords from API for NoSQL are now supported.
• Adds new feature of query with paging and sorting.
• Simplifies the configuration of spring-data-cosmosdb.
• Adds deleteCollection and deleteAll APIs.

• Bug fix and defect mitigation.

How will I be notified of the retiring SDK?

Azure will provide 12 month's advance notice before the end of support of the retiring SDK to facilitate a smooth transition to a supported SDK. We'll notify you through various communication channels: the Azure portal, Azure updates, and direct communication to assigned service administrators.

Can I author applications by using a to-be-retired Azure Cosmos DB SDK during the 12-month period?

Yes, you'll be able to author, deploy, and modify applications by using the to-be-retired Azure Cosmos DB SDK during the 12-month notice period. We recommend that you migrate to a newer supported version of the Azure Cosmos DB SDK during the 12-month notice period, as appropriate.

After the retirement date, what happens to applications that use the unsupported Azure Cosmos DB SDK?

After the retirement date, Azure Cosmos DB will no longer make bug fixes, add new features, or provide support to the retired SDK versions. If you prefer not to upgrade, requests sent from the retired versions of the SDK will continue to be served by the Azure Cosmos DB service.

Which SDK versions will have the latest features and updates?

New features and updates will be added only to the latest minor version of the latest supported major SDK version. We recommend that you always use the latest version to take advantage of new features, performance improvements, and bug fixes. If you're using an old, non-retired version of the SDK, your requests to Azure Cosmos DB will still function, but you won't have access to any new capabilities.

What should I do if I can't update my application before a cutoff date?

We recommend that you upgrade to the latest SDK as early as possible. After an SDK is tagged for retirement, you'll have 12 months to update your application. If you're not able to update by the retirement date, requests sent from the retired versions of the SDK will continue to be served by Azure Cosmos DB, so your running applications will continue to function. But Azure Cosmos DB will no longer make bug fixes, add new features, or provide support to the retired SDK versions.

If you have a support plan and require technical support, contact us by filing a support ticket.

How can I request features be added to an SDK or connector?

New features are not always added to every SDK or connector immediately. If there is a feature not supported that you would like added, please add feedback to our community forum.

Learn more about Azure Cosmos DB.

Learn more about the Spring Framework.

Learn more about Spring Boot.

Learn more about Spring Data.