redis.clients.jedis.commands

Interface StringBinaryCommands

All Superinterfaces:

BitBinaryCommands

All Known Subinterfaces:

JedisBinaryCommands

All Known Implementing Classes:

Jedis, JedisCluster, MultiDbClient, RedisClient, RedisClusterClient, RedisSentinelClient, UnifiedJedis

public interface StringBinaryCommands
extends BitBinaryCommands

Method Summary

Modifier and Type	Method and Description
long	append(byte[] key, byte[] value)
long	decr(byte[] key)
long	decrBy(byte[] key, long decrement)
byte[]	get(byte[] key)
byte[]	getDel(byte[] key)
byte[]	getEx(byte[] key, GetExParams params)
byte[]	getrange(byte[] key, long startOffset, long endOffset)
byte[]	getSet(byte[] key, byte[] value) Deprecated. Use setGet(byte[], byte[]).
long	incr(byte[] key)
long	incrBy(byte[] key, long increment)
double	incrByFloat(byte[] key, double increment)
java.util.List<java.lang.Long>	increx(byte[] key) Increment the integer number stored at key by 1.
java.util.List<java.lang.Double>	increx(byte[] key, double increment, IncrexFloatParams params) Increment the floating-point number stored at key by increment, with optional bounds, saturation, and expiration control.
java.util.List<java.lang.Long>	increx(byte[] key, long increment, IncrexParams params) Increment the integer number stored at key by increment, with optional bounds, saturation, and expiration control.
LCSMatchResult	lcs(byte[] keyA, byte[] keyB, LCSParams params) Calculate the longest common subsequence of keyA and keyB.
java.util.List<byte[]>	mget(byte[]... keys) Get the values of all the specified keys.
java.lang.String	mset(byte[]... keysvalues)
boolean	msetex(MSetExParams params, byte[]... keysvalues) Multi-set with optional condition and expiration.
long	msetnx(byte[]... keysvalues)
java.lang.String	psetex(byte[] key, long milliseconds, byte[] value) Deprecated. Use set(byte[], byte[], SetParams) with SetParams.px(long). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.6.12.
java.lang.String	set(byte[] key, byte[] value)
java.lang.String	set(byte[] key, byte[] value, SetParams params)
java.lang.String	setex(byte[] key, long seconds, byte[] value) Deprecated. Use set(byte[], byte[], SetParams) with SetParams.ex(long). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.6.12.
byte[]	setGet(byte[] key, byte[] value)
byte[]	setGet(byte[] key, byte[] value, SetParams params)
long	setnx(byte[] key, byte[] value) Deprecated. Use set(byte[], byte[], SetParams) with SetParams.nx(). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.6.12.
long	setrange(byte[] key, long offset, byte[] value)
long	strlen(byte[] key)
byte[]	substr(byte[] key, int start, int end) Deprecated. Use getrange(byte[], long, long). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.0.0.

Methods inherited from interface redis.clients.jedis.commands.BitBinaryCommands

bitcount, bitcount, bitcount, bitfield, bitfieldReadonly, bitop, bitpos, bitpos, getbit, setbit

Method Detail

set

java.lang.String set(byte[] key,
                     byte[] value)

set

java.lang.String set(byte[] key,
                     byte[] value,
                     SetParams params)

get

byte[] get(byte[] key)

setGet

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

setGet

byte[] setGet(byte[] key,
              byte[] value,
              SetParams params)

getDel

byte[] getDel(byte[] key)

getEx

byte[] getEx(byte[] key,
             GetExParams params)

setrange

long setrange(byte[] key,
              long offset,
              byte[] value)

getrange

byte[] getrange(byte[] key,
                long startOffset,
                long endOffset)

getSet

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

Deprecated. Use setGet(byte[], byte[]).

setnx

@Deprecated
long setnx(byte[] key,
                       byte[] value)

Deprecated. Use set(byte[], byte[], SetParams) with SetParams.nx(). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.6.12.

setex

