org.springframework.data.redis.connection

Interface RedisKeyCommands

All Known Subinterfaces:

RedisClusterConnection, RedisCommands, RedisConnection, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, JredisConnection, LettuceClusterConnection, LettuceConnection, SrpConnection

public interface RedisKeyCommands

Key-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method and Description
Long	del(byte[]... keys) Delete given keys.
byte[]	dump(byte[] key) Retrieve serialized version of the value stored at key.
Boolean	exists(byte[] key) Determine if given key exists.
Boolean	expire(byte[] key, long seconds) Set time to live for given key in seconds.
Boolean	expireAt(byte[] key, long unixTime) Set the expiration for given key as a UNIX timestamp.
Set<byte[]>	keys(byte[] pattern) Find all keys matching the given pattern.
Boolean	move(byte[] key, int dbIndex) Move given key to database with index.
Boolean	persist(byte[] key) Remove the expiration from given key.
Boolean	pExpire(byte[] key, long millis) Set time to live for given key in milliseconds.
Boolean	pExpireAt(byte[] key, long unixTimeInMillis) Set the expiration for given key as a UNIX timestamp in milliseconds.
Long	pTtl(byte[] key) Get the precise time to live for key in milliseconds.
Long	pTtl(byte[] key, TimeUnit timeUnit) Get the precise time to live for key in and convert it to the given TimeUnit.
byte[]	randomKey() Return a random key from the keyspace.
void	rename(byte[] oldName, byte[] newName) Rename key oldName to newName.
Boolean	renameNX(byte[] oldName, byte[] newName) Rename key oldName to newName only if newName does not exist.
void	restore(byte[] key, long ttlInMillis, byte[] serializedValue) Create key using the serializedValue, previously obtained using dump(byte[]).
Cursor<byte[]>	scan(ScanOptions options) Use a Cursor to iterate over keys.
List<byte[]>	sort(byte[] key, SortParameters params) Sort the elements for key.
Long	sort(byte[] key, SortParameters params, byte[] storeKey) Sort the elements for key and store result in storeKey.
Long	ttl(byte[] key) Get the time to live for key in seconds.
Long	ttl(byte[] key, TimeUnit timeUnit) Get the time to live for key in and convert it to the given TimeUnit.
DataType	type(byte[] key) Determine the type stored at key.

Method Detail

exists

Boolean exists(byte[] key)

Determine if given key exists.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: EXISTS

del

Long del(byte[]... keys)

Delete given keys.

Parameters:

keys - must not be null.

Returns:

The number of keys that were removed.

See Also:

Redis Documentation: DEL

type

DataType type(byte[] key)

Determine the type stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: TYPE

keys

Set<byte[]> keys(byte[] pattern)

Find all keys matching the given pattern.

Parameters:

pattern - must not be null.

Returns:

See Also:

Redis Documentation: KEYS

scan

Cursor<byte[]> scan(ScanOptions options)

Use a Cursor to iterate over keys.

Parameters:

options - must not be null.

Returns:

Since:

1.4

See Also:

Redis Documentation: SCAN

randomKey

byte[] randomKey()

Return a random key from the keyspace.

Returns:

See Also:

Redis Documentation: RANDOMKEY

rename

void rename(byte[] oldName,
            byte[] newName)

Rename key oldName to newName.

Parameters:

oldName - must not be null.

newName - must not be null.

See Also:

Redis Documentation: RENAME

renameNX

Boolean renameNX(byte[] oldName,
                 byte[] newName)

Rename key oldName to newName only if newName does not exist.

Parameters:

oldName - must not be null.

newName - must not be null.

Returns:

See Also:

Redis Documentation: RENAMENX

expire

Boolean expire(byte[] 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

pExpire

Boolean pExpire(byte[] 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

expireAt

Boolean expireAt(byte[] 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

pExpireAt

Boolean pExpireAt(byte[] 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

persist

Boolean persist(byte[] key)

Remove the expiration from given key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: PERSIST

move

Boolean move(byte[] key,
             int dbIndex)

Move given key to database with index.

Parameters:

key - must not be null.

dbIndex -

Returns:

See Also:

Redis Documentation: MOVE

ttl

Long ttl(byte[] key)

Get the time to live for key in seconds.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: TTL

ttl

Long ttl(byte[] key,
         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

pTtl

Long pTtl(byte[] key)

Get the precise time to live for key in milliseconds.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: PTTL

pTtl

Long pTtl(byte[] key,
          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

sort

List<byte[]> sort(byte[] key,
                  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(byte[] key,
          SortParameters params,
          byte[] 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:

number of values.

See Also:

Redis Documentation: SORT

dump

byte[] dump(byte[] key)

Retrieve serialized version of the value stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: DUMP

restore

void restore(byte[] key,
             long ttlInMillis,
             byte[] serializedValue)

Create key using the serializedValue, previously obtained using dump(byte[]).

Parameters:

key - must not be null.

ttlInMillis -

serializedValue - must not be null.

See Also:

Redis Documentation: RESTORE