Edit

Azure Cosmos DB Java SDK v4 for API for NoSQL: release notes and resources

  • Article

APPLIES TO: NoSQL

The Azure Cosmos DB Java SDK v4 for NoSQL combines an Async API and a Sync API into one Maven artifact. The v4 SDK brings enhanced performance, new API features, and Async support based on Project Reactor and the Netty library. Users can expect improved performance with Azure Cosmos DB Java SDK v4 versus the Azure Cosmos DB Async Java SDK v2 and the Azure Cosmos DB Sync Java SDK v2.

Important

These Release Notes are for Azure Cosmos DB Java SDK v4 only. If you are currently using an older version than v4, see the Migrate to Azure Cosmos DB Java SDK v4 guide for help upgrading to v4.

Here are three steps to get going fast!

  1. Install the minimum supported Java runtime, JDK 8 so you can use the SDK.
  2. Work through the Quickstart Guide for Azure Cosmos DB Java SDK v4 which gets you access to the Maven artifact and walks through basic Azure Cosmos DB requests.
  3. Read the Azure Cosmos DB Java SDK v4 performance tips and troubleshooting guides to optimize the SDK for your application.

The Azure Cosmos DB workshops and labs are another great resource for learning how to use Azure Cosmos DB Java SDK v4!

Helpful content

Content Link
Release Notes Release notes for Java SDK v4
SDK download Maven
API documentation Java API reference documentation
Contribute to SDK Azure SDK for Java Central Repo on GitHub
Get started Quickstart: Build a Java app to manage Azure Cosmos DB for NoSQL data
GitHub repo with quickstart code
Best Practices Best Practices for Java SDK v4
Basic code samples Azure Cosmos DB: Java examples for the API for NoSQL
GitHub repo with sample code
Console app with Change Feed Change feed - Java SDK v4 sample
GitHub repo with sample code
Web app sample Build a web app with Java SDK v4
GitHub repo with sample code
Performance tips Performance tips for Java SDK v4
Troubleshooting Troubleshoot Java SDK v4
Migrate to v4 from an older SDK Migrate to Java V4 SDK
Minimum supported runtime JDK 8
Azure Cosmos DB workshops and labs Azure Cosmos DB workshops home page

Important

  • The 4.13.0 release updates reactor-core and reactor-netty major versions to 2020.0.4 (Europium) release train.

Release history

Release history is maintained in the azure-sdk-for-java repo, for detailed list of releases, see the changelog file.

It's strongly recommended to use version 4.48.2 and above.

FAQ

How will I be notified of the retiring SDK?

Microsoft 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.

Next steps

To learn more about Azure Cosmos DB, see Microsoft Azure Cosmos DB service page.