@Deprecated
java.lang.String setex(byte[] key,
                                   long seconds,
                                   byte[] value)

Deprecated. Use set(byte[], byte[], SetParams) with SetParams.ex(long). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.6.12.

psetex

@Deprecated
java.lang.String psetex(byte[] key,
                                    long milliseconds,
                                    byte[] value)

Deprecated. Use set(byte[], byte[], SetParams) with SetParams.px(long). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.6.12.

mget

java.util.List<byte[]> mget(byte[]... keys)

Get the values of all the specified keys.

At least one key must be supplied; otherwise the server returns an error.

Parameters:

keys - the keys to get

Returns:

a list of values in the same order as keys; entries are null for keys that do not exist or do not hold a string value

See Also:

StringCommands.mget(String...)

mset

java.lang.String mset(byte[]... keysvalues)

msetnx

long msetnx(byte[]... keysvalues)

msetex

boolean msetex(MSetExParams params,
               byte[]... keysvalues)

Multi-set with optional condition and expiration.

Sets the respective keys to the respective values, similar to MSET, but allows conditional set (NX|XX) and expiration options via MSetExParams. If the condition is not met for any key, no key is set.

Both MSET and MSETEX are atomic operations. This means that if multiple keys are provided, another client will either see the changes for all keys at once, or no changes at all.

Options (in MSetExParams): NX or XX, and expiration: EX seconds | PX milliseconds | EXAT unix-time-seconds | PXAT unix-time-milliseconds | KEEPTTL.

Time complexity: O(N) where N is the number of keys to set.

Parameters:

params - condition and expiration parameters

keysvalues - pairs of keys and their values, e.g. msetex(params, "foo".getBytes(), "foovalue".getBytes(), "bar".getBytes(), "barvalue".getBytes())

Returns:

true if all the keys were set, false if none were set (condition not satisfied)

See Also:

#mset(byte[]...), #msetnx(byte[]...)

incr

long incr(byte[] key)

incrBy

long incrBy(byte[] key,
            long increment)

incrByFloat

double incrByFloat(byte[] key,
                   double increment)

increx

java.util.List<java.lang.Long> increx(byte[] key)

Increment the integer number stored at key by 1. If the key does not exist, it is set to 0 before performing the operation.

Parameters:

key - the key

Returns:

a 2-element list: [newValue, appliedIncrement]

Since:

8.0

See Also:

StringCommands.increx(String)

increx

java.util.List<java.lang.Long> increx(byte[] key,
                                      long increment,
                                      IncrexParams params)

Increment the integer number stored at key by increment, with optional bounds, saturation, and expiration control.

Parameters:

key - the key

increment - the integer amount to increment by (may be negative)

params - optional bounds, SATURATE flag, and expiration options

Returns:

a 2-element list: [newValue, appliedIncrement]

Since:

8.0

See Also:

StringCommands.increx(String, long, IncrexParams)

increx

java.util.List<java.lang.Double> increx(byte[] key,
                                        double increment,
                                        IncrexFloatParams params)

Increment the floating-point number stored at key by increment, with optional bounds, saturation, and expiration control.

Parameters:

key - the key

increment - the floating-point amount to increment by (may be negative)

params - optional bounds, SATURATE flag, and expiration options

Returns:

a 2-element list: [newValue, appliedIncrement]

Since:

8.0

See Also:

StringCommands.increx(String, double, IncrexFloatParams)

decr

long decr(byte[] key)

decrBy

long decrBy(byte[] key,
            long decrement)

append

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

substr

@Deprecated
byte[] substr(byte[] key,
                          int start,
                          int end)

Deprecated. Use getrange(byte[], long, long). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 2.0.0.

strlen

long strlen(byte[] key)

lcs

LCSMatchResult lcs(byte[] keyA,
                   byte[] keyB,
                   LCSParams params)

Calculate the longest common subsequence of keyA and keyB.

Parameters:

keyA -

keyB -

params -

Returns:

According to LCSParams to decide to return content to fill LCSMatchResult.