Add performance warning to RedisTemplate#keys() and RedisOperations#keys() Javadoc #3142
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the Javadoc of both
RedisTemplate#keys()
andRedisOperations#keys()
methods to include a performance warning regarding the use of theKEYS
command.The
KEYS
command performs a full scan of the Redis keyspace, which can severely impact performance in production environments.To avoid misuse, the updated Javadocs include a warning and recommend using
scan(ScanOptions)
as a safer alternative for large datasets.RedisTemplate#keys()
implementation method.RedisOperations#keys()
interface method.Note:
ReactiveRedisOperations#keys()
already contains a similar warning and did not require changes.Checklist
References
scan(ScanOptions)
alternative