|
| 1 | +--- |
| 2 | +title: 'Spring Data Azure Cosmos DB v5 for API for NoSQL release notes and resources' |
| 3 | +description: Learn about the Spring Data Azure Cosmos DB v5 for API for NoSQL, including release dates, retirement dates, and changes made between each version of the Azure Cosmos DB SQL Async Java SDK. |
| 4 | +author: rinatmini |
| 5 | +ms.service: cosmos-db |
| 6 | +ms.subservice: nosql |
| 7 | +ms.devlang: java |
| 8 | +ms.topic: reference |
| 9 | +ms.date: 07/24/2023 |
| 10 | +ms.author: kuthapar |
| 11 | +ms.custom: devx-track-java, ignite-2022, devx-track-extended-java |
| 12 | +--- |
| 13 | + |
| 14 | +# Spring Data Azure Cosmos DB v5 for API for NoSQL: Release notes and resources |
| 15 | +[!INCLUDE[NoSQL](../includes/appliesto-nosql.md)] |
| 16 | + |
| 17 | +[!INCLUDE[SDK selector](../includes/cosmos-db-sdk-list.md)] |
| 18 | + |
| 19 | +The Spring Data Azure Cosmos DB version 5 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. |
| 20 | + |
| 21 | +The [Spring Framework](https://spring.io/projects/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](https://spring.io/projects/spring-boot) extends this handling of the plumbing with an eye toward web application and microservices development. [Spring Data](https://spring.io/projects/spring-data) is a programming model and framework for accessing datastores like Azure Cosmos DB from the context of a Spring or Spring Boot application. |
| 22 | + |
| 23 | +You can use Spring Data Azure Cosmos DB in your applications hosted in [Azure Spring Apps](https://azure.microsoft.com/services/spring-apps/). |
| 24 | + |
| 25 | +## Version Support Policy |
| 26 | + |
| 27 | +### Spring Boot Version Support |
| 28 | + |
| 29 | +This project supports multiple Spring Boot Versions. Visit [spring boot support policy](https://github.com/Azure/azure-sdk-for-java/tree/feature/spring-boot-3/sdk/spring/azure-spring-data-cosmos#spring-boot-support-policy) for more information. Maven users can inherit from the `spring-boot-starter-parent` project to obtain a dependency management section to let Spring manage the versions for dependencies. Visit [spring boot version support](https://github.com/Azure/azure-sdk-for-java/tree/feature/spring-boot-3/sdk/spring/azure-spring-data-cosmos#spring-boot-version-support) for more information. |
| 30 | + |
| 31 | +### Spring Data Version Support |
| 32 | + |
| 33 | +This project supports different spring-data-commons versions. Visit [spring data version support](https://github.com/Azure/azure-sdk-for-java/tree/feature/spring-boot-3/sdk/spring/azure-spring-data-cosmos#spring-data-version-support) for more information. |
| 34 | + |
| 35 | +### Which Version of Azure Spring Data Azure Cosmos DB Should I Use |
| 36 | + |
| 37 | +Azure Spring Data Azure Cosmos DB library supports multiple versions of Spring Boot / Spring Cloud. Refer to [azure Spring Data Azure Cosmos DB version mapping](https://github.com/Azure/azure-sdk-for-java/tree/feature/spring-boot-3/sdk/spring/azure-spring-data-cosmos#which-version-of-azure-spring-data-cosmos-should-i-use) for detailed information on which version of Azure Spring Data Azure Cosmos DB to use with Spring Boot / Spring Cloud version. |
| 38 | + |
| 39 | +> [!IMPORTANT] |
| 40 | +> These release notes are for version 5 of Spring Data Azure Cosmos DB. |
| 41 | +> |
| 42 | +> Azure Spring Data Azure Cosmos DB SDK has dependency on the Spring Data framework, and supports only the API for NoSQL. |
| 43 | +> |
| 44 | +> See these articles for information about Spring Data on other Azure Cosmos DB APIs: |
| 45 | +> * [Spring Data for Apache Cassandra with Azure Cosmos DB](/azure/developer/java/spring-framework/configure-spring-data-apache-cassandra-with-cosmos-db) |
| 46 | +> * [Spring Data MongoDB with Azure Cosmos DB](/azure/developer/java/spring-framework/configure-spring-data-mongodb-with-cosmos-db) |
| 47 | +> |
| 48 | +
|
| 49 | +## Get started fast |
| 50 | + |
| 51 | + Get up and running with Spring Data Azure Cosmos DB by following our [Spring Boot Starter guide](/azure/developer/java/spring-framework/configure-spring-boot-starter-java-app-with-cosmos-db). The Spring Boot Starter approach is the recommended way to get started using the Spring Data Azure Cosmos DB connector. |
| 52 | + |
| 53 | + Alternatively, you can add the Spring Data Azure Cosmos DB dependency to your `pom.xml` file as shown below: |
| 54 | + |
| 55 | + ```xml |
| 56 | + <dependency> |
| 57 | + <groupId>com.azure</groupId> |
| 58 | + <artifactId>azure-spring-data-cosmos</artifactId> |
| 59 | + <version>latest-version</version> |
| 60 | + </dependency> |
| 61 | + ``` |
| 62 | + |
| 63 | +## Helpful content |
| 64 | + |
| 65 | +| Content | Link | |
| 66 | +|---|---| |
| 67 | +| **Release notes** | [Release notes for Spring Data Azure Cosmos DB SDK v5](https://github.com/Azure/azure-sdk-for-java/tree/feature/spring-boot-3/sdk/spring/azure-spring-data-cosmos/CHANGELOG.md) | |
| 68 | +| **SDK Documentation** | [Azure Spring Data Azure Cosmos DB SDK v5 documentation](https://github.com/Azure/azure-sdk-for-java/tree/feature/spring-boot-3/sdk/spring/azure-spring-data-cosmos/README.md) | |
| 69 | +| **SDK download** | [Maven](https://mvnrepository.com/artifact/com.azure/azure-spring-data-cosmos) | |
| 70 | +| **API documentation** | [Java API reference documentation](/java/api/overview/azure/spring-data-cosmos-readme?view=azure-java-stable&preserve-view=true) | |
| 71 | +| **Contribute to SDK** | [Azure SDK for Java Central Repo on GitHub](https://github.com/Azure/azure-sdk-for-java/tree/feature/spring-boot-3/sdk/spring/azure-spring-data-cosmos) | |
| 72 | +| **Get started** | [Quickstart: Build a Spring Data Azure Cosmos DB app to manage Azure Cosmos DB for NoSQL data](./quickstart-java-spring-data.md) <br> [GitHub repo with quickstart code](https://github.com/Azure-Samples/azure-spring-data-cosmos-java-sql-api-getting-started) | |
| 73 | +| **Basic code samples** | [Azure Cosmos DB: Spring Data Azure Cosmos DB examples for the API for NoSQL](samples-java-spring-data.md) <br> [GitHub repo with sample code](https://github.com/Azure-Samples/azure-spring-data-cosmos-java-sql-api-samples)| |
| 74 | +| **Performance tips**| [Performance tips for Java SDK v4 (applicable to Spring Data)](performance-tips-java-sdk-v4.md)| |
| 75 | +| **Troubleshooting** | [Troubleshoot Java SDK v4 (applicable to Spring Data)](troubleshoot-java-sdk-v4.md) | |
| 76 | +| **Azure Cosmos DB workshops and labs** |[Azure Cosmos DB workshops home page](https://aka.ms/cosmosworkshop) |
| 77 | + |
| 78 | +## Release history |
| 79 | +Release history is maintained in the azure-sdk-for-java repo, for detailed list of releases, see the [changelog file](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/spring/azure-spring-data-cosmos/CHANGELOG.md). |
| 80 | + |
| 81 | +## Recommended version |
| 82 | + |
| 83 | +It's strongly recommended to use version 5.3.0 and above. |
| 84 | + |
| 85 | +## Additional notes |
| 86 | + |
| 87 | +* Spring Data Azure Cosmos DB v5 supports only Java JDK 17 and above. |
| 88 | + |
| 89 | +## FAQ |
| 90 | + |
| 91 | +[!INCLUDE [cosmos-db-sdk-faq](../includes/cosmos-db-sdk-faq.md)] |
| 92 | + |
| 93 | +## Next steps |
| 94 | + |
| 95 | +Learn more about [Azure Cosmos DB](https://azure.microsoft.com/services/cosmos-db/). |
| 96 | + |
| 97 | +Learn more about the [Spring Framework](https://spring.io/projects/spring-framework). |
| 98 | + |
| 99 | +Learn more about [Spring Boot](https://spring.io/projects/spring-boot). |
| 100 | + |
| 101 | +Learn more about [Spring Data](https://spring.io/projects/spring-data). |
0 commit comments