Jedis
What is Jedis?
Jedis is a Java client for Redis designed for performance and ease of use.
Are you looking for a high-level library to handle object mapping? See redis-om-spring!
How do I Redis?
Learn for free at Redis University
Supported Redis versions
The most recent version of this library supports redis version 5.0, 6.0, 6.2, 7.0, 7.2 and 7.4.
The table below highlights version compatibility of the most-recent library versions and Redis versions. Compatibility means communication features, and Redis command capabilities.
| Jedis version | Supported Redis versions | JDK Compatibility |
|---|---|---|
| 3.9+ | 5.0 to 6.2 Family of releases | 8, 11 |
| >= 4.0 | Version 5.0 to 7.2 Family of releases | 8, 11, 17 |
| >= 5.0 | Version 6.0 to current | 8, 11, 17, 21 |
| >= 5.2 | Version 7.2 to current | 8, 11, 17, 21 |
Getting started
To get started with Jedis, first add it as a dependency in your Java project. If you're using Maven, that looks like this:
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>5.2.0</version>
</dependency>
To use the cutting-edge Jedis, check here.
Next, you'll need to connect to Redis. Consider installing a redis-stack docker:
docker run -p 6379:6379 -it redis/redis-stack:latest
For many applications, it's best to use a connection pool. You can instantiate a Jedis connection pool like so:
JedisPool pool = new JedisPool("localhost", 6379);
With a JedisPool instance, you can use a
try-with-resources
block to get a connection and run Redis commands.
Here's how to run a single SET command within a try-with-resources block:
try (Jedis jedis = pool.getResource()) {
jedis.set("clientName", "Jedis");
}
Jedis instances implement most Redis commands. See the
Jedis Javadocs
for the complete list of supported commands.
Easier way of using connection pool
Using a try-with-resources block for each command may be cumbersome, so you may consider using JedisPooled.
JedisPooled jedis = new JedisPooled("localhost", 6379);
Now you can send commands like sending from Jedis.
jedis.sadd("planets", "Venus");
Connecting to a Redis cluster
Jedis lets you connect to Redis Clusters, supporting the Redis Cluster Specification.
To do this, you'll need to connect using JedisCluster. See the example below:
Set<HostAndPort> jedisClusterNodes = new HashSet<HostAndPort>();
jedisClusterNodes.add(new HostAndPort("127.0.0.1", 7379));
jedisClusterNodes.add(new HostAndPort("127.0.0.1", 7380));
JedisCluster jedis = new JedisCluster(jedisClusterNodes);
Now you can use the JedisCluster instance and send commands like you would with a standard pooled connection:
jedis.sadd("planets", "Mars");
Using Redis modules
Jedis includes support for Redis modules such as RedisJSON and RediSearch.
See the RedisJSON Jedis or RediSearch Jedis for details.
Failover
Jedis supports retry and failover for your Redis deployments. This is useful when:
- You have more than one Redis deployment. This might include two independent Redis servers or two or more Redis databases replicated across multiple active-active Redis Enterprise clusters.
- You want your application to connect to one deployment at a time and to fail over to the next available deployment if the first deployment becomes unavailable.
For the complete failover configuration options and examples, see the Jedis failover docs.
Documentation
The Jedis wiki contains several useful articles for using Jedis.
You can also check the latest Jedis Javadocs.
Some specific use-case examples can be found in redis.clients.jedis.examples
package of the test source codes.
Troubleshooting
If you run into trouble or have any questions, we're here to help!
Hit us up on the Redis Discord Server or Jedis GitHub Discussions or Jedis mailing list.
Contributing
We'd love your contributions!
Bug reports are always welcome! You can open a bug report on GitHub.
You can also contribute documentation -- or anything to improve Jedis. Please see contribution guideline for more details.
License
Jedis is licensed under the MIT license.
Sponsorship
