The primary goal of theSpring Data project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.

This module provides integration with theRedis store.It is also tested to work withValkey on a best-effort basis as long as Valkey remains largely compatible with Redis.

• Connection package as low-level abstraction across multiple Redis drivers (Lettuce andJedis).

• Exception translation to Spring’s portable Data Access exception hierarchy for Redis driver exceptions

• RedisTemplate that provides a high level abstraction for performing various Redis operations, exception translation and serialization support.

• Pubsub support (such as a MessageListenerContainer for message-driven POJOs).

• Redis Sentinel andRedis Cluster support.

• Reactive API using the Lettuce driver.

• JDK, String, JSON and Spring Object/XML mapping serializers.

• JDK Collection implementations on top of Redis.

• Atomic counter support classes.

• Sorting and Pipelining functionality.

• Dedicated support for SORT, SORT/GET pattern and returned bulk values.

• Redis implementation for Spring 3.1 cache abstraction.

• Automatic implementation ofRepository interfaces including support for custom finder methods using@EnableRedisRepositories.

• CDI support for repositories.

This project is governed by theSpring Code of Conduct. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior tospring-code-of-conduct@pivotal.io.

Here is a quick teaser of an application using Spring Data Redis in Java:

Having trouble with Spring Data? We’d love to help!

• Check thereference documentation, andJavadocs.

• Learn the Spring basics – Spring Data builds on Spring Framework, check thespring.io web-site for a wealth of reference documentation.If you are just starting out with Spring, try one of theguides.

• If you are upgrading, check out theRelease notes for “new and noteworthy” features.

• Ask a question - we monitorstackoverflow.com for questions tagged withspring-data-redis.

• Report bugs with Spring Data Redis atgithub.com/spring-projects/spring-data-redis.

Spring Data uses Github as issue tracking system to record bugs and feature requests.If you want to raise an issue, please follow the recommendations below:

• Before you log a bug, please search theissue tracker to see if someone has already reported the problem.

• If the issue does not already exist,create a new issue.

• Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using, the JVM version, Stacktrace, etc.

• If you need to paste code, or include a stack trace useMarkdown code fences ```.

• If possible try to create a test-case or project that replicates the issue.Attach a link to your code or a compressed file containing your code.

You don’t need to build from source to use Spring Data (binaries inrepo.spring.io), but if you want to try out the latest and greatest, Spring Data can be easily built with themaven wrapper.You also need JDK 17 or above andmake.The local build environment is managed within aMakefile to download, build and spin up Redis in various configurations (Standalone, Sentinel, Cluster, etc.)

The preceding command runs a full build.You can usemake start,make stop, andmake clean commands to control the environment yourself.This is useful if you want to avoid constant server restarts.Once all Redis instances have been started, you can either run tests in your IDE or the full Maven build:

If you want to build with the regularmvn command, you will needMaven v3.8.0 or above.

Also seeCONTRIBUTING.adoc if you wish to submit pull requests, and in particular please sign theContributor’s Agreement before your first non-trivial change.

Thespring.io site contains several guides that show how to use Spring Data step-by-step:

• Messaging with Redis: Learn how to use Redis as a message broker.

• Accessing Data Reactively with Redis: Learn how to reactively interface with Redis and Spring Data.

• Spring Data Examples contains example projects that explain specific features in more detail.

Spring Data Redis is Open Source software released under theApache 2.0 license.