spring-projects / spring-projects/spring-data-redis
Add support for custom indexers
Nobody has claimed this yet.
- 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:
-
Limited querying capabilities, absence of aggregations, sorting and limiting.
Some of the limitations are described here.
Examples of users struggling with these limitations:- https://stackoverflow.com/questions/44647363/spring-data-redis-repository-doesnt-support-collection-query
- https://stackoverflow.com/questions/54339026/spring-data-redis-sort-order-by
- https://stackoverflow.com/questions/42518900/how-to-build-dynamic-queries-with-spring-data-redis-repositories
- https://stackoverflow.com/questions/45419196/query-nested-objects-in-redis-using-spring-data
-
Spring Data Redis manages indexes, leading to memory overhead, scalability problems and incompatibilities with Redis Cluster.
Some users have to give up on Spring Data Redis because of the problems mentioned here:
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:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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