org.springframework.data.redis.connection

Interface RedisStringCommands

All Known Subinterfaces:

RedisClusterConnection, RedisCommands, RedisConnection, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

public interface RedisStringCommands

String/Value-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RedisStringCommands.BitOperation
static class	RedisStringCommands.SetOption SET command arguments for NX, XX.

Method Summary

Modifier and Type	Method and Description
Long	append(byte[] key, byte[] value) Append a value to key.
Long	bitCount(byte[] key) Count the number of set bits (population counting) in value stored at key.
Long	bitCount(byte[] key, long begin, long end) Count the number of set bits (population counting) of value stored at key between begin and end.
Long	bitOp(RedisStringCommands.BitOperation op, byte[] destination, byte[]... keys) Perform bitwise operations between strings.
Long	decr(byte[] key) Decrement value of key by 1.
Long	decrBy(byte[] key, long value) Increment value of key by value.
byte[]	get(byte[] key) Get the value of key.
Boolean	getBit(byte[] key, long offset) Get the bit value at offset of value at key.
byte[]	getRange(byte[] key, long begin, long end) Get a substring of value of key between begin and end.
byte[]	getSet(byte[] key, byte[] value) Set value of key and return its old value.
Long	incr(byte[] key) Increment value of key by 1.
Double	incrBy(byte[] key, double value) Increment value of key by value.
Long	incrBy(byte[] key, long value) Increment value of key by value.
List<byte[]>	mGet(byte[]... keys) Get the values of all given keys.
void	mSet(Map<byte[],byte[]> tuple) Set multiple keys to multiple values using key-value pairs provided in tuple.
Boolean	mSetNX(Map<byte[],byte[]> tuple) Set multiple keys to multiple values using key-value pairs provided in tuple only if the provided key does not exist.
void	pSetEx(byte[] key, long milliseconds, byte[] value) Set the value and expiration in milliseconds for key.
void	set(byte[] key, byte[] value) Set value for key.
void	set(byte[] key, byte[] value, Expiration expiration, RedisStringCommands.SetOption option) Set value for key applying timeouts from expiration if set and inserting/updating values depending on option.
Boolean	setBit(byte[] key, long offset, boolean value) Sets the bit at offset in value stored at key.
void	setEx(byte[] key, long seconds, byte[] value) Set the value and expiration in seconds for key.
Boolean	setNX(byte[] key, byte[] value) Set value for key, only if key does not exist.
void	setRange(byte[] key, byte[] value, long offset) Overwrite parts of key starting at the specified offset with given value.
Long	strLen(byte[] key) Get the length of the value stored at key.

Method Detail

get

byte[] get(byte[] key)

Get the value of key.

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

Parameters:

key - must not be null.

Returns:

getSet

byte[] getSet(byte[] key,
              byte[] value)

Set value of key and return its old value.

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

Parameters:

key - must not be null.

value -

Returns:

mGet

List<byte[]> mGet(byte[]... keys)

Get the values of all given keys.

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

Parameters:

keys -

Returns:

set

void set(byte[] key,
         byte[] value)

Set value for key.

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

Parameters:

key - must not be null.

value - must not be null.

set

void set(byte[] key,
         byte[] value,
         Expiration expiration,
         RedisStringCommands.SetOption option)

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

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

Parameters:

key - must not be null.

value - must not be null.

expiration - can be null. Defaulted to Expiration.persistent().

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

Since:

1.7

setNX

Boolean setNX(byte[] key,
              byte[] value)

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

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

Parameters:

key - must not be null.

value - must not be null.

Returns:

setEx

void setEx(byte[] key,
           long seconds,
           byte[] value)

Set the value and expiration in seconds for key.

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

Parameters:

key - must not be null.

seconds -

value - must not be null.

pSetEx

void pSetEx(byte[] key,
            long milliseconds,
            byte[] value)

Set the value and expiration in milliseconds for key.

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

Parameters:

key - must not be null.

milliseconds -

value - must not be null.

Since:

1.3

mSet

void mSet(Map<byte[],byte[]> tuple)

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

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

Parameters:

tuple -

mSetNX

Boolean mSetNX(Map<byte[],byte[]> tuple)

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

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

Parameters:

tuple -

incr

Long incr(byte[] key)

Increment value of key by 1.

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

Parameters:

key - must not be null.

Returns:

incrBy

Long incrBy(byte[] key,
            long value)

Increment value of key by value.

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

Parameters:

key - must not be null.

value -

Returns:

incrBy

Double incrBy(byte[] key,
              double value)

Increment value of key by value.

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

Parameters:

key - must not be null.

value -

Returns:

decr

Long decr(byte[] key)

Decrement value of key by 1.

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

Parameters:

key - must not be null.

Returns:

decrBy

Long decrBy(byte[] key,
            long value)

Increment value of key by value.

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

Parameters:

key - must not be null.

value -

Returns:

append

Long append(byte[] key,
            byte[] value)

Append a value to key.

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

Parameters:

key - must not be null.

value -

Returns:

getRange

byte[] getRange(byte[] key,
                long begin,
                long end)

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

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

Parameters:

key - must not be null.

begin -

end -

Returns:

setRange

void setRange(byte[] key,
              byte[] value,
              long offset)

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

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

Parameters:

key - must not be null.

value -

offset -

getBit

Boolean getBit(byte[] key,
               long offset)

Get the bit value at offset of value at key.

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

Parameters:

key - must not be null.

offset -

Returns:

setBit

Boolean setBit(byte[] key,
               long offset,
               boolean value)

Sets the bit at offset in value stored at key.

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

Parameters:

key - must not be null.

offset -

value -

Returns:

the original bit value stored at offset.

bitCount

Long bitCount(byte[] key)

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

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

Parameters:

key - must not be null.

Returns:

bitCount

Long bitCount(byte[] key,
              long begin,
              long end)

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

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

Parameters:

key - must not be null.

begin -

end -

Returns:

bitOp

Long bitOp(RedisStringCommands.BitOperation op,
           byte[] destination,
           byte[]... keys)

Perform bitwise operations between strings.

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

Parameters:

op -

destination -

keys -

Returns:

strLen

Long strLen(byte[] key)

Get the length of the value stored at key.

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

Parameters:

key - must not be null.

Returns: