Interface StringRedisConnection

All Superinterfaces:

AutoCloseable, DefaultedRedisConnection, RedisCommands, RedisCommandsProvider, RedisConnection, RedisConnectionCommands, RedisGeoCommands, RedisHashCommands, RedisHyperLogLogCommands, RedisKeyCommands, RedisListCommands, RedisPubSubCommands, RedisScriptingCommands, RedisServerCommands, RedisSetCommands, RedisStreamCommands, RedisStringCommands, RedisTxCommands, RedisZSetCommands

All Known Implementing Classes:

DefaultStringRedisConnection

@NullUnmarked
public interface StringRedisConnection
extends RedisConnection

Convenience extension of RedisConnection that accepts and returns Strings instead of byte arrays. Uses a RedisSerializer underneath to perform the conversion.

Author:

Costin Leau, Christoph Strobl, Thomas Darimont, David Liu, Mark Paluch, Ninad Divadkar, Tugdual Grall, Dengliming, Andrey Shlykov, ihaohong, Shyngys Sapraliyev

See Also:

• RedisCallback
• RedisSerializer
• StringRedisTemplate

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StringRedisConnection.StringTuple	String-friendly ZSet tuple.

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisGeoCommands

RedisGeoCommands.DistanceUnit, RedisGeoCommands.GeoCommandArgs, RedisGeoCommands.GeoLocation<T>, RedisGeoCommands.GeoRadiusCommandArgs, RedisGeoCommands.GeoSearchCommandArgs, RedisGeoCommands.GeoSearchStoreCommandArgs

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisListCommands

RedisListCommands.Direction, RedisListCommands.Position

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisServerCommands

RedisServerCommands.FlushOption, RedisServerCommands.MigrateOption, RedisServerCommands.ShutdownOption

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisStreamCommands

RedisStreamCommands.XAddOptions, RedisStreamCommands.XClaimOptions, RedisStreamCommands.XPendingOptions

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisStringCommands

RedisStringCommands.BitOperation, RedisStringCommands.SetOption

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisZSetCommands

RedisZSetCommands.Limit, RedisZSetCommands.Range, RedisZSetCommands.ZAddArgs

Method Summary

