Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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!
- Install the minimum supported Java runtime, JDK 8 so you can use the SDK.
- 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.
- 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 | GitHub repo with sample code |
| Console app with Change Feed | Change feed - Java SDK v4 sample GitHub repo with sample code |
| Web app sample | 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-coreandreactor-nettymajor versions to2020.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.
Recommended version
Please refer to the changelog file for the minimum version we strongly recommend using.
FAQ
How will I be notified of the retiring SDK?
Microsoft provides 12 months' advance notice before the end of support for the retiring SDK to help you smoothly transition to a supported SDK. You receive notifications through these 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 can use the to-be-retired Azure Cosmos DB SDK to author, deploy, and modify applications 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 no longer makes bug fixes, adds new features, or provides support for the retired SDK versions. If you choose not to upgrade, Azure Cosmos DB continues to serve requests sent from the retired versions of the SDK.
Which SDK versions will have the latest features and updates?
New features and updates are 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 still function, but you don'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 have 12 months to update your application. If you're not able to update by the retirement date, Azure Cosmos DB continues to serve requests sent from the retired versions of the SDK, so your running applications continue to function. But Azure Cosmos DB no longer makes bug fixes, adds new features, or provides support for 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 aren't always added to every SDK or connector immediately. If there's a feature that isn't supported that you'd like added, add feedback to our community forum.
Next steps
To learn more about Azure Cosmos DB, see Microsoft Azure Cosmos DB service page.