org.openingo.spring.boot.extension.data.redis.commands

Interface IValueCommands<K,V>

All Known Subinterfaces:

IRedisCommands<K,V>

All Known Implementing Classes:

DistributedLockStore, IdempotentStore, RedisIdEngine, RedisStringKeyTemplateX, RedisTemplateX

public interface IValueCommands<K,V>

IValueCommands

Author:

Qicz

Method Summary

Modifier and Type	Method and Description
Integer	append(K key, String value) Append a value to key.
List<Long>	bitField(K key, org.springframework.data.redis.connection.BitFieldSubCommands subCommands) Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.
Long	countExistingKeys(Collection<K> keys) Count the number of keys that exist.
Long	decr(K key) Decrement an integer value stored as string value under key by one.
Long	decrBy(K key, long delta) Decrement an integer value stored as string value under key by delta.
Long	del(Collection<K> keys) Delete given keys.
Boolean	del(K key) Delete given key.
Boolean	exists(K key) Determine if given key exists.
Boolean	expire(K key, long timeoutSeconds) Set time(Seconds) to live for given key..
Boolean	expireAt(K key, Date date) Set the expiration for given key as a date timestamp.
V	get(K key) Get the value of key.
Boolean	getBit(K key, long offset) Get the bit value at offset of value at key.
String	getRange(K key, long start, long end) Get a substring of value of key between begin and end.
V	getSet(K key, V value) Set value of key and return its old value.
Long	incr(K key) Increment an integer value stored as string value under key by one.
Long	incrBy(K key, long delta) Increment an integer value stored as string value under key by delta.
List<V>	mGet(Collection<K> keys) Get multiple keys.
void	mSet(Map<K,V> map) Set multiple keys to multiple values using key-value pairs provided in tuple.
void	mSet(Object... keysValues) Set multiple keys to multiple values using key-value pairs.
Boolean	persist(K key) Remove the expiration from given key.
Boolean	pExpire(K key, long millTimeoutSeconds) Set time(Seconds) to live for given key..
void	rename(K oldKey, K newKey) Rename key oldKey to newKey.
void	set(K key, V value) Set value for key.
Boolean	setBit(K key, long offset, boolean value) Sets the bit at offset in value stored at key.
void	setEx(K key, long timeoutSeconds, V value) Set the value and expiration timeout for key.
void	setEx(K key, long timeout, V value, TimeUnit unit) Set the value and expiration timeout for key.
Boolean	setNx(K key, V value) Set key to hold the string value if key is absent.
Boolean	setNx(K key, V value, long timeoutSeconds) Set key to hold the string value and expiration timeout if key is absent.
Boolean	setNx(K key, V value, long timeout, TimeUnit unit) Set key to hold the string value and expiration timeout if key is absent.
void	setRange(K key, V value, long offset) Overwrite parts of key starting at the specified offset with given value.
Boolean	setXx(K key, V value) Set key to hold the string value if key is present.
Boolean	setXx(K key, V value, long timeoutSeconds) Set key to hold the string value and expiration timeout if key is present.
Boolean	setXx(K key, V value, long timeout, TimeUnit unit) Set key to hold the string value and expiration timeout if key is present.
Long	strLen(K key) Get the length of the value stored at key.
Long	ttl(K key) Get the time to live for key in seconds.
org.springframework.data.redis.connection.DataType	type(K key) Determine the type stored at key.

Method Detail

set

void set(K key,
         V value)

Set value for key.

Parameters:

key - must not be null.

value - must not be null.

See Also:

Redis Documentation: SET

setEx

void setEx(K key,
           long timeoutSeconds,
           V value)

Set the value and expiration timeout for key.

Parameters:

key - must not be null.

value - must not be null.

timeoutSeconds - the key expiration timeout.

See Also:

Redis Documentation: SETEX

setEx

void setEx(K key,
           long timeout,
           V value,
           TimeUnit unit)

Set the value and expiration timeout for key.

Parameters:

key - must not be null.

value - must not be null.

timeout - the key expiration timeout.

unit - must not be null.

See Also:

Redis Documentation: SETEX

setNx

@Nullable
Boolean setNx(K key,
                        V value)

Set key to hold the string value if key is absent.

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SETNX

setNx

@Nullable
Boolean setNx(K key,
                        V value,
                        long timeoutSeconds)

Set key to hold the string value and expiration timeout if key is absent.

Parameters:

key - must not be null.

value - must not be null.

timeoutSeconds - the key expiration timeout.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: SET

setNx

@Nullable
Boolean setNx(K key,
                        V value,
                        long timeout,
                        TimeUnit unit)

Set key to hold the string value and expiration timeout if key is absent.

Parameters:

key - must not be null.

value - must not be null.

timeout - the key expiration timeout.

unit - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SET

setXx

@Nullable
Boolean setXx(K key,
                        V value)

Set key to hold the string value if key is present.

Parameters:

key - must not be null.

value - must not be null.

Returns:

command result indicating if the key has been set.

Throws:

