spring custom query with cosmos template

[TheovanKraay]

Purpose

Show example of how to run custom queries using the raw Cosmos DB SQL API query syntax with CosmosTemplate

• ...

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:

How to Test

• Get the code

git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install

• Test the code

What to Check

Verify that the following are valid

• ...

Other Information

[kushagraThapar]

Requesting some changes!
I am curious to know the use case for executing this simple custom query through cosmosTemplate. This query can be easily executed through @Query annotation. There is no value in autowiring CosmosTemplate if not needed. It might add additional complexity.

One use case that I have constantly seen and asked for is how to construct query through Criteria object in spring-data-cosmos, which is also a pretty generic thing to do in spring-data. Criteria class should be able to define what all a customer needs for a query. And then let spring-data-cosmos SDK execute that criteria in a query form.

Some examples are here -

https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java#L449

https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java#L495

https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java#L610

https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java#L640

Additional PR for some more details on criteria development and usage - Azure/azure-sdk-for-java#30379

[TheovanKraay]

Fair point, I will come up with a query that cannot be executed using @query or Criteria. Point is, customers want to be able to just inject the SQL API query rather than follow the Criteria or @query pattern in some cases (because it doesn't support what they want, or even because it is cumbersome).