spring-projects / spring-projects/spring-data-redis

Add support for custom indexers

Open
#2,546 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

for: team-attention status: waiting-for-triage
Dominant language
Java
Stars
1.9k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

Problems with the current state:

Currently, Spring Data Redis allows indexing POJOs using Redis Sets as described in https://redis.io/docs/manual/patterns/indexes/ . This approach is outdated since the release of RediSearch and has the following limitations:

Proposed solution:

Introduce new Interfaces and configuration options that allow indexing POJOs with custom Indexers based on RediSearch. Usage of custom Indexers will allow us to solve community issues, overcome the limitations mentioned above, and fine-tune Spring Data Redis for specific use cases.

An example of @Indexed annotation based on RediSearch can be found here:

https://github.com/redis/redis-om-spring/blob/main/redis-om-spring/src/main/java/com/redis/om/spring/annotations/Indexed.java

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing Spring Data Redis's existing POJO indexing and repository support, then compare the proposed custom Indexer approach with the RediSearch-based @Indexed example linked in the issue. Done means defining the required interfaces and configuration options and supporting custom RediSearch-backed indexing for POJOs.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, redis, spring
Domain
databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.