v5.2.0: 5.2.0 GA

Compare Source

Enhanced Client-side caching

We are happy to announce that improvedserver-assisted, client-side caching is now generally available! Special thanks to all our beta testers for their valuable feedback, which helped us refine and improve the initial implementation.

Client-side caching is supported exclusively with the RESP3 protocol with Redis >= 7.4 and is available in UnifiedJedis, JedisPooled, and JedisCluster and other classes.

How to try Client-Side Caching

1. Install Jedis5.2.0
2. Use the following code example to get started:

publicclassCSCExampleTest {publicstaticvoidmain() {HostAndPortnode =HostAndPort.from("localhost:6379");JedisClientConfigclientConfig =DefaultJedisClientConfig.builder()        .resp3()// RESP3 protocol is required for client-side caching//.user("myuser")       // Redis server username (optional)//.password("mypass")   // Redis user's password (optional)        .build();CacheConfigcacheConfig =getCacheConfig();Cachecache =CacheFactory.getCache(cacheConfig);try (UnifiedJedisclient =newUnifiedJedis(node,clientConfig,cache)) {client.set("foo","bar");client.get("foo");client.get("foo");// Cache hitSystem.out.println("Cache size: " +cache.getSize());// 1System.out.println(cache.getStats().toString());//Let's change the value of "foo" to invalidate the value stored in the local cacheclient.mset("foo","new_value","ignore_me:1","another_value");Thread.sleep(1000);// wait for the cache invalidation to happenSystem.out.println(client.get("foo"));// Cache missSystem.out.println(cache.getStats().toString());client.get("ignore_me:1");// Client will ignore this keySystem.out.println("Cache size: " +cache.getSize());// still 1// check the cache statsSystem.out.println(cache.getStats().toString());    }catch (InterruptedExceptione) {thrownewRuntimeException(e);    }  }privatestaticCacheConfiggetCacheConfig() {// This is a simple cacheable implementation that ignores keys starting with "ignore_me"Cacheablecacheable =newDefaultCacheable() {finalStringIGNORE_PREFIX ="ignore_me";@&#8203;OverridepublicbooleanisCacheable(ProtocolCommandcommand,List<Object>keys) {// assuming we'll only execute methods with string keysList<String>stringKeys =keys.stream()            .filter(obj ->objinstanceofString)            .map(obj -> (String)obj)            .collect(Collectors.toList());for (Stringkey :stringKeys) {if (key.startsWith(IGNORE_PREFIX)) {returnfalse;          }        }returnisDefaultCacheableCommand(command);      }    };// Create a cache with a maximum size of 10000 entriesreturnCacheConfig.builder()        .maxSize(10000)        .cacheable(cacheable)        .build();  }}

It is possible to limit or ignore commands or keys for client-side caching. ThegetCacheConfig method presented above provides an example of how to achieve that.

🔥 Breaking Changes

• JedisConnectionException contains HostAndPort from DefaultJedisSocketFactory (#​3896)
• Address change in JSON.GET command without path (#​3858)
• Modify and fail-fast GeoSearchParam (#​3827)
• Support transaction from UnifiedJedis without calling multi first (#​3804)
• Reduce the log level of validateObject to WARN (#​3750)

🧪 Experimental Features

• Support automatic namespacing (#​3781)
• Added support for ADDSCORES argument in FT.AGGREGATE (#​3908)
• Support IGNORE and other optional arguments for timeseries commands (#​3860)

🚀 New Features

• Support Hash field expiration (#​3826)
• Add equals and hashCode to Timeseries Params classes (#​3959)
• Decoding FT.SEARCH reply can be disabled at field level (#​3926)
• Get enriched Connection information (#​3745)
• Support execute the read-only command on replica nodes (#​3848)
• JedisConnectionException contains HostAndPort from DefaultJedisSocketFactory (#​3896)
• Support [S]PUBLISH in pipelines and transactions (#​3859)
• Support Hash field expiration (#​3826)
• Custom connection pool to MultiClusterPooledConnectionProvider (#​3801)
• PubSub handle array of messages for RESP2 (#​3811)
• Support transaction from UnifiedJedis without calling multi first (#​3804)
• Add last entry id for XREADs and support XREADs reply as map (#​3791)
• Add Experimental, Internal and VisibleForTesting annotations (#​3790)
• Implement equals and hashcode in Params classes (#​3728)
• Add support for redis command: CLIENT TRACKINGINFO (#​3751)
• Support the MAXAGE option for CLIENT KILL (#​3754)
• Polish#​3741 (#​3746)
• Add support for the NOVALUES option of HSCAN (#​3741)
• Support issuing Latency commands (#​3729)

🐛 Bug Fixes

• Accept null replies for BZPOPMAX and BZPOPMIN commands (#​3930)
• Fix empty LUA table reply (#​3924)
• Ensure closing connection in Pipeline (#​3865)
• Address change in JSON.GET command without path (#​3858)
• Consider null values in empty StreamPendingSummary (#​3793)
• Fix UnifiedJedis pexpireAt glitch (#​3782)
• Use expiryOption in PipelineBase.expireAt (#​3777)
• Stop connection fetching before sync/exec (#​3756)
• Check for thread interrupt in subscribe process of PubSub (#​3726)
• Avoid NPE in MultiNodePipelineBase.java (#​3697)
• Fix probable missing (RESP3) protocol processing (#​3692)
• Use circuit breaker fallback exception list (#​3664)

🧰 Maintenance

• Deprecate Triggers and Functions feature (#​3968)
• Bump org.apache.httpcomponents.client5:httpclient5-fluent from 5.3.1 to 5.4 (#​3962)
• Bump org.apache.maven.plugins:maven-surefire-plugin from 3.3.1 to 3.5.0 (#​3950)
• Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.8.0 to 3.10.0 (#​3949)
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.5 to 3.2.6 (#​3957)
• Added JavaDoc for basic JedisCluster constructors (#​3304)
• Bump org.locationtech.jts:jts-core from 1.19.0 to 1.20.0 (#​3948)
• Add A-A failover scenario test (#​3935)
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.4 to 3.2.5 (#​3936)
• Fix codecov upload (#​3933)
• Rename readonly config param to specify Redis Cluster (#​3932)
• Modify Connection.toIdentityString and test (#​3931)
• Revert "Creating CODEOWNERS for the examples (#​3570)" (#​3897)
• Bump org.apache.maven.plugins:maven-surefire-plugin from 3.2.5 to 3.3.1 (#​3891)
• Bump org.hamcrest:hamcrest from 2.2 to 3.0 (#​3914)
• Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.7.0 to 3.8.0 (#​3909)
• Bump net.javacrumbs.json-unit:json-unit from 2.38.0 to 2.40.1 (#​3903)
• Bump org.apache.maven.plugins:maven-release-plugin from 3.0.1 to 3.1.1 (#​3890)
• Fixed typo in Javadoc (#​3917)
• Bump org.apache.maven.plugins:maven-jar-plugin from 3.4.1 to 3.4.2 (#​3910)
• Bump com.kohlschutter.junixsocket:junixsocket-core from 2.9.1 to 2.10.0 (#​3901)
• Bump jackson.version from 2.17.1 to 2.17.2 (#​3902)
• Add Scenario tests (#​3847)
• Modify the judgment that reads a response as empty to isEmpty method (#​3888)
• Replacesynchronized withj.u.c.l.ReentrantLock for Loom (#​3480)
• Extract messages of unsupported exception as constants (#​3887)
• Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.3 to 3.7.0 (#​3851)
• Bump org.sonatype.plugins:nexus-staging-maven-plugin from 1.6.13 to 1.7.0 (#​3850)
• Bump com.google.code.gson:gson from 2.10.1 to 2.11.0 (#​3842)
• Merge doc tests into main branch to keep in-sync with the code (#​3861)
• Deprecate unused Set builders (#​3857)
• Disable Redis Graph tests (#​3856)
• Introduce EndpointConfig and load endpoint settings from the endpoints.json file (#​3836)
• Address Gears test fail - Cleanup Function libraries (#​3840)
• Bump jackson.version from 2.17.0 to 2.17.1 (#​3833)
• Add methods in CommandArguments and RawableFactory (#​3834)
• Modify and fail-fast GeoSearchParam (#​3827)
• Bump org.apache.maven.plugins:maven-jar-plugin from 3.4.0 to 3.4.1 (#​3822)
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.3 to 3.2.4 (#​3823)
• Bump org.apache.maven.plugins:maven-jar-plugin from 3.3.0 to 3.4.0 (#​3819)
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.2 to 3.2.3 (#​3818)
• Add more tests for the CommandObjects class (#​3809)
• Resolve compile warnings (#​3810)
• Bump com.kohlschutter.junixsocket:junixsocket-core from 2.9.0 to 2.9.1 (#​3806)
• Bump org.jacoco:jacoco-maven-plugin from 0.8.11 to 0.8.12 (#​3805)
• Bump org.apache.maven.plugins:maven-source-plugin from 3.3.0 to 3.3.1 (#​3807)
• Deprecate unused JSON.ARRAPPEND in CommandObjects (#​3798)
• Extensive unit tests for the CommandObjects class (#​3796)
• Add extensive tests for UnifiedJedis (#​3788)
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.1 to 3.2.2 (#​3794)
• Add Experimental, Internal and VisibleForTesting annotations (#​3790)
• Add TS.INFO [DEGUB] and CF.MEXISTS in pipelined commands (#​3787)
• Bump org.apache.maven.plugins:maven-compiler-plugin from 3.12.1 to 3.13.0 (#​3786)
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.0 to 3.2.1 (#​3785)
• Pipelined tests for lists and sets, and API typo fix (#​3772)
• Extensive unit tests for PipeliningBase (#​3778)
• Bump jackson.version from 2.16.2 to 2.17.0 (#​3776)
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.1.0 to 3.2.0 (#​3775)
• Fix typo in SetPipelineCommands method name (#​3773)
• Streamline test execution (#​3760)
• Add pipelined tests for sorted sets (#​3771)
• Geo pipelined tests (#​3767)
• Reenable clustering tests (#​3764)
• GETSET command is deprecated since Redis 6.2.0 (#​3768)
• Add tests for Stream pipelined commands (#​3763)
• Bump jackson.version from 2.16.1 to 2.16.2 (#​3762)
• Bump org.json:json from2024020 to2024030 (#​3752)
• Add Hashes pipeline commands unit tests (#​3288)
• Add unit tests for pipelining - migrate and db commands (#​3759)
• Reduce the log level of validateObject to WARN (#​3750)
• Bump org.json:json from2023101 to2024020 (#​3706)
• Bump com.kohlschutter.junixsocket:junixsocket-core from 2.8.3 to 2.9.0 (#​3724)
• Running doctests also on emb-examples (#​3693)
• Bump org.apache.maven.plugins:maven-surefire-plugin from 3.2.3 to 3.2.5 (#​3688)
• Run integration workflow for 5.2.0 branch (#​3681)
• Bump jackson.version from 2.16.0 to 2.16.1 (#​3666)
• Bump org.apache.maven.plugins:maven-compiler-plugin from 3.11.0 to 3.12.1 (#​3665)
• Spellcheck as part of CI (#​3492)
• Adding stale issues workflow (#​3528)
• Creating CODEOWNERS for documentation (#​3570)
• Unifying GitHub tokens (#​3650)
• Replace deprecated set-output command with environment file (#​3622)
• Fixing GPG key usage (#​3670)
• Bump maven-surefire-plugin to 3.2.3 (#​3656)
• Bump org.jacoco:jacoco-maven-plugin from 0.8.5 to 0.8.11 (#​3653)
• Bump jackson databind and jsr310 to 2.16.0 (#​3655)
• Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.2 to 3.6.3 (#​3639)
• Bump com.kohlschutter.junixsocket:junixsocket-core from 2.8.1 to 2.8.3 (#​3647)
• Access Reducer attributes (#​3637)
• Address RediSearch profile change (#​3636)

Contributors

We'd like to thank all the contributors who worked on this release!

@​Gandalf1783,@​Lcarrot,@​SoilChang,@​andy-stark-redis,@​ascdi,@​babanin,@​cemasma,@​chayim,@​dependabot,@​dependabot[bot],@​gerzse,@​jjz921024,@​jongwooo,@​sazzad16,@​stillerrr,@​thachlp,@​uglide,@​vanta and@​zyfx595701088

v5.1.5: 5.1.5

Compare Source

Changes

🐛 Bug Fixes

• Accept null replies for BZPOPMAX and BZPOPMIN commands (#​3930)
• Fix empty LUA table reply (#​3924)

Contributors

We'd like to thank all the contributors who worked on this release!

@​JW-Vinay,@​ngavrailov and@​sazzad16

v5.1.4: 5.1.4

Compare Source

Changes

🔥 Breaking Changes

• Address change in JSON.GET command without path (#​3858)
• Modify and fail-fast GeoSearchParam (#​3827)

🚀 New Features

• Support Hash field expiration (#​3826)
• Support issuing Latency commands (#​3729)
• Add support for the NOVALUES option of HSCAN command (#​3741,#​3746)
• Add support for CLIENT TRACKINGINFO command (#​3751)
• Support IGNORE and other optional arguments for timeseries commands (#​3860,#​3863)
• Add last entry id for XREADs and support XREADs reply as map (#​3791)
• Support the MAXAGE option for CLIENT KILL (#​3754)
• Support ADDSCORES argument in FT.AGGREGATE (#​3908)
• Support [S]PUBLISH in pipelines and transactions (#​3859)

🐛 Bug Fixes

• Ensure closing connection in Pipeline (#​3865)
• Address change in JSON.GET command without path (#​3858)

🧰 Maintenance

• Add methods in CommandArguments and RawableFactory (#​3834)
• Modify and fail-fast GeoSearchParam (#​3827)

Contributors

We'd like to thank all the contributors who worked on this release!

@​sazzad16,@​cemasma,@​Lcarrot,@​gerzse and@​uglide

v5.1.3: 5.1.3

Compare Source

Changes

🚀 New Features

• Custom connection pool to MultiClusterPooledConnectionProvider (#​3801)

🐛 Bug Fixes

• Consider null values in empty StreamPendingSummary (#​3793)
• Fix UnifiedJedis pexpireAt glitch (#​3782)
• Use expiryOption in PipelineBase.expireAt (#​3777)

🧰 Maintenance

• Add TS.INFO [DEGUB] and CF.MEXISTS in pipelined commands (#​3787)
• Fix typo in SetPipelineCommands method name (#​3773)
• Bump jackson.version from 2.16.1 to 2.16.2 (#​3762)

Contributors

We'd like to thank all the contributors who worked on this release!

@​gerzse,@​sazzad16,@​thachlp and@​jarkus4

v5.1.2: 5.1.2

Compare Source

Changes

🐛 Bug Fixes

• Stop connection fetching before sync/exec in multi cluster failover mode (#​3756)

v5.1.1: 5.1.1

Compare Source

Changes

🐛 Bug Fixes

• Avoid NPE in MultiNodePipelineBase.java (#​3697)
• Fix probable missing (RESP3) protocol processing (#​3692)
• Use circuit breaker fallback exception list (#​3664)

🧰 Maintenance

• Access Reducer attributes (#​3637)
• Replace deprecated set-output command with environment file (#​3622)
• Bump jackson.version from 2.16.0 to 2.16.1 (#​3666)
• Bump jackson databind and jsr310 to 2.16.0 (#​3655)
• Bump com.kohlschutter.junixsocket:junixsocket-core from 2.8.1 to 2.8.3 (#​3647)

Contributors

We'd like to thank all the contributors who worked on this release!

@​dependabot,@​dependabot[bot],@​jongwooo,@​sazzad16 and@​stillerrr

v5.1.0: 5.1.0

Compare Source

Changes

🔥 Breaking Changes

• Adding Pipeline & Transaction with failover to multi cluster (#​3602)
• Move JedisMetaInfo into parent package and made private (#​3590)
• Encode map in encoded object (#​3555)

🧪 Experimental Features

• Pipeline & Transaction with failover to multi cluster (#​3602)
• Support GEOSHAPE field type in RediSearch (#​3561)
• Re-add FT.DROPINDEX and FT.ALTER in pipeline (#​3549)

🚀 New Features

• Add CLUSTER SHARDS command support (#​2984) (#​3598)
• Added HSET variants to ease complex objects (#​3605)
• Introducing periodic topology mechanism for JedisCluster (#​3596)
• Support RESET command (#​3015)
• Broadcast FUNCTION LOAD command methods (#​3557)
• Feature: Triggers and functions commands (#​3531)
• Escape utils for RediSearch queries (#​3544)
• Address further CLIENT SETINFO suffix rules (#​3536)
• Extend CLIENT SETINFO support (#​3509)

🐛 Bug Fixes

• Direct FT.CREATE to proper node in LIGHT search mode (#​3593)
• Fix binary variants of XRANGE and XREAD commands (#​3571)

🧰 Maintenance

• Use simple version of HSET (#​3587)
• Linking to Redis learning resources (#​3583)
• Added support for releasing minor version snapshots (#​3578)
• Allow getting schema field name (#​3576)
• Encoded map in encoded object (#​3555)
• Improved Triggers and functions tests (#​3554)
• Different variable names for json v1 and v2 interfaces (#​3553)
• Fixed Search/Gears test regression (#​3552)
• Improved Triggers and functions commands (#​3551)
• Added JavaDoc for GeoRadiusResponse (#​3542)
• Disabling doctests on tag (#​3524)
• Move pom.properties file into redis.clients.jedis package (#​3589)
• Bump org.json:json from2023061 to2023101 (#​3586)
• Bump org.apache.commons:commons-pool2 from 2.11.1 to 2.12.0 (#​3565)
• Bump junixsocket-core to 2.8.1 (#​3573)
• Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.5.0 to 3.6.0 (#​3539)
• Bump mockito-inline from 3.12.4 to 4.11.0 (#​3232)
• Bump org.apache.maven.plugins:maven-surefire-plugin from 3.2.1 to 3.2.2 (#​3611)
• Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.0 to 3.6.2 (#​3612)
• Bump org.apache.maven.plugins:maven-surefire-plugin from 3.1.2 to 3.2.1 (#​3600)

Contributors

We'd like to thank all the contributors who worked on this release!

@​bsbodden,@​chayim,@​dependabot,@​dependabot[bot],@​ihaohong,@​sazzad16,@​wormogig and@​yangbodong22011

v5.0.2: 5.0.2

Compare Source

Changes

🐛 Bug Fixes

• Fix SORTABLE argument when creating a Search index using FT.CREATE (#​3584)
• Fix binary variants of XRANGE and XREAD commands (#​3571)

🚀 New Features

• Added broadcast support for FUNCTION LOAD methods (#​3557)
• Support GEOSHAPE field type in RediSearch (#​3561)

🧰 Maintenance

• Bump org.json:json from2023061 to2023101 (#​3586)
• Move pom.properties file into redis.clients.jedis package (#​3589)
• Warning about JedisMetaInfo movement (#​3591)
• Allow getting schema field name (#​3576)

v5.0.1: 5.0.1

Compare Source

Changes

🔥 Breaking Changes

• Encode map in encoded object (#​3555)
  • In the 5.0.0 release, the encoded/String variants of scripting methods returnList<KeyValue<>> for a map reply - those now returnMap<>.

🚀 New Features

• Extend CLIENT SETINFO support with added suffix rules (#​3509,#​3536)
• Added quote escaping helper functions for search queries (#​3544)

🧰 Maintenance

• Re-enabled FT.DROPINDEX and FT.ALTER in pipeline (#​3549)
• Added JavaDoc for GeoRadiusResponse (#​3542)

Contributors

We'd like to thank all the contributors who worked on this release!

@​sazzad16

v5.0.0: 5.0.0

Compare Source

What's New?

Automatic Cross-Cluster Failover

We're happy to introduce the Cross-Cluster Failover feature in Jedis. This feature provides high availability and resilience by allowing seamless transitions between Redis clusters during unforeseen failures or downtimes. It's a built-in tool to minimize manual intervention and downtime and ensure a more resilient application infrastructure.
Learn more about how you can automate the failover process inour documentation.

FullRedis 7.2 andRESP3 Support

Examples to enable RESP3 are included later in this release note.

Changes

🔥 Breaking Changes (Listed here)

🚀 New Features

• Support RESP3 (#​3293,#​3387,#​3388,#​3389,#​3403,#​3507)
• Support Sharded PubSub (#​3396)
• Introduce PipelineBase for Pipeline and multi node pipeline classes (#​3437,#​3442)
• 'double' timeout parameter for BLMPOP and BZMPOP commands (#​3444)

🧪 Experimental Features

• Cross cluster failover (#​3310)
• Allow setting default dialect for RediSearch module (#​3452)
• Support JSON.MERGE command (#​3429)
• Support TOPK.LIST with WITHCOUNT option (#​3495)

🐛 Bug Fixes

• Fix return value of HRANDFIELD with values when count is negative (#​3425,#​3430)
• Return List instead of Set in ZDIFF, ZINTER, ZUNION commands (#​3431)

🧰 Maintenance

• Deprecate RedisJSON v1 support (#​3503)
• Deprecate RedisGraph support (#​3504)
• Deprecate Sharding/Sharded feature (#​3386)
• Bump org-json:json from2023022 to2023061 (#​3472)

RESP3 Examples

This release introduces enabling RESP3 Redis connection, when the Redis server supports it.

1. Enable RESP3 to a UnifiedJedis object:

importredis.clients.jedis.DefaultJedisClientConfig;importredis.clients.jedis.HostAndPort;importredis.clients.jedis.UnifiedJedis;classDoResp3 {publicstaticvoidmain() {HostAndPorthnp =HostAndPort.from("localhost:6379");UnifiedJedisc =UnifiedJedis(hnp,DefaultJedisClientConfig.builder().resp3().build());c.set("foo","value!");c.get("foo");    }}

2. Enable RESP3 to a Jedis object:

importredis.clients.jedis.DefaultJedisClientConfig;importredis.clients.jedis.HostAndPort;importredis.clients.jedis.Jedis;classDoResp3 {publicstaticvoidmain() {HostAndPorthnp =HostAndPort.from("localhost:6379");Jedisc =Jedis(hnp,DefaultJedisClientConfig.builder().resp3().build());c.set("foo","value!");c.get("foo");    }}