Interface StringCommands<K,V>
-
- Type Parameters:
K
- the type of the keyV
- the type of the value
- All Known Implementing Classes:
BlockingStringCommandsImpl
public interface StringCommands<K,V>
Allows executing commands from thestring
group. See the string command list for further information about these commands.This group can be used with value of type
String
, or a type which will be automatically serialized/deserialized with a codec.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description long
append(K key, V value)
Execute the command APPEND.long
decr(K key)
Execute the command DECR.long
decrby(K key, long amount)
Execute the command DECRBY.V
get(K key)
Execute the command GET.V
getdel(K key)
Execute the command GETDEL.V
getex(K key, GetExArgs args)
Execute the command GETEX.String
getrange(K key, long start, long end)
Execute the command GETRANGE.V
getset(K key, V value)
Deprecated.See https://redis.io/commands/getsetlong
incr(K key)
Execute the command INCR.long
incrby(K key, long amount)
Execute the command INCRBY.double
incrbyfloat(K key, double amount)
Execute the command INCRBYFLOAT.String
lcs(K key1, K key2)
Execute the command LCS.long
lcsLength(K key1, K key2)
Execute the command LCS.Map<K,V>
mget(K... keys)
Execute the command MGET.void
mset(Map<K,V> map)
Execute the command MSET.boolean
msetnx(Map<K,V> map)
Execute the command MSETNX.void
psetex(K key, long milliseconds, V value)
Execute the command PSETEX.void
set(K key, V value)
Execute the command SET.void
set(K key, V value, SetArgs setArgs)
Execute the command SET.void
setex(K key, long seconds, V value)
Execute the command SETEX.V
setGet(K key, V value)
Execute the command SET.V
setGet(K key, V value, SetArgs setArgs)
Execute the command SET.boolean
setnx(K key, V value)
Execute the command SETNX.long
setrange(K key, long offset, V value)
Execute the command SETRANGE.long
strlen(K key)
Execute the command STRLEN.
-
-
-
Method Detail
-
append
long append(K key, V value)
Execute the command APPEND. Summary: Append a value to a key Group: string Requires Redis 2.0.0- Parameters:
key
- the keyvalue
- the value- Returns:
- the length of the string after the append operation.
-
decr
long decr(K key)
Execute the command DECR. Summary: Decrement the integer value of a key by one Group: string Requires Redis 1.0.0- Parameters:
key
- the key- Returns:
- the value of key after the decrement
-
decrby
long decrby(K key, long amount)
Execute the command DECRBY. Summary: Decrement the integer value of a key by the given number Group: string Requires Redis 1.0.0- Parameters:
key
- the keyamount
- the amount, can be negative- Returns:
- the value of key after the decrement
-
get
V get(K key)
Execute the command GET. Summary: Get the value of a key Group: string Requires Redis 1.0.0- Parameters:
key
- the key- Returns:
- the value of key, or
null
when key does not exist.
-
getdel
V getdel(K key)
Execute the command GETDEL. Summary: Get the value of a key and delete the key Group: string Requires Redis 6.2.0- Parameters:
key
- the key- Returns:
- the value of key,
null
when key does not exist, or an error if the key's value type isn't a string.
-
getex
V getex(K key, GetExArgs args)
Execute the command GETEX. Summary: Get the value of a key and optionally set its expiration Group: string Requires Redis 6.2.0- Parameters:
key
- the keyargs
- the getex command extra-arguments- Returns:
- the value of key, or
null
when key does not exist.
-
getrange
String getrange(K key, long start, long end)
Execute the command GETRANGE. Summary: Get a substring of the string stored at a key Group: string Requires Redis 2.4.0- Parameters:
key
- the keystart
- the start offsetend
- the end offset- Returns:
- the sub-string
-
getset
V getset(K key, V value)
Deprecated.See https://redis.io/commands/getsetExecute the command GETSET. Summary: Set the string value of a key and return its old value Group: string Requires Redis 1.0.0- Parameters:
key
- the keyvalue
- the value- Returns:
- the old value stored at key, or
null
when key did not exist.
-
incr
long incr(K key)
Execute the command INCR. Summary: Increment the integer value of a key by one Group: string Requires Redis 1.0.0- Parameters:
key
- the key- Returns:
- the value of key after the increment
-
incrby
long incrby(K key, long amount)
Execute the command INCRBY. Summary: Increment the integer value of a key by the given amount Group: string Requires Redis 1.0.0- Parameters:
key
- the keyamount
- the amount, can be negative- Returns:
- the value of key after the increment
-
incrbyfloat
double incrbyfloat(K key, double amount)
Execute the command INCRBYFLOAT. Summary: Increment the float value of a key by the given amount Group: string Requires Redis 2.6.0- Parameters:
key
- the keyamount
- the amount, can be negative- Returns:
- the value of key after the increment.
-
lcs
String lcs(K key1, K key2)
Execute the command LCS. Summary: Find longest common substring Group: string Requires Redis 7.0.0- Parameters:
key1
- the keykey2
- the key- Returns:
- the string representing the longest common substring is returned.
-
lcsLength
long lcsLength(K key1, K key2)
Execute the command LCS. Summary: Find longest common substring and return the length (usingLEN
) Group: string Requires Redis 7.0.0- Parameters:
key1
- the keykey2
- the key- Returns:
- the length of the longest common substring.
-
mget
Map<K,V> mget(K... keys)
Execute the command MGET. Summary: Get the values of all the given keys Group: string Requires Redis 1.0.0- Parameters:
keys
- the keys- Returns:
- list of values at the specified keys.
-
mset
void mset(Map<K,V> map)
Execute the command MSET. Summary: Set multiple keys to multiple values Group: string Requires Redis 1.0.1- Parameters:
map
- the key/value map containing the items to store
-
msetnx
boolean msetnx(Map<K,V> map)
Execute the command MSETNX. Summary: Set multiple keys to multiple values, only if none of the keys exist Group: string Requires Redis 1.0.1- Parameters:
map
- the key/value map containing the items to store- Returns:
true
the all the keys were set.false
no key was set (at least one key already existed).
-
psetex
void psetex(K key, long milliseconds, V value)
Execute the command PSETEX. Summary: Set the value and expiration in milliseconds of a key Group: string Requires Redis 2.6.0- Parameters:
key
- the keymilliseconds
- the duration in msvalue
- the value
-
set
void set(K key, V value)
Execute the command SET. Summary: Set the string value of a key Group: string Requires Redis 1.0.0- Parameters:
key
- the keyvalue
- the value
-
set
void set(K key, V value, SetArgs setArgs)
Execute the command SET. Summary: Set the string value of a key Group: string Requires Redis 1.0.0- Parameters:
key
- the keyvalue
- the valuesetArgs
- the set command extra-arguments
-
setGet
V setGet(K key, V value)
Execute the command SET. Summary: Set the string value of a key, and return the previous value Group: string Requires Redis 1.0.0- Parameters:
key
- the keyvalue
- the value- Returns:
- the old value,
null
if not present
-
setGet
V setGet(K key, V value, SetArgs setArgs)
Execute the command SET. Summary: Set the string value of a key, and return the previous value Group: string Requires Redis 1.0.0- Parameters:
key
- the keyvalue
- the valuesetArgs
- the set command extra-arguments- Returns:
- the old value,
null
if not present
-
setex
void setex(K key, long seconds, V value)
Execute the command SETEX. Summary: Set the value and expiration of a key Group: string Requires Redis 2.0.0- Parameters:
key
- the keyvalue
- the value
-
setnx
boolean setnx(K key, V value)
Execute the command SETNX. Summary: Set the value of a key, only if the key does not exist Group: string Requires Redis 1.0.0- Parameters:
key
- the keyvalue
- the value- Returns:
true
the key was setfalse
the key was not set
-
setrange
long setrange(K key, long offset, V value)
Execute the command SETRANGE. Summary: Overwrite part of a string at key starting at the specified offset Group: string Requires Redis 2.2.0- Parameters:
key
- the keyvalue
- the value- Returns:
- the length of the string after it was modified by the command.
-
-