IllegalArgumentException - if either key or value is not present.

See Also:

Redis Documentation: SET

setXx

@Nullable
Boolean setXx(K key,
                        V value,
                        long timeoutSeconds)

Set key to hold the string value and expiration timeout if key is present.

Parameters:

key - must not be null.

value - must not be null.

timeoutSeconds - the key expiration timeout.

Returns:

command result indicating if the key has been set.

Throws:

IllegalArgumentException - if either key, value or timeout is not present.

See Also:

Redis Documentation: SET

setXx

@Nullable
Boolean setXx(K key,
                        V value,
                        long timeout,
                        TimeUnit unit)

Set key to hold the string value and expiration timeout if key is present.

Parameters:

key - must not be null.

value - must not be null.

timeout - the key expiration timeout.

unit - must not be null.

Returns:

command result indicating if the key has been set.

Throws:

IllegalArgumentException - if either key, value or timeout is not present.

See Also:

Redis Documentation: SET

get

@Nullable
V get(K key)

Get the value of key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GET

del

@Nullable
Boolean del(K key)

Delete given key.

Parameters:

key - must not be null.

Returns:

true if the key was removed.

See Also:

Redis Documentation: DEL

del

@Nullable
Long del(Collection<K> keys)

Delete given keys.

Parameters:

keys - must not be null.

Returns:

The number of keys that were removed. null when used in pipeline / transaction.

See Also:

Redis Documentation: DEL

mSet

void mSet(Object... keysValues)

Set multiple keys to multiple values using key-value pairs. "key1", "value1", "key2", "values"

Parameters:

keysValues - must not be null.

See Also:

Redis Documentation: MSET

mSet

void mSet(Map<K,V> map)

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

Parameters:

map - must not be null.

See Also:

Redis Documentation: MSET

mGet

@Nullable
List<V> mGet(Collection<K> keys)

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

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: MGET

decr

@Nullable
Long decr(K key)

Decrement an integer value stored as string value under key by one.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: DECR

decrBy

@Nullable
Long decrBy(K key,
                      long delta)

Decrement an integer value stored as string value under key by delta.

Parameters:

key - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: DECRBY

incr

@Nullable
Long incr(K key)

Increment an integer value stored as string value under key by one.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: INCR

incrBy

@Nullable
Long incrBy(K key,
                      long delta)

Increment an integer value stored as string value under key by delta.

Parameters:

key - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: INCRBY

exists

@Nullable
Boolean exists(K key)

Determine if given key exists.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: EXISTS

rename

void rename(K oldKey,
            K newKey)

Rename key oldKey to newKey.

Parameters:

oldKey - must not be null.

newKey - must not be null.

See Also:

Redis Documentation: RENAME

expire

@Nullable
Boolean expire(K key,
                         long timeoutSeconds)

Set time(Seconds) to live for given key..

Parameters:

key - must not be null.

timeoutSeconds -

Returns:

null when used in pipeline / transaction.

expireAt

@Nullable
Boolean expireAt(K key,
                           Date date)

Set the expiration for given key as a date timestamp.

Parameters:

key - must not be null.

date - must not be null.

Returns:

null when used in pipeline / transaction.

pExpire

@Nullable
Boolean pExpire(K key,
                          long millTimeoutSeconds)

Set time(Seconds) to live for given key..

Parameters:

key - must not be null.

millTimeoutSeconds -

Returns:

null when used in pipeline / transaction.

getSet

@Nullable
V getSet(K key,
                   V value)

Set value of key and return its old value.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GETSET

persist

@Nullable
Boolean persist(K key)

Remove the expiration from given key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: PERSIST

type

@Nullable
org.springframework.data.redis.connection.DataType type(K key)

Determine the type stored at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: TYPE

ttl

@Nullable
Long ttl(K key)

Get the time to live for key in seconds.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: TTL

countExistingKeys

@Nullable
Long countExistingKeys(Collection<K> keys)

Count the number of keys that exist.

Parameters:

keys - must not be null.

Returns:

The number of keys existing among the ones specified as arguments. Keys mentioned multiple times and existing are counted multiple times.

See Also:

Redis Documentation: EXISTS

append

@Nullable
Integer append(K key,
                         String value)

Append a value to key.

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: APPEND

getRange

@Nullable
String getRange(K key,
                          long start,
                          long end)

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

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GETRANGE

setRange

void setRange(K key,
              V 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

strLen

@Nullable
Long strLen(K key)

Get the length of the value stored at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: STRLEN

setBit

@Nullable
Boolean setBit(K key,
                         long offset,
                         boolean value)

Sets the bit at offset in value stored at key.

Parameters:

key - must not be null.

offset -

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SETBIT

getBit

@Nullable
Boolean getBit(K key,
                         long offset)

Get the bit value at offset of value at key.

Parameters:

key - must not be null.

offset -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GETBIT

bitField

@Nullable
List<Long> bitField(K key,
                              org.springframework.data.redis.connection.BitFieldSubCommands subCommands)

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.

subCommands - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: BITFIELD