Add String-based JSON API to avoid unnecessary conversions (#3369) #3394
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add String overloads for jsonArrappend, jsonArrindex, jsonArrinsert - Add String overloads for jsonMerge, jsonSet, jsonStrappend - Implement direct String-to-bytes conversion in RedisJsonCommandBuilder - Update Async, Reactive, and Sync interfaces consistently - Eliminate String → JsonValue → String → bytes conversion overhead
- Add unit tests for all String overload methods - Verify direct string encoding optimization - Test both custom JsonPath and ROOT_PATH scenarios - Validate command construction for all String-based JSON operations
- Remove JavaDoc comments from RedisJsonCommandBuilder String methods to match class conventions - Update @author entries to use full names (SeungSu Kim) - Fix @SInCE annotation from 6.5 to 6.9 for new String overload methods - Restore blank lines and fix spacing to maintain consistent formatting - Align documentation style with existing codebase patterns
KoKimSS
force-pushed
the
feature/json-string-api
branch
from
7f263e2 to
cd1e1ae
Compare
Thank you so much! I'm really happy to contribute to lettuce, which I've been using regularly. Looking forward to @tishun's review to get this wrapped up! |
tishun
reviewed
Sep 2, 2025
src/main/java/io/lettuce/core/api/async/RedisJsonAsyncCommands.java
Outdated
Show resolved
Hide resolved
tishun
approved these changes
Sep 2, 2025
tishun
pushed a commit
to tishun/lettuce-core
that referenced
this pull request
Sep 2, 2025
… (redis#3394) * Add String-based JSON API to avoid unnecessary conversions redis#3369 - Add String overloads for jsonArrappend, jsonArrindex, jsonArrinsert - Add String overloads for jsonMerge, jsonSet, jsonStrappend - Implement direct String-to-bytes conversion in RedisJsonCommandBuilder - Update Async, Reactive, and Sync interfaces consistently - Eliminate String → JsonValue → String → bytes conversion overhead * Add comprehensive tests for String JSON API redis#3369 - Add unit tests for all String overload methods - Verify direct string encoding optimization - Test both custom JsonPath and ROOT_PATH scenarios - Validate command construction for all String-based JSON operations * Polish JSON API documentation and formatting redis#3369 - Remove JavaDoc comments from RedisJsonCommandBuilder String methods to match class conventions - Update @author entries to use full names (SeungSu Kim) - Fix @SInCE annotation from 6.5 to 6.9 for new String overload methods - Restore blank lines and fix spacing to maintain consistent formatting - Align documentation style with existing codebase patterns * CAE-1404 - finish String extension for JSON API * Fix since annotation on json string API * Rm useless comments in implementations and mark methods as Override * Rm more comments. * Format --------- Co-authored-by: aleksandar.todorov <a_t_todorov@yahoo.com>
tishun
pushed a commit
that referenced
this pull request
Sep 2, 2025
…3394) * Add String-based JSON API to avoid unnecessary conversions #3369 - Add String overloads for jsonArrappend, jsonArrindex, jsonArrinsert - Add String overloads for jsonMerge, jsonSet, jsonStrappend - Implement direct String-to-bytes conversion in RedisJsonCommandBuilder - Update Async, Reactive, and Sync interfaces consistently - Eliminate String → JsonValue → String → bytes conversion overhead * Add comprehensive tests for String JSON API #3369 - Add unit tests for all String overload methods - Verify direct string encoding optimization - Test both custom JsonPath and ROOT_PATH scenarios - Validate command construction for all String-based JSON operations * Polish JSON API documentation and formatting #3369 - Remove JavaDoc comments from RedisJsonCommandBuilder String methods to match class conventions - Update @author entries to use full names (SeungSu Kim) - Fix @SInCE annotation from 6.5 to 6.9 for new String overload methods - Restore blank lines and fix spacing to maintain consistent formatting - Align documentation style with existing codebase patterns * CAE-1404 - finish String extension for JSON API * Fix since annotation on json string API * Rm useless comments in implementations and mark methods as Override * Rm more comments. * Format --------- Co-authored-by: aleksandar.todorov <a_t_todorov@yahoo.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds String-based overloads for JSON commands to eliminate unnecessary conversion overhead between String ↔ JsonValue objects, addressing performance concerns raised in the feature request #3369.
Important Note
The existing JSON API assumes users only work with
JsonValueobjects. In certain cases, applications might want to provide a String interface instead, because otherwise they'd have to convert from string toJsonValueand then the driver would convert back to String and then to a byte array.This approach provides String-based overloads that work directly with String input/output parameters, instead of
JsonValueobjects, eliminating unnecessary conversions while maintaining full backward compatibility.Performance Benefits
String → JsonValue.of() → toString() → getBytes() → ByteBuffer.wrap() → array()String → getBytes()(direct conversion)Changes Made
New String Overload Methods Added
jsonArrappend(K key, JsonPath jsonPath, String... jsonStrings)jsonArrindex(K key, JsonPath jsonPath, String jsonString, JsonRangeArgs range)jsonArrinsert(K key, JsonPath jsonPath, int index, String... jsonStrings)jsonMerge(K key, JsonPath jsonPath, String jsonString)jsonSet(K key, JsonPath jsonPath, String jsonString, JsonSetArgs options)jsonStrappend(K key, JsonPath jsonPath, String jsonString)Core Implementation
Testing