Modifier and Type	Method	Description
Long	append(@NonNull String key, String value)	Append a value to key.
Long	bitCount(@NonNull String key)	Count the number of set bits (population counting) in value stored at key.
Long	bitCount(@NonNull String key, long start, long end)	Count the number of set bits (population counting) of value stored at key between start and end.
List<Long>	bitfield(@NonNull String key, @NonNull BitFieldSubCommands command)	Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.
Long	bitOp(@NonNull RedisStringCommands.BitOperation op, @NonNull String destination, @NonNull String @NonNull ... keys)	Perform bitwise operations between strings.
default Long	bitPos(@NonNull String key, boolean bit)	Return the position of the first bit set to given bit in a string.
Long	bitPos(@NonNull String key, boolean bit, @NonNull Range<Long> range)	Return the position of the first bit set to given bit in a string.
String	bLMove(@NonNull String sourceKey, @NonNull String destinationKey, @NonNull RedisListCommands.Direction from, @NonNull RedisListCommands.Direction to, double timeout)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
List<String>	bLPop(int timeout, @NonNull String @NonNull ... keys)	Removes and returns first element from lists stored at keys (see: DefaultedRedisConnection.lPop(byte[])).
List<String>	bRPop(int timeout, @NonNull String @NonNull ... keys)	Removes and returns last element from lists stored at keys (see: DefaultedRedisConnection.rPop(byte[])).
String	bRPopLPush(int timeout, @NonNull String srcKey, @NonNull String dstKey)	Remove the last element from list at srcKey, append it to dstKey and return its value (see DefaultedRedisConnection.rPopLPush(byte[], byte[])).
StringRedisConnection.StringTuple	bZPopMax(@NonNull String key, long timeout, @NonNull TimeUnit unit)	Remove and return the value with its score having the highest score from sorted set at key.
StringRedisConnection.StringTuple	bZPopMin(@NonNull String key, long timeout, @NonNull TimeUnit unit)	Remove and return the value with its score having the lowest score from sorted set at key.
Boolean	copy(@NonNull String sourceKey, @NonNull String targetKey, boolean replace)	Copy given sourceKey to targetKey.
Long	decr(@NonNull String key)	Decrement an integer value stored as string value of key by 1.
Long	decrBy(@NonNull String key, long value)	Decrement an integer value stored as string value of key by value.
Long	del(@NonNull String @NonNull ... keys)	Delete given keys.
String	echo(@NonNull String message)	Returns message via server roundtrip.
ValueEncoding	encodingOf(@NonNull String key)	Get the type of internal representation used for storing the value at the given key.
static RecordId[]	entryIds(String... entryIds)
<T> T	eval(@NonNull String script, @NonNull ReturnType returnType, int numKeys, @NonNull String @NonNull ... keysAndArgs)	Evaluate given script.
<T> T	evalSha(@NonNull String scriptSha, @NonNull ReturnType returnType, int numKeys, @NonNull String @NonNull ... keysAndArgs)	Evaluate given scriptSha.
Object	execute(@NonNull String command)	'Native' or 'raw' execution of the given command along-side the given arguments.
Object	execute(@NonNull String command, String... args)	'Native' or 'raw' execution of the given command along-side the given arguments.
Boolean	exists(@NonNull String key)	Determine if given key exists.
Long	exists(@NonNull String @NonNull ... keys)	Count how many of the given keys exist.
default Boolean	expire(@NonNull String key, long seconds)	Set time to live for given key in seconds.
Boolean	expire(@NonNull String key, long seconds, @NonNull ExpirationOptions.Condition condition)	Set time to live for given key in seconds.
default Boolean	expireAt(@NonNull String key, long unixTime)	Set the expiration for given key as a UNIX timestamp.
Boolean	expireAt(@NonNull String key, long unixTime, @NonNull ExpirationOptions.Condition condition)	Set the expiration for given key as a UNIX timestamp.
Long	geoAdd(@NonNull String key, @NonNull Iterable<@NonNull RedisGeoCommands.GeoLocation<String>> locations)	Add RedisGeoCommands.GeoLocations to key
Long	geoAdd(@NonNull String key, @NonNull Map<@NonNull String, @NonNull Point> memberCoordinateMap)	Add Map of member / Point pairs to key.
Long	geoAdd(@NonNull String key, @NonNull Point point, @NonNull String member)	Add Point with given member name to key.
Long	geoAdd(@NonNull String key, @NonNull RedisGeoCommands.GeoLocation<String> location)	Add RedisGeoCommands.GeoLocation to key.
Distance	geoDist(@NonNull String key, @NonNull String member1, @NonNull String member2)	Get the Distance between member1 and member2.
Distance	geoDist(@NonNull String key, @NonNull String member1, @NonNull String member2, @NonNull Metric metric)	Get the Distance between member1 and member2 in the given Metric.
List<String>	geoHash(@NonNull String key, @NonNull String @NonNull ... members)	Get geohash representation of the position for one or more members.
List<Point>	geoPos(@NonNull String key, @NonNull String @NonNull ... members)	Get the Point representation of positions for one or more members.
GeoResults<RedisGeoCommands.GeoLocation<String>>	geoRadius(@NonNull String key, @NonNull Circle within)	Get the members within the boundaries of a given Circle.
GeoResults<RedisGeoCommands.GeoLocation<String>>	geoRadius(@NonNull String key, @NonNull Circle within, @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.
GeoResults<RedisGeoCommands.GeoLocation<String>>	geoRadiusByMember(@NonNull String key, @NonNull String member, double radius)	Get the members within the circle defined by the members coordinates and given radius.
GeoResults<RedisGeoCommands.GeoLocation<String>>	geoRadiusByMember(@NonNull String key, @NonNull String member, @NonNull Distance radius)	Get the members within the circle defined by the members coordinates and given Distance.
GeoResults<RedisGeoCommands.GeoLocation<String>>	geoRadiusByMember(@NonNull String key, @NonNull String member, @NonNull Distance radius, @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the circle defined by the members coordinates and given Distance and RedisGeoCommands.GeoRadiusCommandArgs.
Long	geoRemove(@NonNull String key, @NonNull String @NonNull ... members)	Remove the members.
GeoResults<RedisGeoCommands.GeoLocation<String>>	geoSearch(@NonNull String key, @NonNull GeoReference<String> reference, @NonNull GeoShape predicate, @NonNull RedisGeoCommands.GeoSearchCommandArgs args)	Return the members of a geo set which are within the borders of the area specified by a given shape.
Long	geoSearchStore(String destKey, @NonNull String key, @NonNull GeoReference<String> reference, @NonNull GeoShape predicate, @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)	Query the members of a geo set which are within the borders of the area specified by a given shape and store the result at destKey.
String	get(@NonNull String key)	Get the value of key.
Boolean	getBit(@NonNull String key, long offset)	Get the bit value at offset of value at key.
List<RedisClientInfo>	getClientList()	Request information and statistics about connected clients.
String	getDel(@NonNull String key)	Return the value at key and delete the key.
String	getEx(@NonNull String key, @NonNull Expiration expiration)	Return the value at key and expire the key by applying Expiration.
String	getRange(@NonNull String key, long start, long end)	Get a substring of value of key between start and end.
String	getSet(@NonNull String key, String value)	Set value of key and return its old value.
Long	hDel(@NonNull String key, @NonNull String @NonNull ... fields)	Delete given hash fields.
Boolean	hExists(@NonNull String key, @NonNull String field)	Determine if given hash field exists.
default List<Long>	hExpire(@NonNull String key, long seconds, @NonNull String @NonNull ... fields)	Set time to live for given field in seconds.
List<Long>	hExpire(@NonNull String key, long seconds, @NonNull ExpirationOptions.Condition condition, @NonNull String @NonNull ... fields)	Set time to live for given field in seconds.
default List<Long>	hExpireAt(@NonNull String key, long unixTime, @NonNull String @NonNull ... fields)	Set the expiration for given field as a UNIX timestamp.
List<Long>	hExpireAt(@NonNull String key, long unixTime, @NonNull ExpirationOptions.Condition condition, @NonNull String @NonNull ... fields)	Set the expiration for given field as a UNIX timestamp.
String	hGet(@NonNull String key, @NonNull String field)	Get value for given field from hash at key.
Map<String,String>	hGetAll(@NonNull String key)	Get entire hash stored at key.
Double	hIncrBy(@NonNull String key, @NonNull String field, double delta)	Increment value of a hash field by the given delta.
Long	hIncrBy(@NonNull String key, @NonNull String field, long delta)	Increment value of a hash field by the given delta.
Set<String>	hKeys(@NonNull String key)	Get key set (fields) of hash at key.
Long	hLen(@NonNull String key)	Get size of hash at key.
List<String>	hMGet(@NonNull String key, @NonNull String @NonNull ... fields)	Get values for given fields from hash at key.
void	hMSet(@NonNull String key, @NonNull Map<@NonNull String, String> hashes)	Set multiple hash fields to multiple values using data provided in hashes
List<Long>	hPersist(@NonNull String key, @NonNull String @NonNull ... fields)	Remove the expiration from given field.
default List<Long>	hpExpire(@NonNull String key, long millis, @NonNull String @NonNull ... fields)	Set time to live for given field in milliseconds.
List<Long>	hpExpire(@NonNull String key, long millis, @NonNull ExpirationOptions.Condition condition, @NonNull String @NonNull ... fields)	Set time to live for given field in milliseconds.
default List<Long>	hpExpireAt(@NonNull String key, long unixTimeInMillis, @NonNull String @NonNull ... fields)	Set the expiration for given field as a UNIX timestamp in milliseconds.
List<Long>	hpExpireAt(@NonNull String key, long unixTimeInMillis, @NonNull ExpirationOptions.Condition condition, @NonNull String @NonNull ... fields)	Set the expiration for given field as a UNIX timestamp in milliseconds.
List<Long>	hpTtl(@NonNull String key, @NonNull String @NonNull ... fields)	Get the time to live for fields in seconds.
String	hRandField(@NonNull String key)	Return a random field from the hash stored at key.
List<String>	hRandField(@NonNull String key, long count)	Return a random field from the hash stored at key.
@Nullable Map.Entry<String,String>	hRandFieldWithValues(@NonNull String key)	Return a random field from the hash along with its value stored at key.
List<Map.Entry<String,String>>	hRandFieldWithValues(@NonNull String key, long count)	Return a random field from the hash along with its value stored at key.
Cursor<Map.Entry<String,String>>	hScan(@NonNull String key, ScanOptions options)	Use a Cursor to iterate over entries in hash at key.
Boolean	hSet(@NonNull String key, @NonNull String field, String value)	Set the value of a hash field.
Boolean	hSetNX(@NonNull String key, @NonNull String field, String value)	Set the value of a hash field only if field does not exist.
Long	hStrLen(@NonNull String key, @NonNull String field)	Returns the length of the value associated with field in the hash stored at key.
List<Long>	hTtl(@NonNull String key, @NonNull String @NonNull ... fields)	Get the time to live for fields in seconds.
List<Long>	hTtl(@NonNull String key, @NonNull TimeUnit timeUnit, @NonNull String @NonNull ... fields)	Get the time to live for fields in and convert it to the given TimeUnit.
List<String>	hVals(@NonNull String key)	Get entry set (values) of hash at field.
Duration	idletime(@NonNull String key)	Get the Duration since the object stored at the given key is idle.
Long	incr(@NonNull String key)	Increment an integer value stored as string value of key by 1.
Double	incrBy(@NonNull String key, double value)	Increment a floating point number value of key by delta.
Long	incrBy(@NonNull String key, long value)	Increment an integer value stored of key by delta.
Collection<String>	keys(@NonNull String pattern)	Retrieve all keys matching the given pattern via KEYS command.
String	lIndex(@NonNull String key, long index)	Get element at index form list at key.
Long	lInsert(@NonNull String key, @NonNull RedisListCommands.Position where, @NonNull String pivot, String value)	Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.
Long	lLen(@NonNull String key)	Get the size of list stored at key.
String	lMove(@NonNull String sourceKey, @NonNull String destinationKey, @NonNull RedisListCommands.Direction from, @NonNull RedisListCommands.Direction to)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
String	lPop(@NonNull String key)	Removes and returns first element in list stored at key.
List<String>	lPop(@NonNull String key, long count)	Removes and returns first elements in list stored at key.
default Long	lPos(@NonNull String key, @NonNull String element)	Returns the index of matching elements inside the list stored at given key.
List<Long>	lPos(@NonNull String key, @NonNull String element, @Nullable Integer rank, @Nullable Integer count)	Returns the index of matching elements inside the list stored at given key.
Long	lPush(@NonNull String key, @NonNull String @NonNull ... values)	Prepend values to key.
Long	lPushX(@NonNull String key, @NonNull String value)	Prepend values to key only if the list exists.
List<String>	lRange(@NonNull String key, long start, long end)	Get elements between start and end from list at key.
Long	lRem(@NonNull String key, long count, String value)	Removes the first count occurrences of value from the list stored at key.
void	lSet(@NonNull String key, long index, String value)	Set the value list element at index.
void	lTrim(@NonNull String key, long start, long end)	Trim list at key to elements between start and end.
List<String>	mGet(@NonNull String @NonNull ... keys)	Get multiple keys.
Boolean	move(@NonNull String key, int dbIndex)	Move given key to database with index.
Boolean	mSetNXString(@NonNull Map<@NonNull String, String> tuple)	Set multiple keys to multiple values using key-value pairs provided in tuple only if the provided key does not exist.
Boolean	mSetString(@NonNull Map<@NonNull String, String> tuple)	Set multiple keys to multiple values using key-value pairs provided in tuple.
Boolean	persist(@NonNull String key)	Remove the expiration from given key.
default Boolean	pExpire(@NonNull String key, long millis)	Set time to live for given key in milliseconds.
Boolean	pExpire(@NonNull String key, long millis, @NonNull ExpirationOptions.Condition condition)	Set time to live for given key in milliseconds.
default Boolean	pExpireAt(@NonNull String key, long unixTimeInMillis)	Set the expiration for given key as a UNIX timestamp in milliseconds.
Boolean	pExpireAt(@NonNull String key, long unixTimeInMillis, @NonNull ExpirationOptions.Condition condition)	Set the expiration for given key as a UNIX timestamp in milliseconds.
Long	pfAdd(@NonNull String key, String... values)	Adds given values to the HyperLogLog stored at given key.
Long	pfCount(@NonNull String @NonNull ... keys)	Return the approximated cardinality of the structures observed by the HyperLogLog at key(s).
void	pfMerge(@NonNull String destinationKey, @NonNull String @NonNull ... sourceKeys)	Merge N different HyperLogLogs at sourceKeys into a single destinationKey.
Boolean	pSetEx(@NonNull String key, long milliseconds, @NonNull String value)	Set the value and expiration in milliseconds for key.
void	pSubscribe(@NonNull MessageListener listener, @NonNull String @NonNull ... patterns)	Subscribes the connection to all channels matching the given patterns.
Long	pTtl(@NonNull String key)	Get the precise time to live for key in milliseconds.
Long	pTtl(@NonNull String key, @NonNull TimeUnit timeUnit)	Get the precise time to live for key in and convert it to the given TimeUnit.
Long	publish(@NonNull String channel, @NonNull String message)	Publishes the given message to the given channel.
Long	refcount(@NonNull String key)	Get the number of references of the value associated with the specified key.
void	rename(@NonNull String oldKey, @NonNull String newKey)	Rename key oldKey to newKey.
Boolean	renameNX(@NonNull String oldKey, @NonNull String newKey)	Rename key oldKey to newKey only if newKey does not exist.
String	rPop(@NonNull String key)	Removes and returns last element in list stored at key.
List<String>	rPop(@NonNull String key, long count)	Removes and returns last elements in list stored at key.
String	rPopLPush(@NonNull String srcKey, @NonNull String dstKey)	Remove the last element from list at srcKey, append it to dstKey and return its value.
Long	rPush(@NonNull String key, @NonNull String @NonNull ... values)	Append values to key.
Long	rPushX(@NonNull String key, @NonNull String value)	Append values to key only if the list exists.
Long	sAdd(@NonNull String key, String... values)	Add given values to set at key.
Long	sCard(@NonNull String key)	Get size of set at key.
String	scriptLoad(@NonNull String script)	Load lua script into scripts cache, without executing it. Execute the script by calling DefaultedRedisConnection.evalSha(byte[], ReturnType, int, byte[]...).
Set<String>	sDiff(String... keys)	Diff all sets for given keys.
Long	sDiffStore(String destKey, String... keys)	Diff all sets for given keys and store result in destKey.
Boolean	set(@NonNull String key, @NonNull String value)	Set value for key.
Boolean	set(@NonNull String key, @NonNull String value, @Nullable Expiration expiration, @Nullable RedisStringCommands.SetOption option)	Set value for key applying timeouts from expiration if set and inserting/updating values depending on option.
Boolean	setBit(@NonNull String key, long offset, boolean value)	Sets the bit at offset in value stored at key.
void	setClientName(@NonNull String name)	Assign given name to current connection.
Boolean	setEx(@NonNull String key, long seconds, @NonNull String value)	Set the value and expiration in seconds for key.
Boolean	setNX(@NonNull String key, @NonNull String value)	Set value for key, only if key does not exist.
void	setRange(@NonNull String key, String value, long offset)	Overwrite parts of key starting at the specified offset with given value.
Set<String>	sInter(@NonNull String @NonNull ... keys)	Returns the members intersecting all given sets at keys.
Long	sInterStore(@NonNull String destKey, @NonNull String @NonNull ... keys)	Intersect all given sets at keys and store result in destKey.
Boolean	sIsMember(@NonNull String key, String value)	Check if set at key contains value.
Set<String>	sMembers(@NonNull String key)	Get all elements of set at key.
List<Boolean>	sMIsMember(@NonNull String key, String... values)	Check if set at key contains one or more values.
Boolean	sMove(@NonNull String srcKey, @NonNull String destKey, String value)	Move value from srcKey to destKey
List<String>	sort(@NonNull String key, @NonNull SortParameters params)	Sort the elements for key.
Long	sort(@NonNull String key, @NonNull SortParameters params, @NonNull String storeKey)	Sort the elements for key and store result in storeKey.
String	sPop(@NonNull String key)	Remove and return a random member from set at key.
List<String>	sPop(@NonNull String key, long count)	Remove and return count random members from set at key.
String	sRandMember(@NonNull String key)	Get random element from set at key.
List<String>	sRandMember(@NonNull String key, long count)	Get count random elements from set at key.
Long	sRem(@NonNull String key, String... values)	Remove given values from set at key and return the number of removed elements.
Cursor<String>	sScan(@NonNull String key, ScanOptions options)	Use a Cursor to iterate over elements in set at key.
Long	strLen(@NonNull String key)	Get the length of the value stored at key.
void	subscribe(@NonNull MessageListener listener, @NonNull String @NonNull ... channels)	Subscribes the connection to the given channels.
Set<String>	sUnion(String... keys)	Union all sets at given keys.
Long	sUnionStore(String destKey, String... keys)	Union all sets at given keys and store result in destKey.
Long	touch(@NonNull String @NonNull ... keys)	Alter the last access time of given key(s).
Long	ttl(@NonNull String key)	Get the time to live for key in seconds.
Long	ttl(@NonNull String key, @NonNull TimeUnit timeUnit)	Get the time to live for key in and convert it to the given TimeUnit.
DataType	type(@NonNull String key)	Determine the type stored at key.
Long	unlink(@NonNull String @NonNull ... keys)	Unlink the keys from the keyspace.
default Long	xAck(@NonNull String key, @NonNull String group, @NonNull String @NonNull ... entryIds)	Acknowledge one or more record as processed.
Long	xAck(@NonNull String key, @NonNull String group, @NonNull RecordId @NonNull ... recordIds)
default RecordId	xAdd(@NonNull String key, @NonNull Map<@NonNull String, String> body)	Append a record to the stream key.
default RecordId	xAdd(@NonNull StringRecord record)	Append the given StringRecord to the stream stored at Record.getStream().
RecordId	xAdd(@NonNull StringRecord record, @NonNull RedisStreamCommands.XAddOptions options)	Append the given StringRecord to the stream stored at Record.getStream().
default List<StringRecord>	xClaim(@NonNull String key, @NonNull String group, @NonNull String newOwner, @NonNull Duration minIdleTime, @NonNull RecordId @NonNull ... recordIds)	Change the ownership of a pending message to the given new consumer.
List<StringRecord>	xClaim(@NonNull String key, @NonNull String group, @NonNull String newOwner, @NonNull RedisStreamCommands.XClaimOptions options)	Change the ownership of a pending message to the given new consumer.
List<RecordId>	xClaimJustId(@NonNull String key, @NonNull String group, @NonNull String newOwner, @NonNull RedisStreamCommands.XClaimOptions options)	Change the ownership of a pending message to the given new consumer without increasing the delivered count.
default Long	xDel(@NonNull String key, @NonNull String @NonNull ... entryIds)	Removes the specified entries from the stream.
Long	xDel(@NonNull String key, @NonNull RecordId @NonNull ... recordIds)
String	xGroupCreate(@NonNull String key, @NonNull ReadOffset readOffset, @NonNull String group)	Create a consumer group.
String	xGroupCreate(@NonNull String key, @NonNull ReadOffset readOffset, @NonNull String group, boolean mkStream)	Create a consumer group.
Boolean	xGroupDelConsumer(@NonNull String key, @NonNull Consumer consumer)	Delete a consumer from a consumer group.
Boolean	xGroupDestroy(@NonNull String key, String group)	Destroy a consumer group.
StreamInfo.XInfoStream	xInfo(@NonNull String key)	Obtain general information about the stream stored at the specified key.
StreamInfo.XInfoConsumers	xInfoConsumers(@NonNull String key, @NonNull String groupName)	Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.
StreamInfo.XInfoGroups	xInfoGroups(@NonNull String key)	Obtain information about consumer groups associated with the stream stored at the specified key.
Long	xLen(@NonNull String key)	Get the length of a stream.
PendingMessagesSummary	xPending(@NonNull String key, @NonNull String groupName)	Obtain the PendingMessagesSummary for a given consumer group.
PendingMessages	xPending(@NonNull String key, @NonNull String groupName, @NonNull String consumerName, @NonNull Range<String> range, @NonNull Long count)	Obtain detailed information about pending messages for a given Range within a consumer group.
PendingMessages	xPending(@NonNull String key, @NonNull String groupName, @NonNull Range<String> range, @NonNull Long count)	Obtain detailed information about pending messages for a given Range within a consumer group.
PendingMessages	xPending(@NonNull String key, @NonNull String groupName, @NonNull RedisStreamCommands.XPendingOptions options)	Obtain detailed information about pending messages applying given options.
default List<StringRecord>	xRange(@NonNull String key, @NonNull Range<String> range)	Read records from a stream within a specific RedisZSetCommands.Range.
List<StringRecord>	xRange(@NonNull String key, @NonNull Range<String> range, @NonNull Limit limit)	Read records from a stream within a specific RedisZSetCommands.Range applying a Limit.
default List<StringRecord>	xReadAsString(@NonNull StreamOffset<String> stream)	Read records from one or more StreamOffsets.
default List<StringRecord>	xReadAsString(@NonNull StreamOffset<String>... streams)	Read records from one or more StreamOffsets.
default List<StringRecord>	xReadAsString(@NonNull StreamReadOptions readOptions, @NonNull StreamOffset<String> stream)	Read records from one or more StreamOffsets.
List<StringRecord>	xReadAsString(@NonNull StreamReadOptions readOptions, @NonNull StreamOffset<String>... streams)	Read records from one or more StreamOffsets.
default List<StringRecord>	xReadGroupAsString(@NonNull Consumer consumer, @NonNull StreamOffset<String> stream)	Read records from one or more StreamOffsets using a consumer group.
default List<StringRecord>	xReadGroupAsString(@NonNull Consumer consumer, @NonNull StreamOffset<String> @NonNull ... streams)	Read records from one or more StreamOffsets using a consumer group.
default List<StringRecord>	xReadGroupAsString(@NonNull Consumer consumer, @NonNull StreamReadOptions readOptions, @NonNull StreamOffset<String> stream)	Read records from one or more StreamOffsets using a consumer group.
List<StringRecord>	xReadGroupAsString(@NonNull Consumer consumer, @NonNull StreamReadOptions readOptions, @NonNull StreamOffset<String> @NonNull ... streams)	Read records from one or more StreamOffsets using a consumer group.
default List<StringRecord>	xRevRange(@NonNull String key, @NonNull Range<String> range)	Read records from a stream within a specific RedisZSetCommands.Range in reverse order.
List<StringRecord>	xRevRange(@NonNull String key, @NonNull Range<String> range, @NonNull Limit limit)	Read records from a stream within a specific RedisZSetCommands.Range applying a Limit in reverse order.
Long	xTrim(@NonNull String key, long count)	Trims the stream to count elements.
Long	xTrim(@NonNull String key, long count, boolean approximateTrimming)	Trims the stream to count elements.
Boolean	zAdd(@NonNull String key, double score, String value)	Add value to a sorted set at key, or update its score if it already exists.
Boolean	zAdd(@NonNull String key, double score, String value, RedisZSetCommands.ZAddArgs args)	Add the value to a sorted set at key, or update its score depending on the given args.
Long	zAdd(@NonNull String key, Set<StringRedisConnection.StringTuple> tuples)	Add tuples to a sorted set at key, or update its score if it already exists.
Long	zAdd(@NonNull String key, Set<StringRedisConnection.StringTuple> tuples, RedisZSetCommands.ZAddArgs args)	Add tuples to a sorted set at key, or update its score depending on the given args.
Long	zCard(@NonNull String key)	Get the size of sorted set with key.
Long	zCount(@NonNull String key, double min, double max)	Count number of elements within sorted set with scores between min and max.
Set<String>	zDiff(@NonNull String @NonNull ... sets)	Diff sorted sets.
Long	zDiffStore(@NonNull String destKey, @NonNull String @NonNull ... sets)	Diff sorted sets and store result in destination destKey.
Set<StringRedisConnection.StringTuple>	zDiffWithScores(@NonNull String @NonNull ... sets)	Diff sorted sets.
Double	zIncrBy(@NonNull String key, double increment, String value)	Increment the score of element with value in sorted set by increment.
Set<String>	zInter(@NonNull String @NonNull ... sets)	Intersect sorted sets.
Long	zInterStore(@NonNull String destKey, @NonNull String @NonNull ... sets)	Intersect sorted sets and store result in destination key.
Long	zInterStore(@NonNull String destKey, @NonNull Aggregate aggregate, int @NonNull [] weights, @NonNull String @NonNull ... sets)	Intersect sorted sets and store result in destination key.
Set<StringRedisConnection.StringTuple>	zInterWithScores(@NonNull String @NonNull ... sets)	Intersect sorted sets.
default Set<StringRedisConnection.StringTuple>	zInterWithScores(@NonNull Aggregate aggregate, int @NonNull [] weights, @NonNull String @NonNull ... sets)	Intersect sorted sets.
Set<StringRedisConnection.StringTuple>	zInterWithScores(@NonNull Aggregate aggregate, @NonNull Weights weights, @NonNull String @NonNull ... sets)	Intersect sorted sets.
Long	zLexCount(@NonNull String key, @NonNull Range<String> range)	Count number of elements within sorted set with value between Range#min and Range#max applying lexicographical ordering.
List<Double>	zMScore(@NonNull String key, String... values)	Get the scores of elements with values from sorted set with key key.
StringRedisConnection.StringTuple	zPopMax(@NonNull String key)	Remove and return the value with its score having the highest score from sorted set at key.
Set<StringRedisConnection.StringTuple>	zPopMax(@NonNull String key, long count)	Remove and return count values with their score having the highest score from sorted set at key.
Tuple	zPopMin(@NonNull String key)	Remove and return the value with its score having the lowest score from sorted set at key.
Set<StringRedisConnection.StringTuple>	zPopMin(@NonNull String key, long count)	Remove and return count values with their score having the lowest score from sorted set at key.
String	zRandMember(@NonNull String key)	Get random element from sorted set at key.
List<String>	zRandMember(@NonNull String key, long count)	Get count random elements from sorted set at key.
StringRedisConnection.StringTuple	zRandMemberWithScore(@NonNull String key)	Get random element from sorted set at key.
List<StringRedisConnection.StringTuple>	zRandMemberWithScores(@NonNull String key, long count)	Get count random elements from sorted set at key.
Set<String>	zRange(@NonNull String key, long start, long end)	Get elements between start and end from sorted set.
Set<String>	zRangeByLex(@NonNull String key)	Get all the elements in the sorted set at key in lexicographical ordering.
Set<String>	zRangeByLex(@NonNull String key, @NonNull Range<String> range)	Get all the elements in RedisZSetCommands.Range from the sorted set at key in lexicographical ordering.
Set<String>	zRangeByLex(@NonNull String key, @NonNull Range<String> range, @NonNull Limit limit)	Get all the elements in RedisZSetCommands.Range from the sorted set at key in lexicographical ordering.
Set<String>	zRangeByScore(@NonNull String key, double min, double max)	Get elements where score is between min and max from sorted set.
Set<String>	zRangeByScore(@NonNull String key, double min, double max, long offset, long count)	Get elements in range from start to end where score is between min and max from sorted set.
Set<String>	zRangeByScore(@NonNull String key, @NonNull String min, @NonNull String max)	Get elements where score is between min and max from sorted set.
Set<String>	zRangeByScore(@NonNull String key, @NonNull String min, @NonNull String max, long offset, long count)	Get elements in range from start to end where score is between min and max from sorted set.
Set<StringRedisConnection.StringTuple>	zRangeByScoreWithScores(@NonNull String key, double min, double max)	Get set of Tuples where score is between min and max from sorted set.
Set<StringRedisConnection.StringTuple>	zRangeByScoreWithScores(@NonNull String key, double min, double max, long offset, long count)	Get set of Tuples in range from start to end where score is between min and max from sorted set.
default Long	zRangeStoreByLex(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<String> range)	This command is like ZRANGE , but stores the result in the dstKey destination key.
Long	zRangeStoreByLex(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<String> range, @NonNull Limit limit)	This command is like ZRANGE , but stores the result in the dstKey destination key.
default Long	zRangeStoreByScore(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<? extends Number> range)	This command is like ZRANGE, but stores the result in the dstKey destination key.
Long	zRangeStoreByScore(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<? extends Number> range, @NonNull Limit limit)	This command is like ZRANGE, but stores the result in the dstKey destination key.
default Long	zRangeStoreRevByLex(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<String> range)	This command is like ZRANGE … REV , but stores the result in the dstKey destination key.
Long	zRangeStoreRevByLex(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<String> range, @NonNull Limit limit)	This command is like ZRANGE … REV , but stores the result in the dstKey destination key.
default Long	zRangeStoreRevByScore(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<? extends Number> range)	This command is like ZRANGE … REV, but stores the result in the dstKey destination key.
Long	zRangeStoreRevByScore(@NonNull String dstKey, @NonNull String srcKey, @NonNull Range<? extends Number> range, @NonNull Limit limit)	This command is like ZRANGE … REV, but stores the result in the dstKey destination key.
Set<StringRedisConnection.StringTuple>	zRangeWithScores(@NonNull String key, long start, long end)	Get set of Tuples between start and end from sorted set.
Long	zRank(@NonNull String key, String value)	Determine the index of element with value in a sorted set.
Long	zRem(@NonNull String key, String... values)	Remove values from sorted set.
Long	zRemRange(@NonNull String key, long start, long end)	Remove elements in range between start and end from sorted set with key.
Long	zRemRangeByLex(@NonNull String key, @NonNull Range<String> range)	Remove all elements between the lexicographical RedisZSetCommands.Range.
Long	zRemRangeByScore(@NonNull String key, double min, double max)	Remove elements with scores between min and max from sorted set with key.
Set<String>	zRevRange(@NonNull String key, long start, long end)	Get elements in range from start to end from sorted set ordered from high to low.
default Set<String>	zRevRangeByLex(@NonNull String key)	Get all the elements in the sorted set at key in reversed lexicographical ordering.
default Set<String>	zRevRangeByLex(@NonNull String key, @NonNull Range<String> range)	Get all the elements in RedisZSetCommands.Range from the sorted set at key in reversed lexicographical ordering.
Set<String>	zRevRangeByLex(@NonNull String key, @NonNull Range<String> range, @NonNull Limit limit)	Get all the elements in RedisZSetCommands.Range from the sorted set at key in reversed lexicographical ordering.
Set<String>	zRevRangeByScore(@NonNull String key, double min, double max)	Get elements where score is between min and max from sorted set ordered from high to low.
Set<String>	zRevRangeByScore(@NonNull String key, double min, double max, long offset, long count)	Get elements in range from start to end where score is between min and max from sorted set ordered high -> low.
Set<StringRedisConnection.StringTuple>	zRevRangeByScoreWithScores(@NonNull String key, double min, double max)	Get set of Tuple where score is between min and max from sorted set ordered from high to low.
Set<StringRedisConnection.StringTuple>	zRevRangeByScoreWithScores(@NonNull String key, double min, double max, long offset, long count)	Get set of Tuple in range from start to end where score is between min and max from sorted set ordered high -> low.
Set<StringRedisConnection.StringTuple>	zRevRangeWithScores(@NonNull String key, long start, long end)	Get set of Tuples in range from start to end from sorted set ordered from high to low.
Long	zRevRank(@NonNull String key, String value)	Determine the index of element with value in a sorted set when scored high to low.
Cursor<StringRedisConnection.StringTuple>	zScan(@NonNull String key, ScanOptions options)	Use a Cursor to iterate over elements in sorted set at key.
Double	zScore(@NonNull String key, String value)	Get the score of element with value from sorted set with key key.
Set<String>	zUnion(@NonNull String @NonNull ... sets)	Union sorted sets.
Long	zUnionStore(@NonNull String destKey, @NonNull String @NonNull ... sets)	Union sorted sets and store result in destination key.
Long	zUnionStore(@NonNull String destKey, @NonNull Aggregate aggregate, int @NonNull [] weights, @NonNull String @NonNull ... sets)	Union sorted sets and store result in destination key.
Set<StringRedisConnection.StringTuple>	zUnionWithScores(@NonNull String @NonNull ... sets)	Union sorted sets.
default Set<StringRedisConnection.StringTuple>	zUnionWithScores(@NonNull Aggregate aggregate, int @NonNull [] weights, @NonNull String @NonNull ... sets)	Union sorted sets.
Set<StringRedisConnection.StringTuple>	zUnionWithScores(@NonNull Aggregate aggregate, @NonNull Weights weights, @NonNull String @NonNull ... sets)	Union sorted sets.

Methods inherited from interface org.springframework.data.redis.connection.DefaultedRedisConnection

append, applyHashFieldExpiration, bgReWriteAof, bgSave, bitCount, bitCount, bitField, bitOp, bitPos, bLMove, bLPop, bRPop, bRPopLPush, bZPopMax, bZPopMin, copy, dbSize, decr, decrBy, del, dump, encodingOf, eval, evalSha, evalSha, exists, exists, expire, expire, expireAt, expireAt, flushAll, flushAll, flushDb, flushDb, geoAdd, geoAdd, geoAdd, geoDist, geoDist, geoHash, geoPos, geoRadius, geoRadius, geoRadiusByMember, geoRadiusByMember, geoRemove, geoSearch, geoSearchStore, get, getBit, getClientName, getConfig, getDel, getEx, getRange, getSet, hDel, hExists, hExpire, hExpire, hExpireAt, hExpireAt, hGet, hGetAll, hIncrBy, hIncrBy, hKeys, hLen, hMGet, hMSet, hPersist, hpExpire, hpExpire, hpExpireAt, hpExpireAt, hpTtl, hRandField, hRandField, hRandFieldWithValues, hRandFieldWithValues, hScan, hSet, hSetNX, hStrLen, hTtl, hTtl, hVals, idletime, incr, incrBy, incrBy, info, info, keys, killClient, lastSave, lIndex, lInsert, lLen, lMove, lPop, lPop, lPos, lPush, lPushX, lRange, lRem, lSet, lTrim, mGet, migrate, migrate, move, mSet, mSetNX, persist, pExpire, pExpire, pExpireAt, pExpireAt, pfAdd, pfCount, pfMerge, pSetEx, pTtl, pTtl, randomKey, refcount, rename, renameNX, replicaOf, replicaOfNoOne, resetConfigStats, restore, rewriteConfig, rPop, rPop, rPopLPush, rPush, rPushX, sAdd, save, scan, sCard, scriptExists, scriptFlush, scriptKill, scriptLoad, sDiff, sDiffStore, set, set, setBit, setClientName, setConfig, setEx, setGet, setNX, setRange, shutdown, shutdown, sInter, sInterStore, sIsMember, sMembers, sMIsMember, sMove, sort, sort, sPop, sPop, sRandMember, sRandMember, sRem, sScan, strLen, sUnion, sUnionStore, time, time, touch, ttl, ttl, type, unlink, xAck, xAdd, xClaim, xClaimJustId, xDel, xGroupCreate, xGroupCreate, xGroupDelConsumer, xGroupDestroy, xInfo, xInfoConsumers, xInfoGroups, xLen, xPending, xPending, xRange, xRange, xRead, xRead, xReadGroup, xReadGroup, xRevRange, xRevRange, xTrim, xTrim, zAdd, zAdd, zCard, zCount, zCount, zDiff, zDiffStore, zDiffWithScores, zIncrBy, zInter, zInterStore, zInterStore, zInterStore, zInterWithScores, zInterWithScores, zInterWithScores, zLexCount, zMScore, zPopMax, zPopMax, zPopMin, zPopMin, zRandMember, zRandMember, zRandMemberWithScore, zRandMemberWithScore, zRange, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeStoreByLex, zRangeStoreByScore, zRangeStoreRevByLex, zRangeStoreRevByScore, zRangeWithScores, zRank, zRem, zRemRange, zRemRangeByLex, zRemRangeByScore, zRemRangeByScore, zRevRange, zRevRangeByLex, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeWithScores, zRevRank, zScan, zScore, zUnion, zUnionStore, zUnionStore, zUnionStore, zUnionWithScores, zUnionWithScores, zUnionWithScores

Methods inherited from interface org.springframework.data.redis.connection.RedisCommands

execute

Methods inherited from interface org.springframework.data.redis.connection.RedisCommandsProvider

commands, geoCommands, hashCommands, hyperLogLogCommands, keyCommands, listCommands, scriptingCommands, serverCommands, setCommands, streamCommands, stringCommands, zSetCommands

Methods inherited from interface org.springframework.data.redis.connection.RedisConnection

close, closePipeline, getNativeConnection, getSentinelConnection, isClosed, isPipelined, isQueueing, openPipeline

Methods inherited from interface org.springframework.data.redis.connection.RedisConnectionCommands

echo, ping, select

Methods inherited from interface org.springframework.data.redis.connection.RedisGeoCommands

geoAdd, geoRadiusByMember

Methods inherited from interface org.springframework.data.redis.connection.RedisHashCommands

applyHashFieldExpiration, hExpire, hpExpire

Methods inherited from interface org.springframework.data.redis.connection.RedisKeyCommands

applyExpiration, expire, expireAt, pExpire, pExpireAt, restore, scan

Methods inherited from interface org.springframework.data.redis.connection.RedisListCommands

lPos

Methods inherited from interface org.springframework.data.redis.connection.RedisPubSubCommands

getSubscription, isSubscribed, pSubscribe, publish, subscribe

Methods inherited from interface org.springframework.data.redis.connection.RedisStreamCommands

xAck, xAdd, xAdd, xClaim, xDel, xGroupDelConsumer, xPending, xPending, xPending, xPending, xPending

Methods inherited from interface org.springframework.data.redis.connection.RedisStringCommands

bitPos

Methods inherited from interface org.springframework.data.redis.connection.RedisTxCommands

discard, exec, multi, unwatch, watch

Methods inherited from interface org.springframework.data.redis.connection.RedisZSetCommands

zAdd, zAdd, zRangeByLex, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeByScoreWithScores, zRangeByScoreWithScores, zRangeStoreByLex, zRangeStoreByScore, zRangeStoreRevByLex, zRangeStoreRevByScore, zRevRangeByLex, zRevRangeByLex, zRevRangeByScore, zRevRangeByScore, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores

Method Details

execute

Object execute(@NonNull String command,
 String... args)

'Native' or 'raw' execution of the given command along-side the given arguments. The command is executed as is, with as little 'interpretation' as possible - it is up to the caller to take care of any processing of arguments or the result.

Parameters:

command - Command to execute

args - Possible command arguments (may be null)

Returns:

execution result.

See Also:

• RedisCommands.execute(String, byte[]...)

execute

Object execute(@NonNull String command)

'Native' or 'raw' execution of the given command along-side the given arguments. The command is executed as is, with as little 'interpretation' as possible - it is up to the caller to take care of any processing of arguments or the result.

Parameters:

command - Command to execute

Returns:

execution result.

See Also:

• RedisCommands.execute(String, byte[]...)

exists

Boolean exists(@NonNull String key)

Determine if given key exists.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: EXISTS
• RedisKeyCommands.exists(byte[])

exists

Long exists(@NonNull String @NonNull ... keys)

Count how many of the given keys exist.

Parameters:

keys - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: EXISTS
• RedisKeyCommands.exists(byte[][])

del

Long del(@NonNull String @NonNull ... keys)

Delete given keys.

Parameters:

keys - must not be null.

Returns:

The number of keys that were removed.

See Also:

• Redis Documentation: DEL
• RedisKeyCommands.del(byte[]...)

copy

Boolean copy(@NonNull String sourceKey,
 @NonNull String targetKey,
 boolean replace)

Copy given sourceKey to targetKey.

Parameters:

sourceKey - must not be null.

targetKey - must not be null.

replace - whether to replace existing keys.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: COPY
• RedisKeyCommands.copy(byte[], byte[], boolean)

unlink

Long unlink(@NonNull String @NonNull ... keys)

Unlink the keys from the keyspace. Unlike with del(String...) the actual memory reclaiming here happens asynchronously.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

• Redis Documentation: UNLINK

type

DataType type(@NonNull String key)

Determine the type stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: TYPE
• RedisKeyCommands.type(byte[])

touch

Long touch(@NonNull String @NonNull ... keys)

Alter the last access time of given key(s).

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

• Redis Documentation: TOUCH

keys

Collection<String> keys(@NonNull String pattern)

Retrieve all keys matching the given pattern via KEYS command.

IMPORTANT: This command is non-interruptible and scans the entire keyspace which may cause performance issues. Consider DefaultedRedisConnection.scan(ScanOptions) for large datasets.

Parameters:

pattern - must not be null.

Returns:

See Also:

• Redis Documentation: KEYS
• RedisKeyCommands.keys(byte[])

rename

void rename(@NonNull String oldKey,
 @NonNull String newKey)

Rename key oldKey to newKey.

Parameters:

oldKey - must not be null.

newKey - must not be null.

See Also:

• Redis Documentation: RENAME
• RedisKeyCommands.rename(byte[], byte[])

renameNX

Boolean renameNX(@NonNull String oldKey,
 @NonNull String newKey)

Rename key oldKey to newKey only if newKey does not exist.

Parameters:

oldKey - must not be null.

newKey - must not be null.

Returns:

See Also:

• Redis Documentation: RENAMENX
• RedisKeyCommands.renameNX(byte[], byte[])

expire

default Boolean expire(@NonNull String key,
 long seconds)

Set time to live for given key in seconds.

Parameters:

key - must not be null.

seconds -

Returns:

See Also:

• Redis Documentation: EXPIRE
• RedisKeyCommands.expire(byte[], long)

expire

Boolean expire(@NonNull String key,
 long seconds,
 @NonNull ExpirationOptions.Condition condition)

Set time to live for given key in seconds.

Parameters:

key - must not be null.

seconds -

condition - the condition for expiration, must not be null.

Returns:

Since:

3.5

See Also:

• Redis Documentation: EXPIRE
• RedisKeyCommands.expire(byte[], long)

pExpire

default Boolean pExpire(@NonNull String key,
 long millis)

Set time to live for given key in milliseconds.

Parameters:

key - must not be null.

millis -

Returns:

See Also:

• Redis Documentation: PEXPIRE
• RedisKeyCommands.pExpire(byte[], long)

pExpire

Boolean pExpire(@NonNull String key,
 long millis,
 @NonNull ExpirationOptions.Condition condition)

Set time to live for given key in milliseconds.

Parameters:

key - must not be null.

millis -

condition - the condition for expiration, must not be null.

Returns:

Since:

3.5

See Also:

• Redis Documentation: PEXPIRE
• RedisKeyCommands.pExpire(byte[], long)

expireAt

default Boolean expireAt(@NonNull String key,
 long unixTime)

Set the expiration for given key as a UNIX timestamp.

Parameters:

key - must not be null.

unixTime -

Returns:

See Also:

• Redis Documentation: EXPIREAT
• RedisKeyCommands.expireAt(byte[], long)

expireAt

Boolean expireAt(@NonNull String key,
 long unixTime,
 @NonNull ExpirationOptions.Condition condition)

Set the expiration for given key as a UNIX timestamp.

Parameters:

key - must not be null.

unixTime -

condition - the condition for expiration, must not be null.

Returns:

Since:

3.5

See Also:

• Redis Documentation: EXPIREAT
• RedisKeyCommands.expireAt(byte[], long)

pExpireAt

default Boolean pExpireAt(@NonNull String key,
 long unixTimeInMillis)

Set the expiration for given key as a UNIX timestamp in milliseconds.

Parameters:

key - must not be null.

unixTimeInMillis -

Returns:

See Also:

• Redis Documentation: PEXPIREAT
• RedisKeyCommands.pExpireAt(byte[], long)

pExpireAt

Boolean pExpireAt(@NonNull String key,
 long unixTimeInMillis,
 @NonNull ExpirationOptions.Condition condition)

Set the expiration for given key as a UNIX timestamp in milliseconds.

Parameters:

key - must not be null.

unixTimeInMillis -

condition - the condition for expiration, must not be null.

Returns:

Since:

3.5

See Also:

• Redis Documentation: PEXPIREAT
• RedisKeyCommands.pExpireAt(byte[], long)

persist

Boolean persist(@NonNull String key)

Remove the expiration from given key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: PERSIST
• RedisKeyCommands.persist(byte[])

move

Boolean move(@NonNull String key,
 int dbIndex)

Move given key to database with index.

Parameters:

key - must not be null.

dbIndex -

Returns:

See Also:

• Redis Documentation: MOVE
• RedisKeyCommands.move(byte[], int)

ttl

Long ttl(@NonNull String key)

Get the time to live for key in seconds.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: TTL
• RedisKeyCommands.ttl(byte[])

ttl

Long ttl(@NonNull String key,
 @NonNull TimeUnit timeUnit)

Get the time to live for key in and convert it to the given TimeUnit.

Parameters:

key - must not be null.

timeUnit - must not be null.

Returns:

Since:

1.8

See Also:

• Redis Documentation: TTL
• RedisKeyCommands.ttl(byte[], TimeUnit)

pTtl

Long pTtl(@NonNull String key)

Get the precise time to live for key in milliseconds.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: PTTL
• RedisKeyCommands.pTtl(byte[])

pTtl

Long pTtl(@NonNull String key,
 @NonNull TimeUnit timeUnit)

Get the precise time to live for key in and convert it to the given TimeUnit.

Parameters:

key - must not be null.

timeUnit - must not be null.

Returns:

Since:

1.8

See Also:

• Redis Documentation: PTTL
• RedisKeyCommands.pTtl(byte[], TimeUnit)

echo

String echo(@NonNull String message)

Returns message via server roundtrip.

Parameters:

message - the message to echo.

Returns:

See Also:

• Redis Documentation: ECHO
• RedisConnectionCommands.echo(byte[])

sort

List<String> sort(@NonNull String key,
 @NonNull SortParameters params)

Sort the elements for key.

Parameters:

key - must not be null.

params - must not be null.

Returns:

See Also:

• Redis Documentation: SORT

sort

Long sort(@NonNull String key,
 @NonNull SortParameters params,
 @NonNull String storeKey)

Sort the elements for key and store result in storeKey.

Parameters:

key - must not be null.

params - must not be null.

storeKey - must not be null.

Returns:

See Also:

• Redis Documentation: SORT

encodingOf

ValueEncoding encodingOf(@NonNull String key)

Get the type of internal representation used for storing the value at the given key.

Parameters:

key - must not be null.

Returns:

null if key does not exist or when used in pipeline / transaction.

Throws:

IllegalArgumentException - if key is null.

Since:

2.1

idletime

Duration idletime(@NonNull String key)

Get the Duration since the object stored at the given key is idle.

Parameters:

key - must not be null.

Returns:

null if key does not exist or when used in pipeline / transaction.

Throws:

IllegalArgumentException - if key is null.

Since:

2.1

refcount

Long refcount(@NonNull String key)

Get the number of references of the value associated with the specified key.

Parameters:

key - must not be null.

Returns:

null if key does not exist or when used in pipeline / transaction.

Throws:

IllegalArgumentException - if key is null.

Since:

2.1

get

String get(@NonNull String key)

Get the value of key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: GET
• RedisStringCommands.get(byte[])

getDel

String getDel(@NonNull String key)

Return the value at key and delete the key.

Parameters:

key - must not be null.

Returns:

null when key does not exist or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GETDEL

getEx

String getEx(@NonNull String key,
 @NonNull Expiration expiration)

Return the value at key and expire the key by applying Expiration.

Parameters:

key - must not be null.

expiration - must not be null.

Returns:

null when key does not exist or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GETEX

getSet

String getSet(@NonNull String key,
 String value)

Set value of key and return its old value.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: GETSET
• RedisStringCommands.getSet(byte[], byte[])

mGet

List<String> mGet(@NonNull String @NonNull ... keys)

Get multiple keys. Values are in the order of the requested keys.

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: MGET
• RedisStringCommands.mGet(byte[]...)

set

Boolean set(@NonNull String key,
 @NonNull String value)

Set value for key.

Parameters:

key - must not be null.

value - must not be null.

See Also:

• Redis Documentation: SET
• RedisStringCommands.set(byte[], byte[])

set

Boolean set(@NonNull String key,
 @NonNull String value,
 @Nullable Expiration expiration,
 @Nullable RedisStringCommands.SetOption option)

Set value for key applying timeouts from expiration if set and inserting/updating values depending on option.

Parameters:

key - must not be null.

value - must not be null.

expiration - can be null. Defaulted to Expiration.persistent(). Use Expiration.keepTtl() to keep the existing expiration.

option - can be null. Defaulted to RedisStringCommands.SetOption.UPSERT.

Since:

1.7

See Also:

• Redis Documentation: SET
• RedisStringCommands.set(byte[], byte[], Expiration, SetOption)

setNX

Boolean setNX(@NonNull String key,
 @NonNull String value)

Set value for key, only if key does not exist.

Parameters:

key - must not be null.

value - must not be null.

Returns:

See Also:

• Redis Documentation: SETNX
• RedisStringCommands.setNX(byte[], byte[])

setEx

Boolean setEx(@NonNull String key,
 long seconds,
 @NonNull String value)

Set the value and expiration in seconds for key.

Parameters:

key - must not be null.

seconds -

value - must not be null.

See Also:

• Redis Documentation: SETEX
• RedisStringCommands.setEx(byte[], long, byte[])

pSetEx

Boolean pSetEx(@NonNull String key,
 long milliseconds,
 @NonNull String value)

Set the value and expiration in milliseconds for key.

Parameters:

key - must not be null.

milliseconds -

value - must not be null.

Since:

1.3

See Also:

• Redis Documentation: PSETEX
• RedisStringCommands.pSetEx(byte[], long, byte[])

mSetString

Boolean mSetString(@NonNull Map<@NonNull String, String> tuple)

Set multiple keys to multiple values using key-value pairs provided in tuple.

Parameters:

tuple - must not be null.

See Also:

• Redis Documentation: MSET
• RedisStringCommands.mSet(Map)

mSetNXString

Boolean mSetNXString(@NonNull Map<@NonNull String, String> tuple)

Set multiple keys to multiple values using key-value pairs provided in tuple only if the provided key does not exist.

Parameters:

tuple - must not be null.

See Also:

• Redis Documentation: MSETNX
• RedisStringCommands.mSetNX(Map)

incr

Long incr(@NonNull String key)

Increment an integer value stored as string value of key by 1.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: INCR
• RedisStringCommands.incr(byte[])

incrBy

Long incrBy(@NonNull String key,
 long value)

Increment an integer value stored of key by delta.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: INCRBY
• RedisStringCommands.incrBy(byte[], long)

incrBy

Double incrBy(@NonNull String key,
 double value)

Increment a floating point number value of key by delta.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: INCRBYFLOAT
• RedisStringCommands.incrBy(byte[], double)

decr

Long decr(@NonNull String key)

Decrement an integer value stored as string value of key by 1.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: DECR
• RedisStringCommands.decr(byte[])

decrBy

Long decrBy(@NonNull String key,
 long value)

Decrement an integer value stored as string value of key by value.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: DECRBY
• RedisStringCommands.decrBy(byte[], long)

append

Long append(@NonNull String key,
 String value)

Append a value to key.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: APPEND
• RedisStringCommands.append(byte[], byte[])

getRange

String getRange(@NonNull String key,
 long start,
 long end)

Get a substring of value of key between start and end.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: GETRANGE
• RedisStringCommands.getRange(byte[], long, long)

setRange

void setRange(@NonNull String key,
 String value,
 long offset)

Overwrite parts of key starting at the specified offset with given value.

Parameters:

key - must not be null.

value -

offset -

See Also:

• Redis Documentation: SETRANGE
• RedisStringCommands.setRange(byte[], byte[], long)

getBit

Boolean getBit(@NonNull String key,
 long offset)

Get the bit value at offset of value at key.

Parameters:

key - must not be null.

offset -

Returns:

See Also:

• Redis Documentation: GETBIT
• RedisStringCommands.getBit(byte[], long)

setBit

Boolean setBit(@NonNull String key,
 long offset,
 boolean value)

Sets the bit at offset in value stored at key.

Parameters:

key - must not be null.

offset -

value -

Returns:

the original bit value stored at offset.

See Also:

• Redis Documentation: SETBIT
• RedisStringCommands.setBit(byte[], long, boolean)

bitCount

Long bitCount(@NonNull String key)

Count the number of set bits (population counting) in value stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: BITCOUNT
• RedisStringCommands.bitCount(byte[])

bitCount

Long bitCount(@NonNull String key,
 long start,
 long end)

Count the number of set bits (population counting) of value stored at key between start and end.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: BITCOUNT
• RedisStringCommands.bitCount(byte[], long, long)

bitOp

Long bitOp(@NonNull RedisStringCommands.BitOperation op,
 @NonNull String destination,
 @NonNull String @NonNull ... keys)

Perform bitwise operations between strings.

Parameters:

op - must not be null.

destination - must not be null.

keys - must not be null.

Returns:

See Also:

• Redis Documentation: BITOP
• RedisStringCommands.bitOp(BitOperation, byte[], byte[]...)

bitPos

default Long bitPos(@NonNull String key,
 boolean bit)

Return the position of the first bit set to given bit in a string.

Parameters:

key - the key holding the actual String.

bit - the bit value to look for.

Returns:

null when used in pipeline / transaction. The position of the first bit set to 1 or 0 according to the request.

Since:

2.1

See Also:

• Redis Documentation: BITPOS

bitPos

Long bitPos(@NonNull String key,
 boolean bit,
 @NonNull Range<Long> range)

Return the position of the first bit set to given bit in a string. Range start and end can contain negative values in order to index bytes starting from the end of the string, where -1 is the last byte, -2 is the penultimate.

Parameters:

key - the key holding the actual String.

bit - the bit value to look for.

range - must not be null. Use RedisZSetCommands.Range.unbounded() to not limit search.

Returns:

null when used in pipeline / transaction. The position of the first bit set to 1 or 0 according to the request.

Since:

2.1

See Also:

• Redis Documentation: BITPOS

strLen

Long strLen(@NonNull String key)

Get the length of the value stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: STRLEN
• RedisStringCommands.strLen(byte[])

rPush

Long rPush(@NonNull String key,
 @NonNull String @NonNull ... values)

Append values to key.

Parameters:

key - must not be null.

values -

Returns:

See Also:

• Redis Documentation: RPUSH
• RedisListCommands.rPush(byte[], byte[]...)

lPos

default Long lPos(@NonNull String key,
 @NonNull String element)

Returns the index of matching elements inside the list stored at given key.
Requires Redis 6.0.6 or newer.

Parameters:

key - must not be null.

element - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.4

See Also:

• Redis Documentation: LPOS

lPos

List<Long> lPos(@NonNull String key,
 @NonNull String element,
 @Nullable Integer rank,
 @Nullable Integer count)

Returns the index of matching elements inside the list stored at given key.
Requires Redis 6.0.6 or newer.

Parameters:

key - must not be null.

element - must not be null.

rank - specifies the "rank" of the first element to return, in case there are multiple matches. A rank of 1 means to return the first match, 2 to return the second match, and so forth.

count - number of matches to return.

Returns:

null when used in pipeline / transaction.

Since:

2.4

See Also:

• Redis Documentation: LPOS

lPush

Long lPush(@NonNull String key,
 @NonNull String @NonNull ... values)

Prepend values to key.

Parameters:

key - must not be null.

values -

Returns:

See Also:

• Redis Documentation: LPUSH
• RedisListCommands.lPush(byte[], byte[]...)

rPushX

Long rPushX(@NonNull String key,
 @NonNull String value)

Append values to key only if the list exists.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: RPUSHX
• RedisListCommands.rPushX(byte[], byte[])

lPushX

Long lPushX(@NonNull String key,
 @NonNull String value)

Prepend values to key only if the list exists.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: LPUSHX
• RedisListCommands.lPushX(byte[], byte[])

lLen

Long lLen(@NonNull String key)

Get the size of list stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: LLEN
• RedisListCommands.lLen(byte[])

lRange

List<String> lRange(@NonNull String key,
 long start,
 long end)

Get elements between start and end from list at key.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: LRANGE
• RedisListCommands.lRange(byte[], long, long)

lTrim

void lTrim(@NonNull String key,
 long start,
 long end)

Trim list at key to elements between start and end.

Parameters:

key - must not be null.

start -

end -

See Also:

• Redis Documentation: LTRIM
• RedisListCommands.lTrim(byte[], long, long)

lIndex

String lIndex(@NonNull String key,
 long index)

Get element at index form list at key.

Parameters:

key - must not be null.

index -

Returns:

See Also:

• Redis Documentation: LINDEX
• RedisListCommands.lIndex(byte[], long)

lInsert

Long lInsert(@NonNull String key,
 @NonNull RedisListCommands.Position where,
 @NonNull String pivot,
 String value)

Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.

Parameters:

key - must not be null.

where - must not be null.

pivot -

value -

Returns:

See Also:

• Redis Documentation: LINSERT
• RedisListCommands.lIndex(byte[], long)

lMove

String lMove(@NonNull String sourceKey,
 @NonNull String destinationKey,
 @NonNull RedisListCommands.Direction from,
 @NonNull RedisListCommands.Direction to)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

from - must not be null.

to - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: LMOVE
• DefaultedRedisConnection.bLMove(byte[], byte[], Direction, Direction, double)
• DefaultedRedisConnection.lMove(byte[], byte[], Direction, Direction)

bLMove

String bLMove(@NonNull String sourceKey,
 @NonNull String destinationKey,
 @NonNull RedisListCommands.Direction from,
 @NonNull RedisListCommands.Direction to,
 double timeout)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

from - must not be null.

to - must not be null.

timeout -

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: BLMOVE
• DefaultedRedisConnection.lMove(byte[], byte[], Direction, Direction)
• DefaultedRedisConnection.bLMove(byte[], byte[], Direction, Direction, double)

lSet

void lSet(@NonNull String key,
 long index,
 String value)

Set the value list element at index.

Parameters:

key - must not be null.

index -

value -

See Also:

• Redis Documentation: LSET
• RedisListCommands.lSet(byte[], long, byte[])

lRem

Long lRem(@NonNull String key,
 long count,
 String value)

Removes the first count occurrences of value from the list stored at key.

Parameters:

key - must not be null.

count -

value -

Returns:

See Also:

• Redis Documentation: LREM
• RedisListCommands.lRem(byte[], long, byte[])

lPop

String lPop(@NonNull String key)

Removes and returns first element in list stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: LPOP
• RedisListCommands.lPop(byte[])

lPop

List<String> lPop(@NonNull String key,
 long count)

Removes and returns first elements in list stored at key.

Parameters:

key - must not be null.

count -

Returns:

Since:

2.6

See Also:

• Redis Documentation: LPOP
• RedisListCommands.lPop(byte[], long)

rPop

String rPop(@NonNull String key)

Removes and returns last element in list stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: RPOP
• RedisListCommands.rPop(byte[])

rPop

List<String> rPop(@NonNull String key,
 long count)

Removes and returns last elements in list stored at key.

Parameters:

key - must not be null.

count -

Returns:

Since:

2.6

See Also:

• Redis Documentation: RPOP
• RedisListCommands.rPop(byte[], long)

bLPop

List<String> bLPop(int timeout,
 @NonNull String @NonNull ... keys)

Removes and returns first element from lists stored at keys (see: DefaultedRedisConnection.lPop(byte[])).
Blocks connection until element available or timeout reached.

Parameters:

timeout -

keys - must not be null.

Returns:

See Also:

• Redis Documentation: BLPOP
• RedisListCommands.bLPop(int, byte[]...)

bRPop

List<String> bRPop(int timeout,
 @NonNull String @NonNull ... keys)

Removes and returns last element from lists stored at keys (see: DefaultedRedisConnection.rPop(byte[])).
Blocks connection until element available or timeout reached.

Parameters:

timeout -

keys - must not be null.

Returns:

See Also:

• Redis Documentation: BRPOP
• RedisListCommands.bRPop(int, byte[]...)

rPopLPush

String rPopLPush(@NonNull String srcKey,
 @NonNull String dstKey)

Remove the last element from list at srcKey, append it to dstKey and return its value.

Parameters:

srcKey - must not be null.

dstKey - must not be null.

Returns:

See Also:

• Redis Documentation: RPOPLPUSH
• RedisListCommands.rPopLPush(byte[], byte[])

bRPopLPush

String bRPopLPush(int timeout,
 @NonNull String srcKey,
 @NonNull String dstKey)

Remove the last element from list at srcKey, append it to dstKey and return its value (see DefaultedRedisConnection.rPopLPush(byte[], byte[])).
Blocks connection until element available or timeout reached.

Parameters:

timeout -

srcKey - must not be null.

dstKey - must not be null.

Returns:

See Also:

• Redis Documentation: BRPOPLPUSH
• RedisListCommands.bRPopLPush(int, byte[], byte[])

sAdd

Long sAdd(@NonNull String key,
 String... values)

Add given values to set at key.

Parameters:

key - must not be null.

values -

Returns:

See Also:

• Redis Documentation: SADD
• RedisSetCommands.sAdd(byte[], byte[]...)

sRem

Long sRem(@NonNull String key,
 String... values)

Remove given values from set at key and return the number of removed elements.

Parameters:

key - must not be null.

values -

Returns:

See Also:

• Redis Documentation: SREM
• RedisSetCommands.sRem(byte[], byte[]...)

sPop

String sPop(@NonNull String key)

Remove and return a random member from set at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: SPOP
• RedisSetCommands.sPop(byte[])

sPop

List<String> sPop(@NonNull String key,
 long count)

Remove and return count random members from set at key.

Parameters:

key - must not be null.

count - the number of random members to return.

Returns:

empty List if key does not exist.

Since:

2.0

See Also:

• Redis Documentation: SPOP
• RedisSetCommands.sPop(byte[], long)

sMove

Boolean sMove(@NonNull String srcKey,
 @NonNull String destKey,
 String value)

Move value from srcKey to destKey

Parameters:

srcKey - must not be null.

destKey - must not be null.

value -

Returns:

See Also:

• Redis Documentation: SMOVE
• RedisSetCommands.sMove(byte[], byte[], byte[])

sCard

Long sCard(@NonNull String key)

Get size of set at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: SCARD
• RedisSetCommands.sCard(byte[])

sIsMember

Boolean sIsMember(@NonNull String key,
 String value)

Check if set at key contains value.

Parameters:

key - must not be null.

value -

Returns:

See Also:

• Redis Documentation: SISMEMBER
• RedisSetCommands.sIsMember(byte[], byte[])

sMIsMember

List<Boolean> sMIsMember(@NonNull String key,
 String... values)

Check if set at key contains one or more values.

Parameters:

key - must not be null.

values - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: SMISMEMBER
• RedisSetCommands.sMIsMember(byte[], byte[]...)

sInter

Set<String> sInter(@NonNull String @NonNull ... keys)

Returns the members intersecting all given sets at keys.

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: SINTER
• RedisSetCommands.sInter(byte[]...)

sInterStore

Long sInterStore(@NonNull String destKey,
 @NonNull String @NonNull ... keys)

Intersect all given sets at keys and store result in destKey.

Parameters:

destKey - must not be null.

keys - must not be null.

Returns:

See Also:

• Redis Documentation: SINTERSTORE
• RedisSetCommands.sInterStore(byte[], byte[]...)

sUnion

Set<String> sUnion(String... keys)

Union all sets at given keys.

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: SUNION
• RedisSetCommands.sUnion(byte[]...)

sUnionStore

Long sUnionStore(String destKey,
 String... keys)

Union all sets at given keys and store result in destKey.

Parameters:

destKey - must not be null.

keys - must not be null.

Returns:

See Also:

• Redis Documentation: SUNIONSTORE
• RedisSetCommands.sUnionStore(byte[], byte[]...)

sDiff

Set<String> sDiff(String... keys)

Diff all sets for given keys.

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: SDIFF
• RedisSetCommands.sDiff(byte[]...)

sDiffStore

Long sDiffStore(String destKey,
 String... keys)

Diff all sets for given keys and store result in destKey.

Parameters:

destKey - must not be null.

keys - must not be null.

Returns:

See Also:

• Redis Documentation: SDIFFSTORE
• RedisSetCommands.sDiffStore(byte[], byte[]...)

sMembers

Set<String> sMembers(@NonNull String key)

Get all elements of set at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: SMEMBERS
• RedisSetCommands.sMembers(byte[])

sRandMember

String sRandMember(@NonNull String key)

Get random element from set at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: SRANDMEMBER
• RedisSetCommands.sRandMember(byte[])

sRandMember

List<String> sRandMember(@NonNull String key,
 long count)

Get count random elements from set at key.

Parameters:

key - must not be null.

count -

Returns:

See Also:

• Redis Documentation: SRANDMEMBER
• RedisSetCommands.sRem(byte[], byte[]...)

sScan

Cursor<String> sScan(@NonNull String key,
 ScanOptions options)

Use a Cursor to iterate over elements in set at key.

Parameters:

key - must not be null.

options - must not be null.

Returns:

Since:

1.4

See Also:

• Redis Documentation: SCAN
• RedisSetCommands.sScan(byte[], ScanOptions)

zAdd

Boolean zAdd(@NonNull String key,
 double score,
 String value)

Add value to a sorted set at key, or update its score if it already exists.

Parameters:

key - must not be null.

score - the score.

value - the value.

Returns:

See Also:

• Redis Documentation: ZADD
• RedisZSetCommands.zAdd(byte[], double, byte[])

zAdd

Boolean zAdd(@NonNull String key,
 double score,
 String value,
 RedisZSetCommands.ZAddArgs args)

Add the value to a sorted set at key, or update its score depending on the given args.

Parameters:

key - must not be null.

score - must not be null.

value - must not be null.

args - must not be null use RedisZSetCommands.ZAddArgs.empty() instead.

Returns:

null when used in pipeline / transaction.

Since:

2.5

See Also:

• Redis Documentation: ZADD
• RedisZSetCommands.zAdd(byte[], double, byte[], ZAddArgs)

zAdd

Long zAdd(@NonNull String key,
 Set<StringRedisConnection.StringTuple> tuples)

Add tuples to a sorted set at key, or update its score if it already exists.

Parameters:

key - must not be null.

tuples - the tuples.

Returns:

See Also:

• Redis Documentation: ZADD
• RedisZSetCommands.zAdd(byte[], Set)

zAdd

Long zAdd(@NonNull String key,
 Set<StringRedisConnection.StringTuple> tuples,
 RedisZSetCommands.ZAddArgs args)

Add tuples to a sorted set at key, or update its score depending on the given args.

Parameters:

key - must not be null.

tuples - must not be null.

args - must not be null use RedisZSetCommands.ZAddArgs.empty() instead.

Returns:

null when used in pipeline / transaction.

Since:

2.5

See Also:

• Redis Documentation: ZADD
• RedisZSetCommands.zAdd(byte[], Set, ZAddArgs)

zRem

Long zRem(@NonNull String key,
 String... values)

Remove values from sorted set. Return number of removed elements.

Parameters:

key - must not be null.

values - must not be null.

Returns:

See Also:

• Redis Documentation: ZREM
• RedisZSetCommands.zRem(byte[], byte[]...)

zIncrBy

Double zIncrBy(@NonNull String key,
 double increment,
 String value)

Increment the score of element with value in sorted set by increment.

Parameters:

key - must not be null.

increment -

value - the value.

Returns:

See Also:

• Redis Documentation: ZINCRBY
• RedisZSetCommands.zIncrBy(byte[], double, byte[])

zRandMember

String zRandMember(@NonNull String key)

Get random element from sorted set at key.

Parameters:

key - must not be null.

Returns:

can be null.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

zRandMember

List<String> zRandMember(@NonNull String key,
 long count)

Get count random elements from sorted set at key.

Parameters:

key - must not be null.

count - if the provided count argument is positive, return a list of distinct fields, capped either at count or the set size. If count is negative, the behavior changes and the command is allowed to return the same value multiple times. In this case, the number of returned values is the absolute value of the specified count.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

zRandMemberWithScore

StringRedisConnection.StringTuple zRandMemberWithScore(@NonNull String key)

Get random element from sorted set at key.

Parameters:

key - must not be null.

Returns:

can be null.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

zRandMemberWithScores

List<StringRedisConnection.StringTuple> zRandMemberWithScores(@NonNull String key,
 long count)

Get count random elements from sorted set at key.

Parameters:

key - must not be null.

count - if the provided count argument is positive, return a list of distinct fields, capped either at count or the set size. If count is negative, the behavior changes and the command is allowed to return the same value multiple times. In this case, the number of returned values is the absolute value of the specified count.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

zRank

Long zRank(@NonNull String key,
 String value)

Determine the index of element with value in a sorted set.

Parameters:

key - must not be null.

value - the value.

Returns:

See Also:

• Redis Documentation: ZRANK
• RedisZSetCommands.zRank(byte[], byte[])

zRevRank

Long zRevRank(@NonNull String key,
 String value)

Determine the index of element with value in a sorted set when scored high to low.

Parameters:

key - must not be null.

value - the value.

Returns:

See Also:

• Redis Documentation: ZREVRANK
• RedisZSetCommands.zRevRank(byte[], byte[])

zRange

Set<String> zRange(@NonNull String key,
 long start,
 long end)

Get elements between start and end from sorted set.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: ZRANGE
• RedisZSetCommands.zRange(byte[], long, long)

zRangeWithScores

Set<StringRedisConnection.StringTuple> zRangeWithScores(@NonNull String key,
 long start,
 long end)

Get set of Tuples between start and end from sorted set.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: ZRANGE
• RedisZSetCommands.zRangeWithScores(byte[], long, long)

zRangeByScore

Set<String> zRangeByScore(@NonNull String key,
 double min,
 double max)

Get elements where score is between min and max from sorted set.

Parameters:

key - must not be null.

min -

max -

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE
• RedisZSetCommands.zRangeByScore(byte[], double, double)

zRangeByScoreWithScores

Set<StringRedisConnection.StringTuple> zRangeByScoreWithScores(@NonNull String key,
 double min,
 double max)

Get set of Tuples where score is between min and max from sorted set.

Parameters:

key - must not be null.

min -

max -

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE
• RedisZSetCommands.zRangeByScoreWithScores(byte[], double, double)

zRangeByScore

Set<String> zRangeByScore(@NonNull String key,
 double min,
 double max,
 long offset,
 long count)

Get elements in range from start to end where score is between min and max from sorted set.

Parameters:

key - must not be null.

min -

max -

offset -

count -

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE
• RedisZSetCommands.zRangeByScore(byte[], double, double, long, long)

zRangeByScoreWithScores

Set<StringRedisConnection.StringTuple> zRangeByScoreWithScores(@NonNull String key,
 double min,
 double max,
 long offset,
 long count)

Get set of Tuples in range from start to end where score is between min and max from sorted set.

Parameters:

key -

min -

max -

offset -

count -

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE
• RedisZSetCommands.zRangeByScoreWithScores(byte[], double, double, long, long)

zRevRange

Set<String> zRevRange(@NonNull String key,
 long start,
 long end)

Get elements in range from start to end from sorted set ordered from high to low.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: ZREVRANGE
• RedisZSetCommands.zRevRange(byte[], long, long)

zRevRangeWithScores

Set<StringRedisConnection.StringTuple> zRevRangeWithScores(@NonNull String key,
 long start,
 long end)

Get set of Tuples in range from start to end from sorted set ordered from high to low.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: ZREVRANGE
• RedisZSetCommands.zRevRangeWithScores(byte[], long, long)

zRevRangeByScore

Set<String> zRevRangeByScore(@NonNull String key,
 double min,
 double max)

Get elements where score is between min and max from sorted set ordered from high to low.

Parameters:

key - must not be null.

min -

max -

Returns:

See Also:

• Redis Documentation: ZREVRANGE
• RedisZSetCommands.zRevRangeByScore(byte[], double, double)

zRevRangeByScoreWithScores

Set<StringRedisConnection.StringTuple> zRevRangeByScoreWithScores(@NonNull String key,
 double min,
 double max)

Get set of Tuple where score is between min and max from sorted set ordered from high to low.

Parameters:

key - must not be null.

min -

max -

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYSCORE
• RedisZSetCommands.zRevRangeByScoreWithScores(byte[], double, double)

zRevRangeByScore

Set<String> zRevRangeByScore(@NonNull String key,
 double min,
 double max,
 long offset,
 long count)

Get elements in range from start to end where score is between min and max from sorted set ordered high -> low.

Parameters:

key - must not be null.

min -

max -

offset -

count -

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYSCORE
• RedisZSetCommands.zRevRangeByScore(byte[], double, double, long, long)

zRevRangeByScoreWithScores

Set<StringRedisConnection.StringTuple> zRevRangeByScoreWithScores(@NonNull String key,
 double min,
 double max,
 long offset,
 long count)

Get set of Tuple in range from start to end where score is between min and max from sorted set ordered high -> low.

Parameters:

key - must not be null.

min -

max -

offset -

count -

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYSCORE
• RedisZSetCommands.zRevRangeByScoreWithScores(byte[], double, double, long, long)

zCount

Long zCount(@NonNull String key,
 double min,
 double max)

Count number of elements within sorted set with scores between min and max.

Parameters:

key - must not be null.

min -

max -

Returns:

See Also:

• Redis Documentation: ZCOUNT
• RedisZSetCommands.zCount(byte[], double, double)

zLexCount

Long zLexCount(@NonNull String key,
 @NonNull Range<String> range)

Count number of elements within sorted set with value between Range#min and Range#max applying lexicographical ordering.

Parameters:

key - must not be null.

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.4

See Also:

• Redis Documentation: ZLEXCOUNT
• RedisZSetCommands.zLexCount(byte[], org.springframework.data.domain.Range)

zPopMin

Tuple zPopMin(@NonNull String key)

Remove and return the value with its score having the lowest score from sorted set at key.

Parameters:

key - must not be null.

Returns:

null when the sorted set is empty or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZPOPMIN

zPopMin

Set<StringRedisConnection.StringTuple> zPopMin(@NonNull String key,
 long count)

Remove and return count values with their score having the lowest score from sorted set at key.

Parameters:

key - must not be null.

count - number of elements to pop.

Returns:

null when the sorted set is empty or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZPOPMIN

bZPopMin

StringRedisConnection.StringTuple bZPopMin(@NonNull String key,
 long timeout,
 @NonNull TimeUnit unit)

Remove and return the value with its score having the lowest score from sorted set at key. Blocks connection until element available or timeout reached.

Parameters:

key - must not be null.

timeout -

unit - must not be null.

Returns:

can be null.

Since:

2.6

See Also:

• Redis Documentation: BZPOPMIN

zPopMax

StringRedisConnection.StringTuple zPopMax(@NonNull String key)

Remove and return the value with its score having the highest score from sorted set at key.

Parameters:

key - must not be null.

Returns:

null when the sorted set is empty or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZPOPMAX

zPopMax

Set<StringRedisConnection.StringTuple> zPopMax(@NonNull String key,
 long count)

Remove and return count values with their score having the highest score from sorted set at key.

Parameters:

key - must not be null.

count - number of elements to pop.

Returns:

null when the sorted set is empty or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZPOPMAX

bZPopMax

StringRedisConnection.StringTuple bZPopMax(@NonNull String key,
 long timeout,
 @NonNull TimeUnit unit)

Remove and return the value with its score having the highest score from sorted set at key. Blocks connection until element available or timeout reached.

Parameters:

key - must not be null.

timeout -

unit - must not be null.

Returns:

can be null.

Since:

2.6

See Also:

• Redis Documentation: BZPOPMAX

zCard

Long zCard(@NonNull String key)

Get the size of sorted set with key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: ZCARD
• RedisZSetCommands.zCard(byte[])

zScore

Double zScore(@NonNull String key,
 String value)

Get the score of element with value from sorted set with key key.

Parameters:

key - must not be null.

value - the value.

Returns:

See Also:

• Redis Documentation: ZSCORE
• RedisZSetCommands.zScore(byte[], byte[])

zMScore

List<Double> zMScore(@NonNull String key,
 String... values)

Get the scores of elements with values from sorted set with key key.

Parameters:

key - must not be null.

values - the values.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZMSCORE
• RedisZSetCommands.zMScore(byte[], byte[][])

zRemRange

Long zRemRange(@NonNull String key,
 long start,
 long end)

Remove elements in range between start and end from sorted set with key.

Parameters:

key - must not be null.

start -

end -

Returns:

See Also:

• Redis Documentation: ZREMRANGEBYRANK
• RedisZSetCommands.zRemRange(byte[], long, long)

zRemRangeByLex

Long zRemRangeByLex(@NonNull String key,
 @NonNull Range<String> range)

Remove all elements between the lexicographical RedisZSetCommands.Range.

Parameters:

key - must not be null.

range - must not be null.

Returns:

the number of elements removed, or null when used in pipeline / transaction.

Since:

2.5

See Also:

• Redis Documentation: ZREMRANGEBYLEX

zRemRangeByScore

Long zRemRangeByScore(@NonNull String key,
 double min,
 double max)

Remove elements with scores between min and max from sorted set with key.

Parameters:

key - must not be null.

min -

max -

Returns:

See Also:

• Redis Documentation: ZREMRANGEBYSCORE
• RedisZSetCommands.zRemRangeByScore(byte[], double, double)

zDiff

Set<String> zDiff(@NonNull String @NonNull ... sets)

Diff sorted sets.

Parameters:

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZDIFF

zDiffWithScores

Set<StringRedisConnection.StringTuple> zDiffWithScores(@NonNull String @NonNull ... sets)

Diff sorted sets.

Parameters:

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZDIFF

zDiffStore

Long zDiffStore(@NonNull String destKey,
 @NonNull String @NonNull ... sets)

Diff sorted sets and store result in destination destKey.

Parameters:

destKey - must not be null.

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZDIFFSTORE

zInter

Set<String> zInter(@NonNull String @NonNull ... sets)

Intersect sorted sets.

Parameters:

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZINTER

zInterWithScores

Set<StringRedisConnection.StringTuple> zInterWithScores(@NonNull String @NonNull ... sets)

Intersect sorted sets.

Parameters:

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZINTER

zInterWithScores

default Set<StringRedisConnection.StringTuple> zInterWithScores(@NonNull Aggregate aggregate,
 int @NonNull [] weights,
 @NonNull String @NonNull ... sets)

Intersect sorted sets.

Parameters:

aggregate - must not be null.

weights - must not be null.

sets - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

zInterWithScores

Set<StringRedisConnection.StringTuple> zInterWithScores(@NonNull Aggregate aggregate,
 @NonNull Weights weights,
 @NonNull String @NonNull ... sets)

Intersect sorted sets.

Parameters:

aggregate - must not be null.

weights - must not be null.

sets - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

zInterStore

Long zInterStore(@NonNull String destKey,
 @NonNull String @NonNull ... sets)

Intersect sorted sets and store result in destination key.

Parameters:

destKey - must not be null.

sets - must not be null.

Returns:

See Also:

• Redis Documentation: ZINTERSTORE
• RedisZSetCommands.zInterStore(byte[], byte[]...)

zInterStore

Long zInterStore(@NonNull String destKey,
 @NonNull Aggregate aggregate,
 int @NonNull [] weights,
 @NonNull String @NonNull ... sets)

Intersect sorted sets and store result in destination key.

Parameters:

destKey - must not be null.

aggregate - must not be null.

weights -

sets - must not be null.

Returns:

See Also:

• Redis Documentation: ZINTERSTORE
• RedisZSetCommands.zInterStore(byte[], Aggregate, int[], byte[]...)

zUnion

Set<String> zUnion(@NonNull String @NonNull ... sets)

Union sorted sets.

Parameters:

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZUNION

zUnionWithScores

Set<StringRedisConnection.StringTuple> zUnionWithScores(@NonNull String @NonNull ... sets)

Union sorted sets.

Parameters:

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZUNION

zUnionWithScores

default Set<StringRedisConnection.StringTuple> zUnionWithScores(@NonNull Aggregate aggregate,
 int @NonNull [] weights,
 @NonNull String @NonNull ... sets)

Union sorted sets.

Parameters:

aggregate - must not be null.

weights - must not be null.

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZUNION

zUnionWithScores

Set<StringRedisConnection.StringTuple> zUnionWithScores(@NonNull Aggregate aggregate,
 @NonNull Weights weights,
 @NonNull String @NonNull ... sets)

Union sorted sets.

Parameters:

aggregate - must not be null.

weights - must not be null.

sets - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: ZUNION

zUnionStore

Long zUnionStore(@NonNull String destKey,
 @NonNull String @NonNull ... sets)

Union sorted sets and store result in destination key.

Parameters:

destKey - must not be null.

sets - must not be null.

Returns:

See Also:

• Redis Documentation: ZUNIONSTORE
• RedisZSetCommands.zUnionStore(byte[], byte[]...)

zUnionStore

Long zUnionStore(@NonNull String destKey,
 @NonNull Aggregate aggregate,
 int @NonNull [] weights,
 @NonNull String @NonNull ... sets)

Union sorted sets and store result in destination key.

Parameters:

destKey - must not be null.

aggregate - must not be null.

weights -

sets - must not be null.

Returns:

See Also:

• Redis Documentation: ZUNIONSTORE
• RedisZSetCommands.zUnionStore(byte[], Aggregate, int[], byte[]...)

zScan

Cursor<StringRedisConnection.StringTuple> zScan(@NonNull String key,
 ScanOptions options)

Use a Cursor to iterate over elements in sorted set at key.

Parameters:

key - must not be null.

options - can be null.

Returns:

Since:

1.4

See Also:

• Redis Documentation: ZSCAN
• RedisZSetCommands.zScan(byte[], ScanOptions)

zRangeByScore

Set<String> zRangeByScore(@NonNull String key,
 @NonNull String min,
 @NonNull String max)

Get elements where score is between min and max from sorted set.

Parameters:

key - must not be null.

min - must not be null.

max - must not be null.

Returns:

Since:

1.5

See Also:

• Redis Documentation: ZRANGEBYSCORE
• RedisZSetCommands.zRangeByScore(byte[], String, String)

zRangeByScore

Set<String> zRangeByScore(@NonNull String key,
 @NonNull String min,
 @NonNull String max,
 long offset,
 long count)

Get elements in range from start to end where score is between min and max from sorted set.

Parameters:

key - must not be null.

min - must not be null.

max - must not be null.

offset -

count -

Returns:

Since:

1.5

See Also:

• Redis Documentation: ZRANGEBYSCORE
• RedisZSetCommands.zRangeByScore(byte[], double, double, long, long)

zRangeByLex

Set<String> zRangeByLex(@NonNull String key)

Get all the elements in the sorted set at key in lexicographical ordering.

Parameters:

key - must not be null.

Returns:

Since:

1.6

See Also:

• Redis Documentation: ZRANGEBYLEX
• RedisZSetCommands.zRangeByLex(byte[])

zRangeByLex

Set<String> zRangeByLex(@NonNull String key,
 @NonNull Range<String> range)

Get all the elements in RedisZSetCommands.Range from the sorted set at key in lexicographical ordering.

Parameters:

key - must not be null.

range - must not be null.

Returns:

Since:

1.6

See Also:

• Redis Documentation: ZRANGEBYLEX
• RedisZSetCommands.zRangeByLex(byte[], org.springframework.data.domain.Range)

zRangeByLex

Set<String> zRangeByLex(@NonNull String key,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Get all the elements in RedisZSetCommands.Range from the sorted set at key in lexicographical ordering. Result is limited via Limit.

Parameters:

key - must not be null.

range - must not be null.

limit - must not be null.

Returns:

Since:

1.6

See Also:

• Redis Documentation: ZRANGEBYLEX
• RedisZSetCommands.zRangeByLex(byte[], org.springframework.data.domain.Range, org.springframework.data.redis.connection.Limit)

zRevRangeByLex

default Set<String> zRevRangeByLex(@NonNull String key)

Get all the elements in the sorted set at key in reversed lexicographical ordering.

Parameters:

key - must not be null.

Returns:

Since:

2.4

See Also:

• Redis Documentation: ZREVRANGEBYLEX
• RedisZSetCommands.zRevRangeByLex(byte[])

zRevRangeByLex

default Set<String> zRevRangeByLex(@NonNull String key,
 @NonNull Range<String> range)

Get all the elements in RedisZSetCommands.Range from the sorted set at key in reversed lexicographical ordering.

Parameters:

key - must not be null.

range - must not be null.

Returns:

Since:

2.4

See Also:

• Redis Documentation: ZREVRANGEBYLEX
• RedisZSetCommands.zRevRangeByLex(byte[], org.springframework.data.domain.Range)

zRevRangeByLex

Set<String> zRevRangeByLex(@NonNull String key,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Get all the elements in RedisZSetCommands.Range from the sorted set at key in reversed lexicographical ordering. Result is limited via Limit.

Parameters:

key - must not be null.

range - must not be null.

limit - must not be null.

Returns:

Since:

2.4

See Also:

• Redis Documentation: ZREVRANGEBYLEX
• RedisZSetCommands.zRevRangeByLex(byte[], org.springframework.data.domain.Range, org.springframework.data.redis.connection.Limit)

zRangeStoreByLex

default Long zRangeStoreByLex(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<String> range)

This command is like ZRANGE , but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

zRangeStoreByLex

Long zRangeStoreByLex(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<String> range,
 @NonNull Limit limit)

This command is like ZRANGE , but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

zRangeStoreRevByLex

default Long zRangeStoreRevByLex(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<String> range)

This command is like ZRANGE … REV , but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

zRangeStoreRevByLex

Long zRangeStoreRevByLex(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<String> range,
 @NonNull Limit limit)

This command is like ZRANGE … REV , but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

zRangeStoreByScore

default Long zRangeStoreByScore(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<? extends Number> range)

This command is like ZRANGE, but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

zRangeStoreByScore

Long zRangeStoreByScore(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<? extends Number> range,
 @NonNull Limit limit)

This command is like ZRANGE, but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

zRangeStoreRevByScore

default Long zRangeStoreRevByScore(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<? extends Number> range)

This command is like ZRANGE … REV, but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

zRangeStoreRevByScore

Long zRangeStoreRevByScore(@NonNull String dstKey,
 @NonNull String srcKey,
 @NonNull Range<? extends Number> range,
 @NonNull Limit limit)

This command is like ZRANGE … REV, but stores the result in the dstKey destination key.

Parameters:

dstKey - must not be null.

srcKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

hSet

Boolean hSet(@NonNull String key,
 @NonNull String field,
 String value)

Set the value of a hash field.

Parameters:

key - must not be null.

field - must not be null.

value -

Returns:

See Also:

• Redis Documentation: HSET
• RedisHashCommands.hSet(byte[], byte[], byte[])

hSetNX

Boolean hSetNX(@NonNull String key,
 @NonNull String field,
 String value)

Set the value of a hash field only if field does not exist.

Parameters:

key - must not be null.

field - must not be null.

value -

Returns:

See Also:

• Redis Documentation: HSETNX
• RedisHashCommands.hSetNX(byte[], byte[], byte[])

hGet

String hGet(@NonNull String key,
 @NonNull String field)

Get value for given field from hash at key.

Parameters:

key - must not be null.

field - must not be null.

Returns:

See Also:

• Redis Documentation: HGET
• RedisHashCommands.hGet(byte[], byte[])

hMGet

List<String> hMGet(@NonNull String key,
 @NonNull String @NonNull ... fields)

Get values for given fields from hash at key.

Parameters:

key - must not be null.

fields - must not be null.

Returns:

See Also:

• Redis Documentation: HMGET
• RedisHashCommands.hMGet(byte[], byte[]...)

hMSet

void hMSet(@NonNull String key,
 @NonNull Map<@NonNull String, String> hashes)

Set multiple hash fields to multiple values using data provided in hashes

Parameters:

key - must not be null.

hashes - must not be null.

See Also:

• Redis Documentation: HMSET
• RedisHashCommands.hMGet(byte[], byte[]...)

hIncrBy

Long hIncrBy(@NonNull String key,
 @NonNull String field,
 long delta)

Increment value of a hash field by the given delta.

Parameters:

key - must not be null.

field - must not be null.

delta -

Returns:

See Also:

• Redis Documentation: HINCRBY
• RedisHashCommands.hIncrBy(byte[], byte[], long)

hIncrBy

Double hIncrBy(@NonNull String key,
 @NonNull String field,
 double delta)

Increment value of a hash field by the given delta.

Parameters:

key - must not be null.

field -

delta -

Returns:

See Also:

• Redis Documentation: HINCRBYFLOAT
• RedisHashCommands.hIncrBy(byte[], byte[], double)

hRandField

String hRandField(@NonNull String key)

Return a random field from the hash stored at key.

Parameters:

key - must not be null.

Returns:

null if key does not exist or when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandFieldWithValues

@Nullable Map.Entry<String,String> hRandFieldWithValues(@NonNull String key)

Return a random field from the hash along with its value stored at key.

Parameters:

key - must not be null.

Returns:

null if key does not exist or when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandField

List<String> hRandField(@NonNull String key,
 long count)

Return a random field from the hash stored at key. If the provided count argument is positive, return a list of distinct fields, capped either at count or the hash size. If count is negative, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Parameters:

key - must not be null.

count - number of fields to return.

Returns:

null if key does not exist or when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandFieldWithValues

List<Map.Entry<String,String>> hRandFieldWithValues(@NonNull String key,
 long count)

Return a random field from the hash along with its value stored at key. If the provided count argument is positive, return a list of distinct fields, capped either at count or the hash size. If count is negative, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Parameters:

key - must not be null.

count - number of fields to return.

Returns:

null if key does not exist or when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hExists

Boolean hExists(@NonNull String key,
 @NonNull String field)

Determine if given hash field exists.

Parameters:

key - must not be null.

field - must not be null.

Returns:

See Also:

• Redis Documentation: HEXISTS
• RedisHashCommands.hExists(byte[], byte[])

hDel

Long hDel(@NonNull String key,
 @NonNull String @NonNull ... fields)

Delete given hash fields.

Parameters:

key - must not be null.

fields - must not be null.

Returns:

See Also:

• Redis Documentation: HDEL
• RedisHashCommands.hDel(byte[], byte[]...)

hLen

Long hLen(@NonNull String key)

Get size of hash at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HLEN
• RedisHashCommands.hLen(byte[])

hKeys

Set<String> hKeys(@NonNull String key)

Get key set (fields) of hash at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HKEYS?
• RedisHashCommands.hKeys(byte[])

hVals

List<String> hVals(@NonNull String key)

Get entry set (values) of hash at field.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HVALS
• RedisHashCommands.hVals(byte[])

hGetAll

Map<String,String> hGetAll(@NonNull String key)

Get entire hash stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HGETALL
• RedisHashCommands.hGetAll(byte[])

hScan

Cursor<Map.Entry<String,String>> hScan(@NonNull String key,
 ScanOptions options)

Use a Cursor to iterate over entries in hash at key.

Parameters:

key - must not be null.

options - must not be null.

Returns:

Since:

1.4

See Also:

• Redis Documentation: HSCAN
• RedisHashCommands.hScan(byte[], ScanOptions)

hStrLen

Long hStrLen(@NonNull String key,
 @NonNull String field)

Returns the length of the value associated with field in the hash stored at key. If the key or the field do not exist, 0 is returned.

Parameters:

key - must not be null.

field - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

hExpire

default List<Long> hExpire(@NonNull String key,
 long seconds,
 @NonNull String @NonNull ... fields)

Set time to live for given field in seconds.

Parameters:

key - must not be null.

seconds - the amount of time after which the key will be expired in seconds, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set; -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HEXPIRE

hExpire

List<Long> hExpire(@NonNull String key,
 long seconds,
 @NonNull ExpirationOptions.Condition condition,
 @NonNull String @NonNull ... fields)

Set time to live for given field in seconds.

Parameters:

key - must not be null.

seconds - the amount of time after which the key will be expired in seconds, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HEXPIRE

hpExpire

default List<Long> hpExpire(@NonNull String key,
 long millis,
 @NonNull String @NonNull ... fields)

Set time to live for given field in milliseconds.

Parameters:

key - must not be null.

millis - the amount of time after which the key will be expired in milliseconds, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set; -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HPEXPIRE

hpExpire

List<Long> hpExpire(@NonNull String key,
 long millis,
 @NonNull ExpirationOptions.Condition condition,
 @NonNull String @NonNull ... fields)

Set time to live for given field in milliseconds.

Parameters:

key - must not be null.

millis - the amount of time after which the key will be expired in milliseconds, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HPEXPIRE

hExpireAt

default List<Long> hExpireAt(@NonNull String key,
 long unixTime,
 @NonNull String @NonNull ... fields)

Set the expiration for given field as a UNIX timestamp.

Parameters:

key - must not be null.

unixTime - the moment in time in which the field expires, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set; -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HEXPIREAT

hExpireAt

List<Long> hExpireAt(@NonNull String key,
 long unixTime,
 @NonNull ExpirationOptions.Condition condition,
 @NonNull String @NonNull ... fields)

Set the expiration for given field as a UNIX timestamp.

Parameters:

key - must not be null.

unixTime - the moment in time in which the field expires, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HEXPIREAT

hpExpireAt

default List<Long> hpExpireAt(@NonNull String key,
 long unixTimeInMillis,
 @NonNull String @NonNull ... fields)

Set the expiration for given field as a UNIX timestamp in milliseconds.

Parameters:

key - must not be null.

unixTimeInMillis - the moment in time in which the field expires in milliseconds, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set; -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HPEXPIREAT

hpExpireAt

List<Long> hpExpireAt(@NonNull String key,
 long unixTimeInMillis,
 @NonNull ExpirationOptions.Condition condition,
 @NonNull String @NonNull ... fields)

Set the expiration for given field as a UNIX timestamp in milliseconds.

Parameters:

key - must not be null.

unixTimeInMillis - the moment in time in which the field expires in milliseconds, must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HPEXPIREAT

hPersist

List<Long> hPersist(@NonNull String key,
 @NonNull String @NonNull ... fields)

Remove the expiration from given field.

Parameters:

key - must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: 1 indicating expiration time is removed; -1 field has no expiration time to be removed; -2 indicating there is no such field; null when used in pipeline / transaction.null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HPERSIST

hTtl

List<Long> hTtl(@NonNull String key,
 @NonNull String @NonNull ... fields)

Get the time to live for fields in seconds.

Parameters:

key - must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: the time to live in milliseconds; or a negative value to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HTTL

hTtl

List<Long> hTtl(@NonNull String key,
 @NonNull TimeUnit timeUnit,
 @NonNull String @NonNull ... fields)

Get the time to live for fields in and convert it to the given TimeUnit.

Parameters:

key - must not be null.

timeUnit - must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: the time to live in the TimeUnit provided; or a negative value to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HTTL

hpTtl

List<Long> hpTtl(@NonNull String key,
 @NonNull String @NonNull ... fields)

Get the time to live for fields in seconds.

Parameters:

key - must not be null.

fields - must not be null.

Returns:

a list of Long values for each of the fields provided: the time to live in milliseconds; or a negative value to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist; null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: HTTL

pfAdd

Long pfAdd(@NonNull String key,
 String... values)

Adds given values to the HyperLogLog stored at given key.

Parameters:

key - must not be null.

values - must not be null.

Returns:

Since:

1.5

See Also:

• Redis Documentation: PFADD
• RedisHyperLogLogCommands.pfAdd(byte[], byte[]...)

pfCount

Long pfCount(@NonNull String @NonNull ... keys)

Return the approximated cardinality of the structures observed by the HyperLogLog at key(s).

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: PFCOUNT
• RedisHyperLogLogCommands.pfCount(byte[]...)

pfMerge

void pfMerge(@NonNull String destinationKey,
 @NonNull String @NonNull ... sourceKeys)

Merge N different HyperLogLogs at sourceKeys into a single destinationKey.

Parameters:

destinationKey - must not be null.

sourceKeys - must not be null.

See Also:

• Redis Documentation: PFMERGE
• RedisHyperLogLogCommands.pfMerge(byte[], byte[]...)

geoAdd

Long geoAdd(@NonNull String key,
 @NonNull Point point,
 @NonNull String member)

Add Point with given member name to key.

Parameters:

key - must not be null.

point - must not be null.

member - must not be null.

Returns:

Number of elements added.

Since:

1.8

See Also:

• Redis Documentation: GEOADD
• RedisGeoCommands.geoAdd(byte[], Point, byte[])

geoAdd

Long geoAdd(@NonNull String key,
 @NonNull RedisGeoCommands.GeoLocation<String> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added.

Since:

1.8

See Also:

• Redis Documentation: GEOADD
• RedisGeoCommands.geoAdd(byte[], GeoLocation)

geoAdd

Long geoAdd(@NonNull String key,
 @NonNull Map<@NonNull String, @NonNull Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Parameters:

key - must not be null.

memberCoordinateMap - must not be null.

Returns:

Number of elements added.

Since:

1.8

See Also:

• Redis Documentation: GEOADD
• RedisGeoCommands.geoAdd(byte[], Map)

geoAdd

Long geoAdd(@NonNull String key,
 @NonNull Iterable<@NonNull RedisGeoCommands.GeoLocation<String>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added.

Since:

1.8

See Also:

• Redis Documentation: GEOADD
• RedisGeoCommands.geoAdd(byte[], Iterable)

geoDist

Distance geoDist(@NonNull String key,
 @NonNull String member1,
 @NonNull String member2)

Get the Distance between member1 and member2.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

Returns:

can be null.

Since:

1.8

See Also:

• Redis Documentation: GEODIST
• RedisGeoCommands.geoDist(byte[], byte[], byte[])

geoDist

Distance geoDist(@NonNull String key,
 @NonNull String member1,
 @NonNull String member2,
 @NonNull Metric metric)

Get the Distance between member1 and member2 in the given Metric.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

metric - must not be null.

Returns:

can be null.

Since:

1.8

See Also:

• Redis Documentation: GEODIST
• RedisGeoCommands.geoDist(byte[], byte[], byte[], Metric)

geoHash

List<String> geoHash(@NonNull String key,
 @NonNull String @NonNull ... members)

Get geohash representation of the position for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null.

Since:

1.8

See Also:

• Redis Documentation: GEOHASH
• RedisGeoCommands.geoHash(byte[], byte[]...)

geoPos

List<Point> geoPos(@NonNull String key,
 @NonNull String @NonNull ... members)

Get the Point representation of positions for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null.

Since:

1.8

See Also:

• Redis Documentation: GEOPOS
• RedisGeoCommands.geoPos(byte[], byte[]...)

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<String>> geoRadius(@NonNull String key,
 @NonNull Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

key - must not be null.

within - must not be null.

Returns:

never null.

Since:

1.8

See Also:

• Redis Documentation: GEORADIUS
• RedisGeoCommands.geoRadius(byte[], Circle)

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<String>> geoRadius(@NonNull String key,
 @NonNull Circle within,
 @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

within - must not be null.

args - must not be null.

Returns:

never null.

Since:

1.8

See Also:

• Redis Documentation: GEORADIUS
• RedisGeoCommands.geoRadius(byte[], Circle, GeoRadiusCommandArgs)

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<String>> geoRadiusByMember(@NonNull String key,
 @NonNull String member,
 double radius)

Get the members within the circle defined by the members coordinates and given radius.

Parameters:

key - must not be null.

member - must not be null.

radius -

Returns:

never null.

Since:

1.8

See Also:

• Redis Documentation: GEORADIUSBYMEMBER
• RedisGeoCommands.geoRadiusByMember(byte[], byte[], double)

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<String>> geoRadiusByMember(@NonNull String key,
 @NonNull String member,
 @NonNull Distance radius)

Get the members within the circle defined by the members coordinates and given Distance.

Parameters:

key - must not be null.

member - must not be null.

radius - must not be null.

Returns:

never null.

Since:

1.8

See Also:

• Redis Documentation: GEORADIUSBYMEMBER
• RedisGeoCommands.geoRadiusByMember(byte[], byte[], Distance)

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<String>> geoRadiusByMember(@NonNull String key,
 @NonNull String member,
 @NonNull Distance radius,
 @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the circle defined by the members coordinates and given Distance and RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

member - must not be null.

radius - must not be null.

args - must not be null.

Returns:

never null.

Since:

1.8

See Also:

• Redis Documentation: GEORADIUSBYMEMBER
• RedisGeoCommands.geoRadiusByMember(byte[], byte[], Distance, GeoRadiusCommandArgs)

geoRemove

Long geoRemove(@NonNull String key,
 @NonNull String @NonNull ... members)

Remove the members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of members elements removed.

Since:

1.8

See Also:

• Redis Documentation: ZREM
• RedisGeoCommands.geoRemove(byte[], byte[]...)

geoSearch

GeoResults<RedisGeoCommands.GeoLocation<String>> geoSearch(@NonNull String key,
 @NonNull GeoReference<String> reference,
 @NonNull GeoShape predicate,
 @NonNull RedisGeoCommands.GeoSearchCommandArgs args)

Return the members of a geo set which are within the borders of the area specified by a given shape. The query's center point is provided by GeoReference.

Parameters:

key - must not be null.

reference - must not be null.

predicate - must not be null.

args - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

geoSearchStore

Long geoSearchStore(String destKey,
 @NonNull String key,
 @NonNull GeoReference<String> reference,
 @NonNull GeoShape predicate,
 @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)

Query the members of a geo set which are within the borders of the area specified by a given shape and store the result at destKey. The query's center point is provided by GeoReference.

Parameters:

key - must not be null.

reference - must not be null.

predicate - must not be null.

args - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

publish

Long publish(@NonNull String channel,
 @NonNull String message)

Publishes the given message to the given channel.

Parameters:

channel - the channel to publish to, must not be null.

message - message to publish

Returns:

the number of clients that received the message

See Also:

• Redis Documentation: PUBLISH
• RedisPubSubCommands.publish(byte[], byte[])

subscribe

void subscribe(@NonNull MessageListener listener,
 @NonNull String @NonNull ... channels)

Subscribes the connection to the given channels. Once subscribed, a connection enters listening mode and can only subscribe to other channels or unsubscribe. No other commands are accepted until the connection is unsubscribed.

Note that this operation is blocking and the current thread starts waiting for new messages immediately.

Parameters:

listener - message listener, must not be null.

channels - channel names, must not be null.

See Also:

• Redis Documentation: SUBSCRIBE
• RedisPubSubCommands.subscribe(MessageListener, byte[]...)

pSubscribe

void pSubscribe(@NonNull MessageListener listener,
 @NonNull String @NonNull ... patterns)

Subscribes the connection to all channels matching the given patterns. Once subscribed, a connection enters listening mode and can only subscribe to other channels or unsubscribe. No other commands are accepted until the connection is unsubscribed.

Note that this operation is blocking and the current thread starts waiting for new messages immediately.

Parameters:

listener - message listener, must not be null.

patterns - channel name patterns, must not be null.

See Also:

• Redis Documentation: PSUBSCRIBE
• RedisPubSubCommands.pSubscribe(MessageListener, byte[]...)

scriptLoad

String scriptLoad(@NonNull String script)

Load lua script into scripts cache, without executing it.
Execute the script by calling DefaultedRedisConnection.evalSha(byte[], ReturnType, int, byte[]...).

Parameters:

script - must not be null.

Returns:

See Also:

• Redis Documentation: SCRIPT LOAD
• RedisScriptingCommands.scriptLoad(byte[])

eval

<T> T eval(@NonNull String script,
 @NonNull ReturnType returnType,
 int numKeys,
 @NonNull String @NonNull ... keysAndArgs)

Evaluate given script.

Parameters:

script - must not be null.

returnType - must not be null.

numKeys -

keysAndArgs - must not be null.

Returns:

See Also:

• Redis Documentation: EVAL
• RedisScriptingCommands.eval(byte[], ReturnType, int, byte[]...)

evalSha

<T> T evalSha(@NonNull String scriptSha,
 @NonNull ReturnType returnType,
 int numKeys,
 @NonNull String @NonNull ... keysAndArgs)

Evaluate given scriptSha.

Parameters:

scriptSha - must not be null.

returnType - must not be null.

numKeys -

keysAndArgs - must not be null.

Returns:

See Also:

• Redis Documentation: EVALSHA
• RedisScriptingCommands.evalSha(String, ReturnType, int, byte[]...)

setClientName

void setClientName(@NonNull String name)

Assign given name to current connection.

Parameters:

name -

Since:

1.3

See Also:

• Redis Documentation: CLIENT SETNAME
• RedisServerCommands.setClientName(byte[])

getClientList

List<RedisClientInfo> getClientList()

Request information and statistics about connected clients.

Specified by:

getClientList in interface DefaultedRedisConnection

Specified by:

getClientList in interface RedisServerCommands

Returns:

List of RedisClientInfo objects.

Since:

1.3

See Also:

• Redis Documentation: CLIENT LIST
• RedisServerCommands.getClientList()

bitfield

List<Long> bitfield(@NonNull String key,
 @NonNull BitFieldSubCommands command)

Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.

Parameters:

key - must not be null.

command - must not be null.

Returns:

entryIds

static RecordId[] entryIds(String... entryIds)

xAck

default Long xAck(@NonNull String key,
 @NonNull String group,
 @NonNull String @NonNull ... entryIds)

Acknowledge one or more record as processed.

Parameters:

key - the stream key.

group - name of the consumer group.

entryIds - record Id's to acknowledge.

Returns:

length of acknowledged records. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XACK

xAck

Long xAck(@NonNull String key,
 @NonNull String group,
 @NonNull RecordId @NonNull ... recordIds)

xAdd

default RecordId xAdd(@NonNull String key,
 @NonNull Map<@NonNull String, String> body)

Append a record to the stream key.

Parameters:

key - the stream key.

body - record body.

Returns:

the record Id. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XADD

xAdd

default RecordId xAdd(@NonNull StringRecord record)

Append the given StringRecord to the stream stored at Record.getStream().

Parameters:

record - must not be null.

Returns:

the record Id. null when used in pipeline / transaction.

Since:

2.2

xAdd

RecordId xAdd(@NonNull StringRecord record,
 @NonNull RedisStreamCommands.XAddOptions options)

Append the given StringRecord to the stream stored at Record.getStream().

Parameters:

record - must not be null.

options - must not be null, use RedisStreamCommands.XAddOptions.none() instead.

Returns:

the record Id. null when used in pipeline / transaction.

Since:

2.3

xClaimJustId

List<RecordId> xClaimJustId(@NonNull String key,
 @NonNull String group,
 @NonNull String newOwner,
 @NonNull RedisStreamCommands.XClaimOptions options)

Change the ownership of a pending message to the given new consumer without increasing the delivered count.

Parameters:

key - the key the stream is stored at.

group - the name of the consumer group.

newOwner - the name of the new consumer.

options - must not be null.

Returns:

list of ids that changed user.

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xClaim

default List<StringRecord> xClaim(@NonNull String key,
 @NonNull String group,
 @NonNull String newOwner,
 @NonNull Duration minIdleTime,
 @NonNull RecordId @NonNull ... recordIds)

Change the ownership of a pending message to the given new consumer.

Parameters:

key - the key the stream is stored at.

group - the name of the consumer group.

newOwner - the name of the new consumer.

minIdleTime - must not be null.

recordIds - must not be null.

Returns:

list of StringRecord that changed user.

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xClaim

List<StringRecord> xClaim(@NonNull String key,
 @NonNull String group,
 @NonNull String newOwner,
 @NonNull RedisStreamCommands.XClaimOptions options)

Change the ownership of a pending message to the given new consumer.

Parameters:

key - the key the stream is stored at.

group - the name of the consumer group.

newOwner - the name of the new consumer.

options - must not be null.

Returns:

list of StringRecord that changed user.

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xDel

default Long xDel(@NonNull String key,
 @NonNull String @NonNull ... entryIds)

Removes the specified entries from the stream. Returns the number of items deleted, that may be different from the number of IDs passed in case certain IDs do not exist.

Parameters:

key - the stream key.

entryIds - stream record Id's.

Returns:

number of removed entries. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XDEL

xDel

Long xDel(@NonNull String key,
 @NonNull RecordId @NonNull ... recordIds)

xGroupCreate

String xGroupCreate(@NonNull String key,
 @NonNull ReadOffset readOffset,
 @NonNull String group)

Create a consumer group.

Parameters:

key - the stream key.

readOffset -

group - name of the consumer group.

Returns:

true if successful. null when used in pipeline / transaction.

Since:

2.2

xGroupCreate

String xGroupCreate(@NonNull String key,
 @NonNull ReadOffset readOffset,
 @NonNull String group,
 boolean mkStream)

Create a consumer group.

Parameters:

key - the stream key.

readOffset -

group - name of the consumer group.

mkStream - if true the group will create the stream if needed (MKSTREAM)

Returns:

true if successful. null when used in pipeline / transaction.

Since:

, 2.3

xGroupDelConsumer

Boolean xGroupDelConsumer(@NonNull String key,
 @NonNull Consumer consumer)

Delete a consumer from a consumer group.

Parameters:

key - the stream key.

consumer - consumer identified by group name and consumer key.

Returns:

true if successful. null when used in pipeline / transaction.

Since:

2.2

xGroupDestroy

Boolean xGroupDestroy(@NonNull String key,
 String group)

Destroy a consumer group.

Parameters:

key - the stream key.

group - name of the consumer group.

Returns:

true if successful. null when used in pipeline / transaction.

Since:

2.2

xInfo

StreamInfo.XInfoStream xInfo(@NonNull String key)

Obtain general information about the stream stored at the specified key.

Parameters:

key - the key the stream is stored at.

Returns:

null when used in pipeline / transaction.

Since:

2.3

xInfoGroups

StreamInfo.XInfoGroups xInfoGroups(@NonNull String key)

Obtain information about consumer groups associated with the stream stored at the specified key.

Parameters:

key - the key the stream is stored at.

Returns:

null when used in pipeline / transaction.

Since:

2.3

xInfoConsumers

StreamInfo.XInfoConsumers xInfoConsumers(@NonNull String key,
 @NonNull String groupName)

Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.

Parameters:

key - the key the stream is stored at.

groupName - name of the consumer group.

Returns:

null when used in pipeline / transaction.

Since:

2.3

xLen

Long xLen(@NonNull String key)

Get the length of a stream.

Parameters:

key - the stream key.

Returns:

length of the stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XLEN

xPending

PendingMessagesSummary xPending(@NonNull String key,
 @NonNull String groupName)

Obtain the PendingMessagesSummary for a given consumer group.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

Returns:

a summary of pending messages within the given consumer group or null when used in pipeline / transaction.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

PendingMessages xPending(@NonNull String key,
 @NonNull String groupName,
 @NonNull String consumerName,
 @NonNull Range<String> range,
 @NonNull Long count)

Obtain detailed information about pending messages for a given Range within a consumer group.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

consumerName - the name of the consumer. Must not be null.

range - the range of messages ids to search within. Must not be null.

count - limit the number of results. Must not be null.

Returns:

pending messages for the given consumer group or null when used in pipeline / transaction.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

PendingMessages xPending(@NonNull String key,
 @NonNull String groupName,
 @NonNull Range<String> range,
 @NonNull Long count)

Obtain detailed information about pending messages for a given Range within a consumer group.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

range - the range of messages ids to search within. Must not be null.

count - limit the number of results. Must not be null.

Returns:

pending messages for the given consumer group or null when used in pipeline / transaction.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

PendingMessages xPending(@NonNull String key,
 @NonNull String groupName,
 @NonNull RedisStreamCommands.XPendingOptions options)

Obtain detailed information about pending messages applying given options.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

options - the options containing range, consumer and count. Must not be null.

Returns:

pending messages matching given criteria or null when used in pipeline / transaction.

Since:

2.3

See Also:

• Redis Documentation: xpending

xRange

default List<StringRecord> xRange(@NonNull String key,
 @NonNull Range<String> range)

Read records from a stream within a specific RedisZSetCommands.Range.

Parameters:

key - the stream key.

range - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XRANGE

xRange

List<StringRecord> xRange(@NonNull String key,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Read records from a stream within a specific RedisZSetCommands.Range applying a Limit.

Parameters:

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XRANGE

xReadAsString

default List<StringRecord> xReadAsString(@NonNull StreamOffset<String> stream)

Read records from one or more StreamOffsets.

Parameters:

stream - the streams to read from.

Returns:

list ith members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREAD

xReadAsString

default List<StringRecord> xReadAsString(@NonNull StreamOffset<String>... streams)

Read records from one or more StreamOffsets.

Parameters:

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREAD

xReadAsString

default List<StringRecord> xReadAsString(@NonNull StreamReadOptions readOptions,
 @NonNull StreamOffset<String> stream)

Read records from one or more StreamOffsets.

Parameters:

readOptions - read arguments.

stream - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREAD

xReadAsString

List<StringRecord> xReadAsString(@NonNull StreamReadOptions readOptions,
 @NonNull StreamOffset<String>... streams)

Read records from one or more StreamOffsets.

Parameters:

readOptions - read arguments.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREAD

xReadGroupAsString

default List<StringRecord> xReadGroupAsString(@NonNull Consumer consumer,
 @NonNull StreamOffset<String> stream)

Read records from one or more StreamOffsets using a consumer group.

Parameters:

consumer - consumer/group.

stream - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREADGROUP

xReadGroupAsString

default List<StringRecord> xReadGroupAsString(@NonNull Consumer consumer,
 @NonNull StreamOffset<String> @NonNull ... streams)

Read records from one or more StreamOffsets using a consumer group.

Parameters:

consumer - consumer/group.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREADGROUP

xReadGroupAsString

default List<StringRecord> xReadGroupAsString(@NonNull Consumer consumer,
 @NonNull StreamReadOptions readOptions,
 @NonNull StreamOffset<String> stream)

Read records from one or more StreamOffsets using a consumer group.

Parameters:

consumer - consumer/group.

readOptions - read arguments.

stream - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREADGROUP

xReadGroupAsString

List<StringRecord> xReadGroupAsString(@NonNull Consumer consumer,
 @NonNull StreamReadOptions readOptions,
 @NonNull StreamOffset<String> @NonNull ... streams)

Read records from one or more StreamOffsets using a consumer group.

Parameters:

consumer - consumer/group.

readOptions - read arguments.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREADGROUP

xRevRange

default List<StringRecord> xRevRange(@NonNull String key,
 @NonNull Range<String> range)

Read records from a stream within a specific RedisZSetCommands.Range in reverse order.

Parameters:

key - the stream key.

range - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREVRANGE

xRevRange

List<StringRecord> xRevRange(@NonNull String key,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Read records from a stream within a specific RedisZSetCommands.Range applying a Limit in reverse order.

Parameters:

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XREVRANGE

xTrim

Long xTrim(@NonNull String key,
 long count)

Trims the stream to count elements.

Parameters:

key - the stream key.

count - length of the stream.

Returns:

number of removed entries. null when used in pipeline / transaction.

Since:

2.2

See Also:

• Redis Documentation: XTRIM

xTrim

Long xTrim(@NonNull String key,
 long count,
 boolean approximateTrimming)

Trims the stream to count elements.

Parameters:

key - the stream key.

count - length of the stream.

approximateTrimming - the trimming must be performed in a approximated way in order to maximize performances.

Returns:

number of removed entries. null when used in pipeline / transaction.

Since:

2.4

See Also:

• Redis Documentation: XTRIM