Draft API for connection and template layers for Redis JSON commands - #3327

Open

Dgramada wants to merge 22 commits into

spring-projects:mainfrom

Dgramada:topic/JSON-API-draft-for-connection-and-template-layer

Dgramada commented Mar 11, 2026

Contributor

Provides a draft version of how the JSON template and connection layer API should look like. The purpose of this PR is to receive feedback and to get a better feeling of what should Spring Data Redis provide for users that would like to use Redis JSON.

You have read the Spring Data contribution guidelines.
You use the code formatters provided here and have them applied to your changes. Don’t submit any formatting related changes.
You submit test cases (unit or integration tests) that back your changes.
You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).

spring-projects-issues added the status: waiting-for-triage label

mp911de marked this pull request as draft

March 12, 2026 14:03

onobc suggested changes

View reviewed changes

onobc left a comment

Contributor

👋🏻 @Dgramada ,

Thanks for the PR - it is great to see the feature being added. I have left a few comments to address / points to discuss.

src/main/java/org/springframework/data/redis/core/json/JsonArrayRange.java Outdated

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

src/main/java/org/springframework/data/redis/core/json/JsonPath.java Outdated

Dgramada commented Mar 20, 2026

Contributor Author

If the interfaces are acceptable, I could close this issue and create a separate one that introduces them alongside their implementations and testing. Would you prefer this approach or would you like me to extend this PR?

onobc reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/core/json/JsonPath.java Outdated

onobc commented Mar 20, 2026

Contributor

If the interfaces are acceptable,
I do - they are at a nice simple starting point.

I could close this issue and create a separate one that introduces them alongside their implementations and testing.
Would you prefer this approach or would you like me to extend this PR?

I would just rock this PR (continue on from this point).

Thank you for the quick turnaround - I was on PTO - sorry for the delay.

Dgramada force-pushed the topic/JSON-API-draft-for-connection-and-template-layer branch from 0680f61 to 275ca3e Compare

March 24, 2026 12:56


          Implemented connection and template layer interfaces for Redis JSON o…

2f2f6d3

…perations.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Dgramada force-pushed the topic/JSON-API-draft-for-connection-and-template-layer branch from 275ca3e to 2f2f6d3 Compare

March 24, 2026 13:02

onobc reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

onobc reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated


          Added Lettuce implementation. Added Jedis dummy implementation classe…

e63aec8

…s. Added connection layer logic for blocking layer. Removed redundant asserts in RedisJsonCommands default methods.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

onobc reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

src/main/java/org/springframework/data/redis/core/JsonOperations.java Outdated

Dgramada added 4 commits

March 25, 2026 12:42


          Added class level Javadoc clarification for why List is used as a ret…

d2c9b54

…urn type in multiple RedisJsonCommands methods.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Removed JsonOperations. Added root path to RedisJsonCommands. Added j…

dbd5953

…sonCommands overload to RedisConnectionUnitTests. Updated @SInCE to 4.1.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Added testing. Improved documentation.

f2a7725

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Fixed GH number in tests.

35c13be

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

onobc self-requested a review

March 27, 2026 19:43

onobc suggested changes

View reviewed changes

onobc left a comment

Contributor

👋🏻 @Dgramada I left a couple comments to address. Thanks.

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

src/test/java/org/springframework/data/redis/connection/AbstractConnectionIntegrationTests.java Outdated

Dgramada added 6 commits

March 30, 2026 18:11


          Fixed tests. Improved documentation.

be5e478

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Improved Java doc.

a728207

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Merge branch 'main' into topic/JSON-API-draft-for-connection-and-temp…

083a639

…late-layer


          Removed jsonArrAppend() as it is broken in Lettuce.

c2889ac

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Added Jedis implementation of commands. Fixed bugs. Removed broken co…

a0cee8d

…mmands.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Merge remote-tracking branch 'upstream/main' into topic/JSON-API-draf…

5e6f335

…t-for-connection-and-template-layer

Dgramada marked this pull request as ready for review

April 22, 2026 14:35

Dgramada added 3 commits

April 27, 2026 14:53


          Merge remote-tracking branch 'upstream/main' into topic/JSON-API-draf…

9fc97e3

…t-for-connection-and-template-layer


          Fixed import order. Updated version to 4.2. Made command classes Null…

ef3afd2

…Unmarked.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Added JSON module loading in config file for master container.

c0e32c7

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

viktoriya-kutsarova reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/jedis/JedisJsonCommands.java Outdated

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java Outdated

src/main/java/org/springframework/data/redis/connection/RedisJsonCommands.java

viktoriya-kutsarova reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/jedis/JedisConverters.java Outdated

Dgramada added 2 commits

May 27, 2026 16:51


          Replaced JsonSetOption enum with JsonSetCondition.

3e9e992

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Removed jsonNumIncrBy. Postponing it for a future contribution as cur…

0dffc92

…rently Jedis has a very inconsistent API compared to Lettuce and changes the data type. Added safely encoded strings to JedisJsonCommands for value params

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Dgramada mentioned this pull request

RedisConnection.execute() throws UnsupportedOperationException for commands returning integer RESP type (e.g. RedisJSON JSON.DEL) #3370

Closed

Dgramada added 3 commits

May 29, 2026 14:16


          Updated javadoc in RedisJsonCOmmands

182a9ee

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Updated jsonType to return null instead of UNKNOWN.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>


          Renamed values to rawJsonValues.

7b7c0a2

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

mp911de commented Jun 3, 2026

Member

I think we're closing in on a first solid design here. I'd suggest drawing some inspiration from 28f5665 (on the Json branch in this repository), particularly around JsonValue. There ought to be a JsonType (analogous to DataType) residing in the connection.json package, alongside JsonValue itself. We may well reuse JsonType later on within JsonResult.

I'd propose finalizing the JsonCommands parts first, so that we can then approach JsonOperations and JsonTemplate as a separate, second step. Splitting the effort into two pieces keeps the complexity manageable on both ends.


          Added JsonValue interface.

c281619

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

viktoriya-kutsarova reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/json/JsonValue.java Outdated


          Polishing.

ac06b5f

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

viktoriya-kutsarova reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/json/LiteralJsonValue.java

viktoriya-kutsarova reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/json/JsonValue.java

viktoriya-kutsarova reviewed

View reviewed changes

src/main/java/org/springframework/data/redis/connection/json/JsonValue.java

mp911de added type: enhancement and removed status: waiting-for-triage labels

Dgramada mentioned this pull request

Add support for Redis JSON #3390

Open

4 tasks

Dgramada commented Jun 29, 2026

Contributor Author

Both the branch and pull request have become quite bloated. I created a new clean branch with all the current code plus the template layer built on top of it. We can close this pull request and continue with the new clean pull request.

mp911de force-pushed the main branch 2 times, most recently from e0163c7 to 5e76bfb Compare

August 5, 2026 14:13

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: enhancement