org.springframework.data.redis.connection

Interface RedisKeyCommands

All Known Subinterfaces:

RedisCommands, RedisConnection, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisConnection, JredisConnection, LettuceConnection, SrpConnection

public interface RedisKeyCommands

Key-specific commands supported by Redis.

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 time to live for key in milliseconds.
byte[]	randomKey() Return a random key from the keyspace.
void	rename(byte[] oldName, byte[] newName) Rename key oleName to newName.
Boolean	renameNX(byte[] oldName, byte[] newName) Rename key oleName 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.
DataType	type(byte[] key) Determine the type stored at key.

Method Detail

exists

Boolean exists(byte[] key)

Determine if given key exists.

See http://redis.io/commands/exists

Parameters:

key -

Returns:

del

Long del(byte[]... keys)

Delete given keys.

See http://redis.io/commands/del

Parameters:

keys -

Returns:

The number of keys that were removed.

type

DataType type(byte[] key)

Determine the type stored at key.

See http://redis.io/commands/type

Parameters:

key -

Returns:

keys

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

Find all keys matching the given pattern.

See http://redis.io/commands/keys

Parameters:

pattern -

Returns:

scan

Cursor<byte[]> scan(ScanOptions options)

Use a Cursor to iterate over keys.

See http://redis.io/commands/scan

Parameters:

options -

Returns:

Since:

1.4

randomKey

byte[] randomKey()

Return a random key from the keyspace.

See http://redis.io/commands/randomkey

Returns:

rename

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

Rename key oleName to newName.

See http://redis.io/commands/rename

Parameters:

oldName -

newName -

renameNX

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

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

See http://redis.io/commands/renamenx

Parameters:

oldName -

newName -

Returns:

expire

Boolean expire(byte[] key,
               long seconds)

Set time to live for given key in seconds.

See http://redis.io/commands/expire

Parameters:

key -

seconds -

Returns:

pExpire

Boolean pExpire(byte[] key,
                long millis)

Set time to live for given key in milliseconds.

See http://redis.io/commands/pexpire

Parameters:

key -

millis -

Returns:

expireAt

Boolean expireAt(byte[] key,
                 long unixTime)

Set the expiration for given key as a UNIX timestamp.

See http://redis.io/commands/expireat

Parameters:

key -

unixTime -

Returns:

pExpireAt

Boolean pExpireAt(byte[] key,
                  long unixTimeInMillis)

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

See http://redis.io/commands/pexpireat

Parameters:

key -

unixTimeInMillis -

Returns:

persist

Boolean persist(byte[] key)

Remove the expiration from given key.

See http://redis.io/commands/persist

Parameters:

key -

Returns:

move

Boolean move(byte[] key,
             int dbIndex)

Move given key to database with index.

See http://redis.io/commands/move

Parameters:

key -

dbIndex -

Returns:

ttl

Long ttl(byte[] key)

Get the time to live for key in seconds.

See http://redis.io/commands/ttl

Parameters:

key -

Returns:

pTtl

Long pTtl(byte[] key)

Get the time to live for key in milliseconds.

See http://redis.io/commands/pttl

Parameters:

key -

Returns:

sort

List<byte[]> sort(byte[] key,
                  SortParameters params)

Sort the elements for key.

See http://redis.io/commands/sort

Parameters:

key -

params -

Returns:

sort

Long sort(byte[] key,
          SortParameters params,
          byte[] storeKey)

Sort the elements for key and store result in storeKey.

See http://redis.io/commands/sort

Parameters:

key -

params -

storeKey -

Returns:

dump

byte[] dump(byte[] key)

Retrieve serialized version of the value stored at key.

See http://redis.io/commands/dump

Parameters:

key -

Returns:

restore

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

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

See http://redis.io/commands/restore

Parameters:

key -

ttlInMillis -

serializedValue -