redis.clients.jedis

Class Jedis

java.lang.Object

redis.clients.jedis.BinaryJedis

redis.clients.jedis.Jedis

All Implemented Interfaces:

AdvancedBinaryJedisCommands, AdvancedJedisCommands, BasicCommands, BinaryJedisCommands, BinaryScriptingCommands, ClusterCommands, JedisCommands, MultiKeyBinaryCommands, MultiKeyCommands, ScriptingCommands

public class Jedis
extends BinaryJedis
implements JedisCommands, MultiKeyCommands, AdvancedJedisCommands, ScriptingCommands, BasicCommands, ClusterCommands

Field Summary

Fields inherited from class redis.clients.jedis.BinaryJedis

client

Constructor Summary

Constructors

Constructor and Description
Jedis(JedisShardInfo shardInfo)
Jedis(String host)
Jedis(String host, int port)
Jedis(String host, int port, int timeout)
Jedis(URI uri)

Method Summary

Methods

Modifier and Type	Method and Description
Long	append(String key, String value) If the key already exists and is a string, this command appends the provided value at the end of the string.
String	asking()
Long	bitcount(String key)
Long	bitcount(String key, long start, long end)
Long	bitop(BitOP op, String destKey, String... srcKeys)
List<String>	blpop(int timeout, String... keys) BLPOP (and BRPOP) is a blocking list pop primitive.
List<String>	blpop(String... args)
List<String>	blpop(String arg)
List<String>	brpop(int timeout, String... keys) BLPOP (and BRPOP) is a blocking list pop primitive.
List<String>	brpop(String... args)
List<String>	brpop(String arg)
String	brpoplpush(String source, String destination, int timeout) Pop a value from a list, push it to another list and return it; or block until one is available
String	clientKill(String client)
String	clientSetname(String name)
String	clusterAddSlots(int... slots)
String	clusterDelSlots(int... slots)
List<String>	clusterGetKeysInSlot(int slot, int count)
String	clusterInfo()
String	clusterMeet(String ip, int port)
String	clusterNodes()
String	clusterSetSlotImporting(int slot, String nodeId)
String	clusterSetSlotMigrating(int slot, String nodeId)
String	clusterSetSlotNode(int slot, String nodeId)
List<String>	configGet(String pattern) Retrieve the configuration of a running Redis server.
String	configSet(String parameter, String value) Alter the configuration of a running Redis server.
Long	decr(String key) Decrement the number stored at key by one.
Long	decrBy(String key, long integer) IDECRBY work just like INCR but instead to decrement by 1 the decrement is integer.
Long	del(String... keys) Remove the specified keys.
Long	del(String key)
byte[]	dump(String key)
String	echo(String string)
Object	eval(String script)
Object	eval(String script, int keyCount, String... params)
Object	eval(String script, List<String> keys, List<String> args)
Object	evalsha(String script)
Object	evalsha(String sha1, int keyCount, String... params)
Object	evalsha(String sha1, List<String> keys, List<String> args)
Boolean	exists(String key) Test if the specified key exists.
Long	expire(String key, int seconds) Set a timeout on the specified key.
Long	expireAt(String key, long unixTime) EXPIREAT works exctly like EXPIRE but instead to get the number of seconds representing the Time To Live of the key as a second argument (that is a relative way of specifing the TTL), it takes an absolute one in the form of a UNIX timestamp (Number of seconds elapsed since 1 Gen 1970).
String	get(String key) Get the value of the specified key.
Boolean	getbit(String key, long offset) Returns the bit value at offset in the string value stored at key
protected static String[]	getParams(List<String> keys, List<String> args)
String	getrange(String key, long startOffset, long endOffset)
String	getSet(String key, String value) GETSET is an atomic set this value and return the old value command.
Long	hdel(String key, String... fields) Remove the specified field from an hash stored at key.
Boolean	hexists(String key, String field) Test for existence of a specified field in a hash.
String	hget(String key, String field) If key holds a hash, retrieve the value associated to the specified field.
Map<String,String>	hgetAll(String key) Return all the fields and associated values in a hash.
Long	hincrBy(String key, String field, long value) Increment the number stored at field in the hash at key by value.
Double	hincrByFloat(String key, String field, double increment)
Set<String>	hkeys(String key) Return all the fields in a hash.
Long	hlen(String key) Return the number of items in a hash.
List<String>	hmget(String key, String... fields) Retrieve the values associated to the specified fields.
String	hmset(String key, Map<String,String> hash) Set the respective fields to the respective values.
ScanResult<Map.Entry<String,String>>	hscan(String key, int cursor)
ScanResult<Map.Entry<String,String>>	hscan(String key, int cursor, ScanParams params)
Long	hset(String key, String field, String value) Set the specified hash field to the specified value.
Long	hsetnx(String key, String field, String value) Set the specified hash field to the specified value if the field not exists.
List<String>	hvals(String key) Return all the values in a hash.
Long	incr(String key) Increment the number stored at key by one.
Long	incrBy(String key, long integer) INCRBY work just like INCR but instead to increment by 1 the increment is integer.
Double	incrByFloat(String key, double increment)
Set<String>	keys(String pattern) Returns all the keys matching the glob-style pattern as space separated strings.
String	lindex(String key, long index) Return the specified element of the list stored at the specified key.
Long	linsert(String key, BinaryClient.LIST_POSITION where, String pivot, String value)
Long	llen(String key) Return the length of the list stored at the specified key.
String	lpop(String key) Atomically return and remove the first (LPOP) or last (RPOP) element of the list.
Long	lpush(String key, String... strings) Add the string value to the head (LPUSH) or tail (RPUSH) of the list stored at key.
Long	lpushx(String key, String... string)
List<String>	lrange(String key, long start, long end) Return the specified elements of the list stored at the specified key.
Long	lrem(String key, long count, String value) Remove the first count occurrences of the value element from the list.
String	lset(String key, long index, String value) Set a new value as the element at index position of the List at key.
String	ltrim(String key, long start, long end) Trim an existing list so that it will contain only the specified range of elements specified.
List<String>	mget(String... keys) Get the values of all the specified keys.
String	migrate(String host, int port, String key, int destinationDb, int timeout)
Long	move(String key, int dbIndex) Move the specified key from the currently selected DB to the specified destination DB.
String	mset(String... keysvalues) Set the the respective keys to the respective values.
Long	msetnx(String... keysvalues) Set the the respective keys to the respective values.
String	objectEncoding(String string)
Long	objectIdletime(String string)
Long	objectRefcount(String string)
Long	persist(String key) Undo a expire at turning the expire key into a normal key.
Long	pexpire(String key, int milliseconds)
Long	pexpireAt(String key, long millisecondsTimestamp)
String	psetex(String key, int milliseconds, String value)
void	psubscribe(JedisPubSub jedisPubSub, String... patterns)
Long	pttl(String key)
Long	publish(String channel, String message)
List<String>	pubsubChannels(String pattern)
Long	pubsubNumPat()
Map<String,String>	pubsubNumSub(String... channels)
String	randomKey() Return a randomly selected key from the currently selected DB.
String	rename(String oldkey, String newkey) Atomically renames the key oldkey to newkey.
Long	renamenx(String oldkey, String newkey) Rename oldkey into newkey but fails if the destination key newkey already exists.
String	restore(String key, int ttl, byte[] serializedValue)
String	rpop(String key) Atomically return and remove the first (LPOP) or last (RPOP) element of the list.
String	rpoplpush(String srckey, String dstkey) Atomically return and remove the last (tail) element of the srckey list, and push the element as the first (head) element of the dstkey list.
Long	rpush(String key, String... strings) Add the string value to the head (LPUSH) or tail (RPUSH) of the list stored at key.
Long	rpushx(String key, String... string)
Long	sadd(String key, String... members) Add the specified member to the set value stored at key.
ScanResult<String>	scan(int cursor)
ScanResult<String>	scan(int cursor, ScanParams params)
Long	scard(String key) Return the set cardinality (number of elements).
List<Boolean>	scriptExists(String... sha1)
Boolean	scriptExists(String sha1)
String	scriptLoad(String script)
Set<String>	sdiff(String... keys) Return the difference between the Set stored at key1 and all the Sets key2, ..., keyN
Long	sdiffstore(String dstkey, String... keys) This command works exactly like SDIFF but instead of being returned the resulting set is stored in dstkey.
List<String>	sentinelGetMasterAddrByName(String masterName) redis 127.0.0.1:26381> sentinel get-master-addr-by-name mymaster 1) "127.0.0.1" 2) "6379"
List<Map<String,String>>	sentinelMasters() redis 127.0.0.1:26381> sentinel masters 1) 1) "name" 2) "mymaster" 3) "ip" 4) "127.0.0.1" 5) "port" 6) "6379" 7) "runid" 8) "93d4d4e6e9c06d0eea36e27f31924ac26576081d" 9) "flags" 10) "master" 11) "pending-commands" 12) "0" 13) "last-ok-ping-reply" 14) "423" 15) "last-ping-reply" 16) "423" 17) "info-refresh" 18) "6107" 19) "num-slaves" 20) "1" 21) "num-other-sentinels" 22) "2" 23) "quorum" 24) "2"
Long	sentinelReset(String pattern) redis 127.0.0.1:26381> sentinel reset mymaster (integer) 1
List<Map<String,String>>	sentinelSlaves(String masterName) redis 127.0.0.1:26381> sentinel slaves mymaster 1) 1) "name" 2) "127.0.0.1:6380" 3) "ip" 4) "127.0.0.1" 5) "port" 6) "6380" 7) "runid" 8) "d7f6c0ca7572df9d2f33713df0dbf8c72da7c039" 9) "flags" 10) "slave" 11) "pending-commands" 12) "0" 13) "last-ok-ping-reply" 14) "47" 15) "last-ping-reply" 16) "47" 17) "info-refresh" 18) "657" 19) "master-link-down-time" 20) "0" 21) "master-link-status" 22) "ok" 23) "master-host" 24) "localhost" 25) "master-port" 26) "6379" 27) "slave-priority" 28) "100"
String	set(String key, String value) Set the string value as value of the key.
String	set(String key, String value, String nxxx)
String	set(String key, String value, String nxxx, String expx, int time)
String	set(String key, String value, String nxxx, String expx, long time) Set the string value as value of the key.
Boolean	setbit(String key, long offset, boolean value) Sets or clears the bit at offset in the string value stored at key
Boolean	setbit(String key, long offset, String value)
String	setex(String key, int seconds, String value) The command is exactly equivalent to the following group of commands: SET + EXPIRE.
Long	setnx(String key, String value) SETNX works exactly like SET with the only difference that if the key already exists no operation is performed.
Long	setrange(String key, long offset, String value)
Set<String>	sinter(String... keys) Return the members of a set resulting from the intersection of all the sets hold at the specified keys.
Long	sinterstore(String dstkey, String... keys) This commnad works exactly like SINTER but instead of being returned the resulting set is sotred as dstkey.
Boolean	sismember(String key, String member) Return 1 if member is a member of the set stored at key, otherwise 0 is returned.
List<Slowlog>	slowlogGet()
List<Slowlog>	slowlogGet(long entries)
Set<String>	smembers(String key) Return all the members (elements) of the set value stored at key.
Long	smove(String srckey, String dstkey, String member) Move the specifided member from the set at srckey to the set at dstkey.
List<String>	sort(String key) Sort a Set or a List.
List<String>	sort(String key, SortingParams sortingParameters) Sort a Set or a List accordingly to the specified parameters.
Long	sort(String key, SortingParams sortingParameters, String dstkey) Sort a Set or a List accordingly to the specified parameters and store the result at dstkey.
Long	sort(String key, String dstkey) Sort a Set or a List and Store the Result at dstkey.
String	spop(String key) Remove a random element from a Set returning it as return value.
String	srandmember(String key) Return a random element from a Set, without removing the element.
List<String>	srandmember(String key, int count)
Long	srem(String key, String... members) Remove the specified member from the set value stored at key.
ScanResult<String>	sscan(String key, int cursor)
ScanResult<String>	sscan(String key, int cursor, ScanParams params)
Long	strlen(String key)
void	subscribe(JedisPubSub jedisPubSub, String... channels)
String	substr(String key, int start, int end) Return a subset of the string from offset start to offset end (both offsets are inclusive).
Set<String>	sunion(String... keys) Return the members of a set resulting from the union of all the sets hold at the specified keys.
Long	sunionstore(String dstkey, String... keys) This command works exactly like SUNION but instead of being returned the resulting set is stored as dstkey.
Long	ttl(String key) The TTL command returns the remaining time to live in seconds of a key that has an EXPIRE set.
String	type(String key) Return the type of the value stored at key in form of a string.
String	watch(String... keys)
Long	zadd(String key, double score, String member) Add the specified member having the specifeid score to the sorted set stored at key.
Long	zadd(String key, Map<String,Double> scoreMembers)
Long	zcard(String key) Return the sorted set cardinality (number of elements).
Long	zcount(String key, double min, double max)
Long	zcount(String key, String min, String max)
Double	zincrby(String key, double score, String member) If member already exists in the sorted set adds the increment to its score and updates the position of the element in the sorted set accordingly.
Long	zinterstore(String dstkey, String... sets) Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey.
Long	zinterstore(String dstkey, ZParams params, String... sets) Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey.
Set<String>	zrange(String key, long start, long end)
Set<String>	zrangeByScore(String key, double min, double max) Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).
Set<String>	zrangeByScore(String key, double min, double max, int offset, int count) Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).
Set<String>	zrangeByScore(String key, String min, String max)
Set<String>	zrangeByScore(String key, String min, String max, int offset, int count)
Set<Tuple>	zrangeByScoreWithScores(String key, double min, double max) Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).
Set<Tuple>	zrangeByScoreWithScores(String key, double min, double max, int offset, int count) Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).
Set<Tuple>	zrangeByScoreWithScores(String key, String min, String max)
Set<Tuple>	zrangeByScoreWithScores(String key, String min, String max, int offset, int count)
Set<Tuple>	zrangeWithScores(String key, long start, long end)
Long	zrank(String key, String member) Return the rank (or index) or member in the sorted set at key, with scores being ordered from low to high.
Long	zrem(String key, String... members) Remove the specified member from the sorted set value stored at key.
Long	zremrangeByRank(String key, long start, long end) Remove all elements in the sorted set at key with rank between start and end.
Long	zremrangeByScore(String key, double start, double end) Remove all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).
Long	zremrangeByScore(String key, String start, String end)
Set<String>	zrevrange(String key, long start, long end)
Set<String>	zrevrangeByScore(String key, double max, double min)
Set<String>	zrevrangeByScore(String key, double max, double min, int offset, int count)
Set<String>	zrevrangeByScore(String key, String max, String min)
Set<String>	zrevrangeByScore(String key, String max, String min, int offset, int count)
Set<Tuple>	zrevrangeByScoreWithScores(String key, double max, double min)
Set<Tuple>	zrevrangeByScoreWithScores(String key, double max, double min, int offset, int count)
Set<Tuple>	zrevrangeByScoreWithScores(String key, String max, String min)
Set<Tuple>	zrevrangeByScoreWithScores(String key, String max, String min, int offset, int count)
Set<Tuple>	zrevrangeWithScores(String key, long start, long end)
Long	zrevrank(String key, String member) Return the rank (or index) or member in the sorted set at key, with scores being ordered from high to low.
ScanResult<Tuple>	zscan(String key, int cursor)
ScanResult<Tuple>	zscan(String key, int cursor, ScanParams params)
Double	zscore(String key, String member) Return the score of the specified element of the sorted set at key.
Long	zunionstore(String dstkey, String... sets) Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey.
Long	zunionstore(String dstkey, ZParams params, String... sets) Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey.

Methods inherited from class redis.clients.jedis.BinaryJedis

append, auth, bgrewriteaof, bgsave, bitcount, bitcount, bitop, blpop, blpop, blpop, brpop, brpop, brpop, brpoplpush, checkIsInMulti, clientGetname, clientKill, clientList, clientSetname, configGet, configResetStat, configSet, connect, dbSize, debug, decr, decrBy, del, del, disconnect, dump, echo, eval, eval, eval, eval, evalsha, evalsha, evalsha, exists, expire, expireAt, flushAll, flushDB, get, getbit, getClient, getDB, getrange, getSet, hdel, hexists, hget, hgetAll, hincrBy, hincrByFloat, hkeys, hlen, hmget, hmset, hset, hsetnx, hvals, incr, incrBy, incrByFloat, info, info, isConnected, keys, lastsave, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrem, lset, ltrim, mget, migrate, monitor, move, mset, msetnx, multi, multi, objectEncoding, objectIdletime, objectRefcount, persist, pexpire, pexpireAt, ping, pipelined, pipelined, psetex, psubscribe, pttl, publish, quit, randomBinaryKey, rename, renamenx, resetState, restore, rpop, rpoplpush, rpush, rpushx, sadd, save, scard, scriptExists, scriptFlush, scriptKill, scriptLoad, sdiff, sdiffstore, select, set, set, set, set, setbit, setbit, setex, setnx, setrange, shutdown, sinter, sinterstore, sismember, slaveof, slaveofNoOne, slowlogGetBinary, slowlogGetBinary, slowlogLen, slowlogReset, smembers, smove, sort, sort, sort, sort, spop, srandmember, srandmember, srem, strlen, subscribe, substr, sunion, sunionstore, sync, time, ttl, type, unwatch, waitReplicas, watch, zadd, zadd, zcard, zcount, zcount, zincrby, zinterstore, zinterstore, zrange, zrangeByScore, zrangeByScore, zrangeByScore, zrangeByScore, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeWithScores, zrank, zrem, zremrangeByRank, zremrangeByScore, zremrangeByScore, zrevrange, zrevrangeByScore, zrevrangeByScore, zrevrangeByScore, zrevrangeByScore, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeWithScores, zrevrank, zscore, zunionstore, zunionstore

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface redis.clients.jedis.MultiKeyCommands

unwatch

Methods inherited from interface redis.clients.jedis.AdvancedJedisCommands

slowlogLen, slowlogReset

Methods inherited from interface redis.clients.jedis.BasicCommands

auth, bgrewriteaof, bgsave, configResetStat, dbSize, debug, flushAll, flushDB, getDB, info, info, lastsave, ping, quit, save, select, shutdown, slaveof, slaveofNoOne, waitReplicas

Constructor Detail

Jedis

public Jedis(String host)

Jedis

public Jedis(String host,
     int port)

Jedis

public Jedis(String host,
     int port,
     int timeout)

Jedis

public Jedis(JedisShardInfo shardInfo)

Jedis

public Jedis(URI uri)

Method Detail

set

public String set(String key,
         String value)

Set the string value as value of the key. The string can't be longer than 1073741824 bytes (1 GB).

Time complexity: O(1)

Specified by:

set in interface JedisCommands

Parameters:

key -

value -

Returns:

Status code reply

set

public String set(String key,
         String value,
         String nxxx,
         String expx,
         long time)

Set the string value as value of the key. The string can't be longer than 1073741824 bytes (1 GB).

Parameters:

key -

value -

nxxx - NX|XX, NX -- Only set the key if it does not already exist. XX -- Only set the key if it already exist.

expx - EX|PX, expire time units: EX = seconds; PX = milliseconds

time - expire time in the units of

Returns:

Status code reply

get

public String get(String key)

Get the value of the specified key. If the key does not exist null is returned. If the value stored at key is not a string an error is returned because GET can only handle string values.

Time complexity: O(1)

Specified by:

get in interface JedisCommands

Parameters:

key -

Returns:

Bulk reply

exists

public Boolean exists(String key)

Test if the specified key exists. The command returns "1" if the key exists, otherwise "0" is returned. Note that even keys set with an empty string as value will return "1". Time complexity: O(1)

Specified by:

exists in interface JedisCommands

Parameters:

key -

Returns:

Boolean reply, true if the key exists, otherwise false

del

public Long del(String... keys)

Remove the specified keys. If a given key does not exist no operation is performed for this key. The command returns the number of keys removed. Time complexity: O(1)

Specified by:

del in interface MultiKeyCommands

Parameters:

keys -

Returns:

Integer reply, specifically: an integer greater than 0 if one or more keys were removed 0 if none of the specified key existed

del

public Long del(String key)

Specified by:

del in interface JedisCommands

type

public String type(String key)

Return the type of the value stored at key in form of a string. The type can be one of "none", "string", "list", "set". "none" is returned if the key does not exist. Time complexity: O(1)

Specified by:

type in interface JedisCommands

Parameters:

key -

Returns:

Status code reply, specifically: "none" if the key does not exist "string" if the key contains a String value "list" if the key contains a List value "set" if the key contains a Set value "zset" if the key contains a Sorted Set value "hash" if the key contains a Hash value

keys

public Set<String> keys(String pattern)

Returns all the keys matching the glob-style pattern as space separated strings. For example if you have in the database the keys "foo" and "foobar" the command "KEYS foo*" will return "foo foobar".

Note that while the time complexity for this operation is O(n) the constant times are pretty low. For example Redis running on an entry level laptop can scan a 1 million keys database in 40 milliseconds. Still it's better to consider this one of the slow commands that may ruin the DB performance if not used with care.

In other words this command is intended only for debugging and special operations like creating a script to change the DB schema. Don't use it in your normal code. Use Redis Sets in order to group together a subset of objects.

Glob style patterns examples:

• h?llo will match hello hallo hhllo
• h*llo will match hllo heeeello
• h[ae]llo will match hello and hallo, but not hillo

Use \ to escape special chars if you want to match them verbatim.

Time complexity: O(n) (with n being the number of keys in the DB, and assuming keys and pattern of limited length)

Specified by:

keys in interface MultiKeyCommands

Parameters:

pattern -

Returns:

Multi bulk reply

randomKey

public String randomKey()

Return a randomly selected key from the currently selected DB.

Time complexity: O(1)

Specified by:

randomKey in interface MultiKeyCommands

Returns:

Singe line reply, specifically the randomly selected key or an empty string is the database is empty

rename

public String rename(String oldkey,
            String newkey)

Atomically renames the key oldkey to newkey. If the source and destination name are the same an error is returned. If newkey already exists it is overwritten.

Time complexity: O(1)

Specified by:

rename in interface MultiKeyCommands

Parameters:

oldkey -

newkey -

Returns:

Status code repy

renamenx

public Long renamenx(String oldkey,
            String newkey)

Rename oldkey into newkey but fails if the destination key newkey already exists.

Time complexity: O(1)

Specified by:

renamenx in interface MultiKeyCommands

Parameters:

oldkey -

newkey -

Returns:

Integer reply, specifically: 1 if the key was renamed 0 if the target key already exist

expire

public Long expire(String key,
          int seconds)

Set a timeout on the specified key. After the timeout the key will be automatically deleted by the server. A key with an associated timeout is said to be volatile in Redis terminology.

Voltile keys are stored on disk like the other keys, the timeout is persistent too like all the other aspects of the dataset. Saving a dataset containing expires and stopping the server does not stop the flow of time as Redis stores on disk the time when the key will no longer be available as Unix time, and not the remaining seconds.

Since Redis 2.1.3 you can update the value of the timeout of a key already having an expire set. It is also possible to undo the expire at all turning the key into a normal key using the PERSIST command.

Time complexity: O(1)

Specified by:

expire in interface JedisCommands

Parameters:

key -

seconds -

Returns:

Integer reply, specifically: 1: the timeout was set. 0: the timeout was not set since the key already has an associated timeout (this may happen only in Redis versions < 2.1.3, Redis >= 2.1.3 will happily update the timeout), or the key does not exist.

See Also:

ExpireCommand

expireAt

public Long expireAt(String key,
            long unixTime)

EXPIREAT works exctly like EXPIRE but instead to get the number of seconds representing the Time To Live of the key as a second argument (that is a relative way of specifing the TTL), it takes an absolute one in the form of a UNIX timestamp (Number of seconds elapsed since 1 Gen 1970).

EXPIREAT was introduced in order to implement the Append Only File persistence mode so that EXPIRE commands are automatically translated into EXPIREAT commands for the append only file. Of course EXPIREAT can also used by programmers that need a way to simply specify that a given key should expire at a given time in the future.

Since Redis 2.1.3 you can update the value of the timeout of a key already having an expire set. It is also possible to undo the expire at all turning the key into a normal key using the PERSIST command.

Time complexity: O(1)

Specified by:

expireAt in interface JedisCommands

Parameters:

key -

unixTime -

Returns:

Integer reply, specifically: 1: the timeout was set. 0: the timeout was not set since the key already has an associated timeout (this may happen only in Redis versions < 2.1.3, Redis >= 2.1.3 will happily update the timeout), or the key does not exist.

See Also:

ExpireCommand

ttl

public Long ttl(String key)

The TTL command returns the remaining time to live in seconds of a key that has an EXPIRE set. This introspection capability allows a Redis client to check how many seconds a given key will continue to be part of the dataset.

Specified by:

ttl in interface JedisCommands

Parameters:

key -

Returns:

Integer reply, returns the remaining time to live in seconds of a key that has an EXPIRE. If the Key does not exists or does not have an associated expire, -1 is returned.

move

public Long move(String key,
        int dbIndex)

Move the specified key from the currently selected DB to the specified destination DB. Note that this command returns 1 only if the key was successfully moved, and 0 if the target key was already there or if the source key was not found at all, so it is possible to use MOVE as a locking primitive.

Specified by:

move in interface JedisCommands

Parameters:

key -

dbIndex -

Returns:

Integer reply, specifically: 1 if the key was moved 0 if the key was not moved because already present on the target DB or was not found in the current DB.

getSet

public String getSet(String key,
            String value)

GETSET is an atomic set this value and return the old value command. Set key to the string value and return the old value stored at key. The string can't be longer than 1073741824 bytes (1 GB).

Time complexity: O(1)

Specified by:

getSet in interface JedisCommands

Parameters:

key -

value -

Returns:

Bulk reply

mget

public List<String> mget(String... keys)

Get the values of all the specified keys. If one or more keys dont exist or is not of type String, a 'nil' value is returned instead of the value of the specified key, but the operation never fails.

Time complexity: O(1) for every key

Specified by:

mget in interface MultiKeyCommands

Parameters:

keys -

Returns:

Multi bulk reply

setnx

public Long setnx(String key,
         String value)

SETNX works exactly like SET with the only difference that if the key already exists no operation is performed. SETNX actually means "SET if Not eXists".

Time complexity: O(1)

Specified by:

setnx in interface JedisCommands

Parameters:

key -

value -

Returns:

Integer reply, specifically: 1 if the key was set 0 if the key was not set

setex

public String setex(String key,
           int seconds,
           String value)

The command is exactly equivalent to the following group of commands: SET + EXPIRE. The operation is atomic.

Time complexity: O(1)

Specified by:

setex in interface JedisCommands

Parameters:

key -

seconds -

value -

Returns:

Status code reply

mset

public String mset(String... keysvalues)

Set the the respective keys to the respective values. MSET will replace old values with new values, while MSETNX will not perform any operation at all even if just a single key already exists.

Because of this semantic MSETNX can be used in order to set different keys representing different fields of an unique logic object in a way that ensures that either all the fields or none at all are set.

Both MSET and MSETNX are atomic operations. This means that for instance if the keys A and B are modified, another client talking to Redis can either see the changes to both A and B at once, or no modification at all.

Specified by:

mset in interface MultiKeyCommands

Parameters:

keysvalues -

Returns:

Status code reply Basically +OK as MSET can't fail

See Also:

msetnx(String...)

msetnx

public Long msetnx(String... keysvalues)

Set the the respective keys to the respective values. MSET will replace old values with new values, while MSETNX will not perform any operation at all even if just a single key already exists.

Because of this semantic MSETNX can be used in order to set different keys representing different fields of an unique logic object in a way that ensures that either all the fields or none at all are set.

Both MSET and MSETNX are atomic operations. This means that for instance if the keys A and B are modified, another client talking to Redis can either see the changes to both A and B at once, or no modification at all.

Specified by:

msetnx in interface MultiKeyCommands

Parameters:

keysvalues -

Returns:

Integer reply, specifically: 1 if the all the keys were set 0 if no key was set (at least one key already existed)

See Also:

mset(String...)

decrBy

public Long decrBy(String key,
          long integer)

IDECRBY work just like INCR but instead to decrement by 1 the decrement is integer.

INCR commands are limited to 64 bit signed integers.

Note: this is actually a string operation, that is, in Redis there are not "integer" types. Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented, and then converted back as a string.

Time complexity: O(1)

Specified by:

decrBy in interface JedisCommands

Parameters:

key -

integer -

Returns:

Integer reply, this commands will reply with the new value of key after the increment.

See Also:

incr(String), decr(String), incrBy(String, long)

decr

public Long decr(String key)

Decrement the number stored at key by one. If the key does not exist or contains a value of a wrong type, set the key to the value of "0" before to perform the decrement operation.

INCR commands are limited to 64 bit signed integers.

Note: this is actually a string operation, that is, in Redis there are not "integer" types. Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented, and then converted back as a string.

Time complexity: O(1)

Specified by:

decr in interface JedisCommands

Parameters:

key -

Returns:

Integer reply, this commands will reply with the new value of key after the increment.

See Also:

incr(String), incrBy(String, long), decrBy(String, long)

incrBy

public Long incrBy(String key,
          long integer)

INCRBY work just like INCR but instead to increment by 1 the increment is integer.

INCR commands are limited to 64 bit signed integers.

Note: this is actually a string operation, that is, in Redis there are not "integer" types. Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented, and then converted back as a string.

Time complexity: O(1)

Specified by:

incrBy in interface JedisCommands

Parameters:

key -

integer -

Returns:

Integer reply, this commands will reply with the new value of key after the increment.

See Also:

incr(String), decr(String), decrBy(String, long)

incr

public Long incr(String key)

Increment the number stored at key by one. If the key does not exist or contains a value of a wrong type, set the key to the value of "0" before to perform the increment operation.

INCR commands are limited to 64 bit signed integers.

Note: this is actually a string operation, that is, in Redis there are not "integer" types. Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented, and then converted back as a string.

Time complexity: O(1)

Specified by:

incr in interface JedisCommands

Parameters:

key -

Returns:

Integer reply, this commands will reply with the new value of key after the increment.

See Also:

incrBy(String, long), decr(String), decrBy(String, long)

append

public Long append(String key,
          String value)

If the key already exists and is a string, this command appends the provided value at the end of the string. If the key does not exist it is created and set as an empty string, so APPEND will be very similar to SET in this special case.

Time complexity: O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by Redis will double the free space available on every reallocation.

Specified by:

append in interface JedisCommands

Parameters:

key -

value -

Returns:

Integer reply, specifically the total length of the string after the append operation.

substr

public String substr(String key,
            int start,
            int end)

Return a subset of the string from offset start to offset end (both offsets are inclusive). Negative offsets can be used in order to provide an offset starting from the end of the string. So -1 means the last char, -2 the penultimate and so forth.

The function handles out of range requests without raising an error, but just limiting the resulting range to the actual length of the string.

Time complexity: O(start+n) (with start being the start index and n the total length of the requested range). Note that the lookup part of this command is O(1) so for small strings this is actually an O(1) command.

Specified by:

substr in interface JedisCommands

Parameters:

key -

start -

end -

Returns:

Bulk reply

hset

public Long hset(String key,
        String field,
        String value)

Set the specified hash field to the specified value.

If key does not exist, a new key holding a hash is created.

Time complexity: O(1)

Specified by:

hset in interface JedisCommands

Parameters:

key -

field -

value -

Returns:

If the field already exists, and the HSET just produced an update of the value, 0 is returned, otherwise if a new field is created 1 is returned.

hget

public String hget(String key,
          String field)

If key holds a hash, retrieve the value associated to the specified field.

If the field is not found or the key does not exist, a special 'nil' value is returned.

Time complexity: O(1)

Specified by:

hget in interface JedisCommands

Parameters:

key -

field -

Returns:

Bulk reply

hsetnx

public Long hsetnx(String key,
          String field,
          String value)

Set the specified hash field to the specified value if the field not exists. Time complexity: O(1)

Specified by:

hsetnx in interface JedisCommands

Parameters:

key -

field -

value -

Returns:

If the field already exists, 0 is returned, otherwise if a new field is created 1 is returned.

hmset

public String hmset(String key,
           Map<String,String> hash)

Set the respective fields to the respective values. HMSET replaces old values with new values.

If key does not exist, a new key holding a hash is created.

Time complexity: O(N) (with N being the number of fields)

Specified by:

hmset in interface JedisCommands

Parameters:

key -

hash -

Returns:

Return OK or Exception if hash is empty

hmget

public List<String> hmget(String key,
                 String... fields)

Retrieve the values associated to the specified fields.

If some of the specified fields do not exist, nil values are returned. Non existing keys are considered like empty hashes.

Time complexity: O(N) (with N being the number of fields)

Specified by:

hmget in interface JedisCommands

Parameters:

key -

fields -

Returns:

Multi Bulk Reply specifically a list of all the values associated with the specified fields, in the same order of the request.

hincrBy

public Long hincrBy(String key,
           String field,
           long value)

Increment the number stored at field in the hash at key by value. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string, the value is set to 0 before applying the operation. Since the value argument is signed you can use this command to perform both increments and decrements.

The range of values supported by HINCRBY is limited to 64 bit signed integers.

Time complexity: O(1)

Specified by:

hincrBy in interface JedisCommands

Parameters:

key -

field -

value -

Returns:

Integer reply The new value at field after the increment operation.

hexists

public Boolean hexists(String key,
              String field)

Test for existence of a specified field in a hash. Time complexity: O(1)

Specified by:

hexists in interface JedisCommands

Parameters:

key -

field -

Returns:

Return 1 if the hash stored at key contains the specified field. Return 0 if the key is not found or the field is not present.

hdel

public Long hdel(String key,
        String... fields)

Remove the specified field from an hash stored at key.

Time complexity: O(1)

Specified by:

hdel in interface JedisCommands

Parameters:

key -

fields -

Returns:

If the field was present in the hash it is deleted and 1 is returned, otherwise 0 is returned and no operation is performed.

hlen

public Long hlen(String key)

Return the number of items in a hash.

Time complexity: O(1)

Specified by:

hlen in interface JedisCommands

Parameters:

key -

Returns:

The number of entries (fields) contained in the hash stored at key. If the specified key does not exist, 0 is returned assuming an empty hash.

hkeys

public Set<String> hkeys(String key)

Return all the fields in a hash.

Time complexity: O(N), where N is the total number of entries

Specified by:

hkeys in interface JedisCommands

Parameters:

key -

Returns:

All the fields names contained into a hash.

hvals

public List<String> hvals(String key)

Return all the values in a hash.

Time complexity: O(N), where N is the total number of entries

Specified by:

hvals in interface JedisCommands

Parameters:

key -

Returns:

All the fields values contained into a hash.

hgetAll

public Map<String,String> hgetAll(String key)

Return all the fields and associated values in a hash.

Time complexity: O(N), where N is the total number of entries

Specified by:

hgetAll in interface JedisCommands

Parameters:

key -

Returns:

All the fields and values contained into a hash.

rpush

public Long rpush(String key,
         String... strings)

Add the string value to the head (LPUSH) or tail (RPUSH) of the list stored at key. If the key does not exist an empty list is created just before the append operation. If the key exists but is not a List an error is returned.

Time complexity: O(1)

Specified by:

rpush in interface JedisCommands

Parameters:

key -

strings -

Returns:

Integer reply, specifically, the number of elements inside the list after the push operation.

lpush

public Long lpush(String key,
         String... strings)

Add the string value to the head (LPUSH) or tail (RPUSH) of the list stored at key. If the key does not exist an empty list is created just before the append operation. If the key exists but is not a List an error is returned.

Time complexity: O(1)

Specified by:

lpush in interface JedisCommands

Parameters:

key -

strings -

Returns:

Integer reply, specifically, the number of elements inside the list after the push operation.

llen

public Long llen(String key)

Return the length of the list stored at the specified key. If the key does not exist zero is returned (the same behaviour as for empty lists). If the value stored at key is not a list an error is returned.

Time complexity: O(1)

Specified by:

llen in interface JedisCommands

Parameters:

key -

Returns:

The length of the list.

lrange

public List<String> lrange(String key,
                  long start,
                  long end)

Return the specified elements of the list stored at the specified key. Start and end are zero-based indexes. 0 is the first element of the list (the list head), 1 the next element and so on.

For example LRANGE foobar 0 2 will return the first three elements of the list.

start and end can also be negative numbers indicating offsets from the end of the list. For example -1 is the last element of the list, -2 the penultimate element and so on.

Consistency with range functions in various programming languages

Note that if you have a list of numbers from 0 to 100, LRANGE 0 10 will return 11 elements, that is, rightmost item is included. This may or may not be consistent with behavior of range-related functions in your programming language of choice (think Ruby's Range.new, Array#slice or Python's range() function).

LRANGE behavior is consistent with one of Tcl.

Out-of-range indexes

Indexes out of range will not produce an error: if start is over the end of the list, or start > end, an empty list is returned. If end is over the end of the list Redis will threat it just like the last element of the list.

Time complexity: O(start+n) (with n being the length of the range and start being the start offset)

Specified by:

lrange in interface JedisCommands

Parameters:

key -

start -

end -

Returns:

Multi bulk reply, specifically a list of elements in the specified range.

ltrim

public String ltrim(String key,
           long start,
           long end)

Trim an existing list so that it will contain only the specified range of elements specified. Start and end are zero-based indexes. 0 is the first element of the list (the list head), 1 the next element and so on.

For example LTRIM foobar 0 2 will modify the list stored at foobar key so that only the first three elements of the list will remain.

start and end can also be negative numbers indicating offsets from the end of the list. For example -1 is the last element of the list, -2 the penultimate element and so on.

Indexes out of range will not produce an error: if start is over the end of the list, or start > end, an empty list is left as value. If end over the end of the list Redis will threat it just like the last element of the list.

Hint: the obvious use of LTRIM is together with LPUSH/RPUSH. For example:

lpush("mylist", "someelement"); ltrim("mylist", 0, 99); *

The above two commands will push elements in the list taking care that the list will not grow without limits. This is very useful when using Redis to store logs for example. It is important to note that when used in this way LTRIM is an O(1) operation because in the average case just one element is removed from the tail of the list.

Time complexity: O(n) (with n being len of list - len of range)

Specified by:

ltrim in interface JedisCommands

Parameters:

key -

start -

end -

Returns:

Status code reply

lindex

public String lindex(String key,
            long index)

Return the specified element of the list stored at the specified key. 0 is the first element, 1 the second and so on. Negative indexes are supported, for example -1 is the last element, -2 the penultimate and so on.

If the value stored at key is not of list type an error is returned. If the index is out of range a 'nil' reply is returned.

Note that even if the average time complexity is O(n) asking for the first or the last element of the list is O(1).

Time complexity: O(n) (with n being the length of the list)

Specified by:

lindex in interface JedisCommands

Parameters:

key -

index -

Returns:

Bulk reply, specifically the requested element

lset

public String lset(String key,
          long index,
          String value)

Set a new value as the element at index position of the List at key.

Out of range indexes will generate an error.

Similarly to other list commands accepting indexes, the index can be negative to access elements starting from the end of the list. So -1 is the last element, -2 is the penultimate, and so forth.

Time complexity:

O(N) (with N being the length of the list), setting the first or last elements of the list is O(1).

Specified by:

lset in interface JedisCommands

Parameters:

key -

index -

value -

Returns:

Status code reply

See Also:

lindex(String, long)

lrem

public Long lrem(String key,
        long count,
        String value)

Remove the first count occurrences of the value element from the list. If count is zero all the elements are removed. If count is negative elements are removed from tail to head, instead to go from head to tail that is the normal behaviour. So for example LREM with count -2 and hello as value to remove against the list (a,b,c,hello,x,hello,hello) will lave the list (a,b,c,hello,x). The number of removed elements is returned as an integer, see below for more information about the returned value. Note that non existing keys are considered like empty lists by LREM, so LREM against non existing keys will always return 0.

Time complexity: O(N) (with N being the length of the list)

Specified by:

lrem in interface JedisCommands

Parameters:

key -

count -

value -

Returns:

Integer Reply, specifically: The number of removed elements if the operation succeeded

lpop

public String lpop(String key)

Atomically return and remove the first (LPOP) or last (RPOP) element of the list. For example if the list contains the elements "a","b","c" LPOP will return "a" and the list will become "b","c".

If the key does not exist or the list is already empty the special value 'nil' is returned.

Specified by:

lpop in interface JedisCommands

Parameters:

key -

Returns:

Bulk reply

See Also:

rpop(String)

rpop

public String rpop(String key)

Atomically return and remove the first (LPOP) or last (RPOP) element of the list. For example if the list contains the elements "a","b","c" LPOP will return "a" and the list will become "b","c".

If the key does not exist or the list is already empty the special value 'nil' is returned.

Specified by:

rpop in interface JedisCommands

Parameters:

key -

Returns:

Bulk reply

See Also:

lpop(String)

rpoplpush

public String rpoplpush(String srckey,
               String dstkey)

Atomically return and remove the last (tail) element of the srckey list, and push the element as the first (head) element of the dstkey list. For example if the source list contains the elements "a","b","c" and the destination list contains the elements "foo","bar" after an RPOPLPUSH command the content of the two lists will be "a","b" and "c","foo","bar".

If the key does not exist or the list is already empty the special value 'nil' is returned. If the srckey and dstkey are the same the operation is equivalent to removing the last element from the list and pusing it as first element of the list, so it's a "list rotation" command.

Time complexity: O(1)

Specified by:

rpoplpush in interface MultiKeyCommands

Parameters:

srckey -

dstkey -

Returns:

Bulk reply

sadd

public Long sadd(String key,
        String... members)

Add the specified member to the set value stored at key. If member is already a member of the set no operation is performed. If key does not exist a new set with the specified member as sole member is created. If the key exists but does not hold a set value an error is returned.

Time complexity O(1)

Specified by:

sadd in interface JedisCommands

Parameters:

key -

members -

Returns:

Integer reply, specifically: 1 if the new element was added 0 if the element was already a member of the set

smembers

public Set<String> smembers(String key)

Return all the members (elements) of the set value stored at key. This is just syntax glue for SINTER.

Time complexity O(N)

Specified by:

smembers in interface JedisCommands

Parameters:

key -

Returns:

Multi bulk reply

srem

public Long srem(String key,
        String... members)

Remove the specified member from the set value stored at key. If member was not a member of the set no operation is performed. If key does not hold a set value an error is returned.

Time complexity O(1)

Specified by:

srem in interface JedisCommands

Parameters:

key -

members -

Returns:

Integer reply, specifically: 1 if the new element was removed 0 if the new element was not a member of the set

spop

public String spop(String key)

Remove a random element from a Set returning it as return value. If the Set is empty or the key does not exist, a nil object is returned.

The srandmember(String) command does a similar work but the returned element is not removed from the Set.

Time complexity O(1)

Specified by:

spop in interface JedisCommands

Parameters:

key -

Returns:

Bulk reply

smove

public Long smove(String srckey,
         String dstkey,
         String member)

Move the specifided member from the set at srckey to the set at dstkey. This operation is atomic, in every given moment the element will appear to be in the source or destination set for accessing clients.

If the source set does not exist or does not contain the specified element no operation is performed and zero is returned, otherwise the element is removed from the source set and added to the destination set. On success one is returned, even if the element was already present in the destination set.

An error is raised if the source or destination keys contain a non Set value.

Time complexity O(1)

Specified by:

smove in interface MultiKeyCommands

Parameters:

srckey -

dstkey -

member -

Returns:

Integer reply, specifically: 1 if the element was moved 0 if the element was not found on the first set and no operation was performed

scard

public Long scard(String key)

Return the set cardinality (number of elements). If the key does not exist 0 is returned, like for empty sets.

Specified by:

scard in interface JedisCommands

Parameters:

key -

Returns:

Integer reply, specifically: the cardinality (number of elements) of the set as an integer.

sismember

public Boolean sismember(String key,
                String member)

Return 1 if member is a member of the set stored at key, otherwise 0 is returned.

Time complexity O(1)

Specified by:

sismember in interface JedisCommands

Parameters:

key -

member -

Returns:

Integer reply, specifically: 1 if the element is a member of the set 0 if the element is not a member of the set OR if the key does not exist

sinter

public Set<String> sinter(String... keys)

Return the members of a set resulting from the intersection of all the sets hold at the specified keys. Like in LRANGE the result is sent to the client as a multi-bulk reply (see the protocol specification for more information). If just a single key is specified, then this command produces the same result as SMEMBERS. Actually SMEMBERS is just syntax sugar for SINTER.

Non existing keys are considered like empty sets, so if one of the keys is missing an empty set is returned (since the intersection with an empty set always is an empty set).

Time complexity O(N*M) worst case where N is the cardinality of the smallest set and M the number of sets

Specified by:

sinter in interface MultiKeyCommands

Parameters:

keys -

Returns:

Multi bulk reply, specifically the list of common elements.

sinterstore

public Long sinterstore(String dstkey,
               String... keys)

This commnad works exactly like SINTER but instead of being returned the resulting set is sotred as dstkey.

Time complexity O(N*M) worst case where N is the cardinality of the smallest set and M the number of sets

Specified by:

sinterstore in interface MultiKeyCommands

Parameters:

dstkey -

keys -

Returns:

Status code reply

sunion

public Set<String> sunion(String... keys)

Return the members of a set resulting from the union of all the sets hold at the specified keys. Like in LRANGE the result is sent to the client as a multi-bulk reply (see the protocol specification for more information). If just a single key is specified, then this command produces the same result as SMEMBERS.

Non existing keys are considered like empty sets.

Time complexity O(N) where N is the total number of elements in all the provided sets

Specified by:

sunion in interface MultiKeyCommands

Parameters:

keys -

Returns:

Multi bulk reply, specifically the list of common elements.

sunionstore

public Long sunionstore(String dstkey,
               String... keys)

This command works exactly like SUNION but instead of being returned the resulting set is stored as dstkey. Any existing value in dstkey will be over-written.

Time complexity O(N) where N is the total number of elements in all the provided sets

Specified by:

sunionstore in interface MultiKeyCommands

Parameters:

dstkey -

keys -

Returns:

Status code reply

sdiff

public Set<String> sdiff(String... keys)

Return the difference between the Set stored at key1 and all the Sets key2, ..., keyN

Example:

 key1 = [x, a, b, c]
 key2 = [c]
 key3 = [a, d]
 SDIFF key1,key2,key3 => [x, b]
 

Non existing keys are considered like empty sets.

Time complexity:

O(N) with N being the total number of elements of all the sets

Specified by:

sdiff in interface MultiKeyCommands

Parameters:

keys -

Returns:

Return the members of a set resulting from the difference between the first set provided and all the successive sets.

sdiffstore

public Long sdiffstore(String dstkey,
              String... keys)

This command works exactly like SDIFF but instead of being returned the resulting set is stored in dstkey.

Specified by:

sdiffstore in interface MultiKeyCommands

Parameters:

dstkey -

keys -

Returns:

Status code reply

srandmember

public String srandmember(String key)

Return a random element from a Set, without removing the element. If the Set is empty or the key does not exist, a nil object is returned.

The SPOP command does a similar work but the returned element is popped (removed) from the Set.

Time complexity O(1)

Specified by:

srandmember in interface JedisCommands

Parameters:

key -

Returns:

Bulk reply

srandmember

public List<String> srandmember(String key,
                       int count)

zadd

public Long zadd(String key,
        double score,
        String member)

Add the specified member having the specifeid score to the sorted set stored at key. If member is already a member of the sorted set the score is updated, and the element reinserted in the right position to ensure sorting. If key does not exist a new sorted set with the specified member as sole member is crated. If the key exists but does not hold a sorted set value an error is returned.

The score value can be the string representation of a double precision floating point number.

Time complexity O(log(N)) with N being the number of elements in the sorted set

Specified by:

zadd in interface JedisCommands

Parameters:

key -

score -

member -

Returns:

Integer reply, specifically: 1 if the new element was added 0 if the element was already a member of the sorted set and the score was updated

zadd

public Long zadd(String key,
        Map<String,Double> scoreMembers)

Specified by:

zadd in interface JedisCommands

zrange

public Set<String> zrange(String key,
                 long start,
                 long end)

Specified by:

zrange in interface JedisCommands

zrem

public Long zrem(String key,
        String... members)

Remove the specified member from the sorted set value stored at key. If member was not a member of the set no operation is performed. If key does not not hold a set value an error is returned.

Time complexity O(log(N)) with N being the number of elements in the sorted set

Specified by:

zrem in interface JedisCommands

Parameters:

key -

members -

Returns:

Integer reply, specifically: 1 if the new element was removed 0 if the new element was not a member of the set

zincrby

public Double zincrby(String key,
             double score,
             String member)

If member already exists in the sorted set adds the increment to its score and updates the position of the element in the sorted set accordingly. If member does not already exist in the sorted set it is added with increment as score (that is, like if the previous score was virtually zero). If key does not exist a new sorted set with the specified member as sole member is crated. If the key exists but does not hold a sorted set value an error is returned.

The score value can be the string representation of a double precision floating point number. It's possible to provide a negative value to perform a decrement.

For an introduction to sorted sets check the Introduction to Redis data types page.

Time complexity O(log(N)) with N being the number of elements in the sorted set

Specified by:

zincrby in interface JedisCommands

Parameters:

key -

score -

member -

Returns:

The new score

zrank

public Long zrank(String key,
         String member)

Return the rank (or index) or member in the sorted set at key, with scores being ordered from low to high.

When the given member does not exist in the sorted set, the special value 'nil' is returned. The returned rank (or index) of the member is 0-based for both commands.

Time complexity:

O(log(N))

Specified by:

zrank in interface JedisCommands

Parameters:

key -

member -

Returns:

Integer reply or a nil bulk reply, specifically: the rank of the element as an integer reply if the element exists. A nil bulk reply if there is no such element.

See Also:

zrevrank(String, String)

zrevrank

public Long zrevrank(String key,
            String member)

Return the rank (or index) or member in the sorted set at key, with scores being ordered from high to low.

When the given member does not exist in the sorted set, the special value 'nil' is returned. The returned rank (or index) of the member is 0-based for both commands.

Time complexity:

O(log(N))

Specified by:

zrevrank in interface JedisCommands

Parameters:

key -

member -

Returns:

Integer reply or a nil bulk reply, specifically: the rank of the element as an integer reply if the element exists. A nil bulk reply if there is no such element.

See Also:

zrank(String, String)

zrevrange

public Set<String> zrevrange(String key,
                    long start,
                    long end)

Specified by:

zrevrange in interface JedisCommands

zrangeWithScores

public Set<Tuple> zrangeWithScores(String key,
                          long start,
                          long end)

Specified by:

zrangeWithScores in interface JedisCommands

zrevrangeWithScores

public Set<Tuple> zrevrangeWithScores(String key,
                             long start,
                             long end)

Specified by:

zrevrangeWithScores in interface JedisCommands

zcard

public Long zcard(String key)

Return the sorted set cardinality (number of elements). If the key does not exist 0 is returned, like for empty sorted sets.

Time complexity O(1)

Specified by:

zcard in interface JedisCommands

Parameters:

key -

Returns:

the cardinality (number of elements) of the set as an integer.

zscore

public Double zscore(String key,
            String member)

Return the score of the specified element of the sorted set at key. If the specified element does not exist in the sorted set, or the key does not exist at all, a special 'nil' value is returned.

Time complexity: O(1)

Specified by:

zscore in interface JedisCommands

Parameters:

key -

member -

Returns:

the score

watch

public String watch(String... keys)

Specified by:

watch in interface MultiKeyCommands

sort

public List<String> sort(String key)

Sort a Set or a List.

Sort the elements contained in the List, Set, or Sorted Set value at key. By default sorting is numeric with elements being compared as double precision floating point numbers. This is the simplest form of SORT.

Specified by:

sort in interface JedisCommands

Parameters:

key -

Returns:

Assuming the Set/List at key contains a list of numbers, the return value will be the list of numbers ordered from the smallest to the biggest number.

See Also:

sort(String, String), sort(String, SortingParams), sort(String, SortingParams, String)

sort

public List<String> sort(String key,
                SortingParams sortingParameters)

Sort a Set or a List accordingly to the specified parameters.

examples:

Given are the following sets and key/values:

 x = [1, 2, 3]
 y = [a, b, c]
 
 k1 = z
 k2 = y
 k3 = x
 
 w1 = 9
 w2 = 8
 w3 = 7
 

Sort Order:

 sort(x) or sort(x, sp.asc())
 -> [1, 2, 3]
 
 sort(x, sp.desc())
 -> [3, 2, 1]
 
 sort(y)
 -> [c, a, b]
 
 sort(y, sp.alpha())
 -> [a, b, c]
 
 sort(y, sp.alpha().desc())
 -> [c, a, b]
 

Limit (e.g. for Pagination):

 sort(x, sp.limit(0, 2))
 -> [1, 2]
 
 sort(y, sp.alpha().desc().limit(1, 2))
 -> [b, a]
 

Sorting by external keys:

 sort(x, sb.by(w*))
 -> [3, 2, 1]
 
 sort(x, sb.by(w*).desc())
 -> [1, 2, 3]
 

Getting external keys:

 sort(x, sp.by(w*).get(k*))
 -> [x, y, z]
 
 sort(x, sp.by(w*).get(#).get(k*))
 -> [3, x, 2, y, 1, z]
 

Specified by:

sort in interface JedisCommands

Parameters:

key -

sortingParameters -

Returns:

a list of sorted elements.

See Also:

sort(String), sort(String, SortingParams, String)

blpop

public List<String> blpop(int timeout,
                 String... keys)

BLPOP (and BRPOP) is a blocking list pop primitive. You can see this commands as blocking versions of LPOP and RPOP able to block if the specified keys don't exist or contain empty lists.

The following is a description of the exact semantic. We describe BLPOP but the two commands are identical, the only difference is that BLPOP pops the element from the left (head) of the list, and BRPOP pops from the right (tail).

Non blocking behavior

When BLPOP is called, if at least one of the specified keys contain a non empty list, an element is popped from the head of the list and returned to the caller together with the name of the key (BLPOP returns a two elements array, the first element is the key, the second the popped value).

Keys are scanned from left to right, so for instance if you issue BLPOP list1 list2 list3 0 against a dataset where list1 does not exist but list2 and list3 contain non empty lists, BLPOP guarantees to return an element from the list stored at list2 (since it is the first non empty list starting from the left).

Blocking behavior

If none of the specified keys exist or contain non empty lists, BLPOP blocks until some other client performs a LPUSH or an RPUSH operation against one of the lists.

Once new data is present on one of the lists, the client finally returns with the name of the key unblocking it and the popped value.

When blocking, if a non-zero timeout is specified, the client will unblock returning a nil special value if the specified amount of seconds passed without a push operation against at least one of the specified keys.

The timeout argument is interpreted as an integer value. A timeout of zero means instead to block forever.

Multiple clients blocking for the same keys

Multiple clients can block for the same key. They are put into a queue, so the first to be served will be the one that started to wait earlier, in a first-blpopping first-served fashion.

blocking POP inside a MULTI/EXEC transaction

BLPOP and BRPOP can be used with pipelining (sending multiple commands and reading the replies in batch), but it does not make sense to use BLPOP or BRPOP inside a MULTI/EXEC block (a Redis transaction).

The behavior of BLPOP inside MULTI/EXEC when the list is empty is to return a multi-bulk nil reply, exactly what happens when the timeout is reached. If you like science fiction, think at it like if inside MULTI/EXEC the time will flow at infinite speed :)

Time complexity: O(1)

Specified by:

blpop in interface MultiKeyCommands

Parameters:

timeout -

keys -

Returns:

BLPOP returns a two-elements array via a multi bulk reply in order to return both the unblocking key and the popped value.

When a non-zero timeout is specified, and the BLPOP operation timed out, the return value is a nil multi bulk reply. Most client values will return false or nil accordingly to the programming language used.

See Also:

brpop(int, String...)

blpop

public List<String> blpop(String... args)

Specified by:

blpop in interface MultiKeyCommands

brpop

public List<String> brpop(String... args)

Specified by:

brpop in interface MultiKeyCommands

blpop

public List<String> blpop(String arg)

Specified by:

blpop in interface JedisCommands

brpop

public List<String> brpop(String arg)

Specified by:

brpop in interface JedisCommands

sort

public Long sort(String key,
        SortingParams sortingParameters,
        String dstkey)

Sort a Set or a List accordingly to the specified parameters and store the result at dstkey.

Specified by:

sort in interface MultiKeyCommands

Parameters:

key -

sortingParameters -

dstkey -

Returns:

The number of elements of the list at dstkey.

See Also:

sort(String, SortingParams), sort(String), sort(String, String)

sort

public Long sort(String key,
        String dstkey)

Sort a Set or a List and Store the Result at dstkey.

Sort the elements contained in the List, Set, or Sorted Set value at key and store the result at dstkey. By default sorting is numeric with elements being compared as double precision floating point numbers. This is the simplest form of SORT.

Specified by:

sort in interface MultiKeyCommands

Parameters:

key -

dstkey -

Returns:

The number of elements of the list at dstkey.

See Also:

sort(String), sort(String, SortingParams), sort(String, SortingParams, String)

brpop

public List<String> brpop(int timeout,
                 String... keys)

BLPOP (and BRPOP) is a blocking list pop primitive. You can see this commands as blocking versions of LPOP and RPOP able to block if the specified keys don't exist or contain empty lists.

The following is a description of the exact semantic. We describe BLPOP but the two commands are identical, the only difference is that BLPOP pops the element from the left (head) of the list, and BRPOP pops from the right (tail).

Non blocking behavior

When BLPOP is called, if at least one of the specified keys contain a non empty list, an element is popped from the head of the list and returned to the caller together with the name of the key (BLPOP returns a two elements array, the first element is the key, the second the popped value).

Keys are scanned from left to right, so for instance if you issue BLPOP list1 list2 list3 0 against a dataset where list1 does not exist but list2 and list3 contain non empty lists, BLPOP guarantees to return an element from the list stored at list2 (since it is the first non empty list starting from the left).

Blocking behavior

If none of the specified keys exist or contain non empty lists, BLPOP blocks until some other client performs a LPUSH or an RPUSH operation against one of the lists.

Once new data is present on one of the lists, the client finally returns with the name of the key unblocking it and the popped value.

When blocking, if a non-zero timeout is specified, the client will unblock returning a nil special value if the specified amount of seconds passed without a push operation against at least one of the specified keys.

The timeout argument is interpreted as an integer value. A timeout of zero means instead to block forever.

Multiple clients blocking for the same keys

Multiple clients can block for the same key. They are put into a queue, so the first to be served will be the one that started to wait earlier, in a first-blpopping first-served fashion.

blocking POP inside a MULTI/EXEC transaction

BLPOP and BRPOP can be used with pipelining (sending multiple commands and reading the replies in batch), but it does not make sense to use BLPOP or BRPOP inside a MULTI/EXEC block (a Redis transaction).

The behavior of BLPOP inside MULTI/EXEC when the list is empty is to return a multi-bulk nil reply, exactly what happens when the timeout is reached. If you like science fiction, think at it like if inside MULTI/EXEC the time will flow at infinite speed :)

Time complexity: O(1)

Specified by:

brpop in interface MultiKeyCommands

Parameters:

timeout -

keys -

Returns:

BLPOP returns a two-elements array via a multi bulk reply in order to return both the unblocking key and the popped value.

When a non-zero timeout is specified, and the BLPOP operation timed out, the return value is a nil multi bulk reply. Most client values will return false or nil accordingly to the programming language used.

See Also:

blpop(int, String...)

zcount

public Long zcount(String key,
          double min,
          double max)

Specified by:

zcount in interface JedisCommands

zcount

public Long zcount(String key,
          String min,
          String max)

Specified by:

zcount in interface JedisCommands

zrangeByScore

public Set<String> zrangeByScore(String key,
                        double min,
                        double max)

Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).

The elements having the same score are returned sorted lexicographically as ASCII strings (this follows from a property of Redis sorted sets and does not involve further computation).

Using the optional LIMIT it's possible to get only a range of the matching elements in an SQL-alike way. Note that if offset is large the commands needs to traverse the list for offset elements and this adds up to the O(M) figure.

The ZCOUNT command is similar to ZRANGEBYSCORE but instead of returning the actual elements in the specified interval, it just returns the number of matching elements.

Exclusive intervals and infinity

min and max can be -inf and +inf, so that you are not required to know what's the greatest or smallest element in order to take, for instance, elements "up to a given value".

Also while the interval is for default closed (inclusive) it's possible to specify open intervals prefixing the score with a "(" character, so for instance:

ZRANGEBYSCORE zset (1.3 5

Will return all the values with score > 1.3 and <= 5, while for instance:

ZRANGEBYSCORE zset (5 (10

Will return all the values with score > 5 and < 10 (5 and 10 excluded).

Time complexity:

O(log(N))+O(M) with N being the number of elements in the sorted set and M the number of elements returned by the command, so if M is constant (for instance you always ask for the first ten elements with LIMIT) you can consider it O(log(N))

Specified by:

zrangeByScore in interface JedisCommands

Parameters:

key -

min - a double or Double.MIN_VALUE for "-inf"

max - a double or Double.MAX_VALUE for "+inf"

Returns:

Multi bulk reply specifically a list of elements in the specified score range.

See Also:

zrangeByScore(String, double, double), zrangeByScore(String, double, double, int, int), zrangeByScoreWithScores(String, double, double), zrangeByScoreWithScores(String, String, String), zrangeByScoreWithScores(String, double, double, int, int), zcount(String, double, double)

zrangeByScore

public Set<String> zrangeByScore(String key,
                        String min,
                        String max)

Specified by:

zrangeByScore in interface JedisCommands

zrangeByScore

public Set<String> zrangeByScore(String key,
                        double min,
                        double max,
                        int offset,
                        int count)

Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).

The elements having the same score are returned sorted lexicographically as ASCII strings (this follows from a property of Redis sorted sets and does not involve further computation).

Using the optional LIMIT it's possible to get only a range of the matching elements in an SQL-alike way. Note that if offset is large the commands needs to traverse the list for offset elements and this adds up to the O(M) figure.

The ZCOUNT command is similar to ZRANGEBYSCORE but instead of returning the actual elements in the specified interval, it just returns the number of matching elements.

Exclusive intervals and infinity

min and max can be -inf and +inf, so that you are not required to know what's the greatest or smallest element in order to take, for instance, elements "up to a given value".

Also while the interval is for default closed (inclusive) it's possible to specify open intervals prefixing the score with a "(" character, so for instance:

ZRANGEBYSCORE zset (1.3 5

Will return all the values with score > 1.3 and <= 5, while for instance:

ZRANGEBYSCORE zset (5 (10

Will return all the values with score > 5 and < 10 (5 and 10 excluded).

Time complexity:

O(log(N))+O(M) with N being the number of elements in the sorted set and M the number of elements returned by the command, so if M is constant (for instance you always ask for the first ten elements with LIMIT) you can consider it O(log(N))

Specified by:

zrangeByScore in interface JedisCommands

Parameters:

key -

min -

max -

Returns:

Multi bulk reply specifically a list of elements in the specified score range.

See Also:

zrangeByScore(String, double, double), zrangeByScore(String, double, double, int, int), zrangeByScoreWithScores(String, double, double), zrangeByScoreWithScores(String, double, double, int, int), zcount(String, double, double)

zrangeByScore

public Set<String> zrangeByScore(String key,
                        String min,
                        String max,
                        int offset,
                        int count)

Specified by:

zrangeByScore in interface JedisCommands

zrangeByScoreWithScores

public Set<Tuple> zrangeByScoreWithScores(String key,
                                 double min,
                                 double max)

Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).

The elements having the same score are returned sorted lexicographically as ASCII strings (this follows from a property of Redis sorted sets and does not involve further computation).

Using the optional LIMIT it's possible to get only a range of the matching elements in an SQL-alike way. Note that if offset is large the commands needs to traverse the list for offset elements and this adds up to the O(M) figure.

The ZCOUNT command is similar to ZRANGEBYSCORE but instead of returning the actual elements in the specified interval, it just returns the number of matching elements.

Exclusive intervals and infinity

min and max can be -inf and +inf, so that you are not required to know what's the greatest or smallest element in order to take, for instance, elements "up to a given value".

Also while the interval is for default closed (inclusive) it's possible to specify open intervals prefixing the score with a "(" character, so for instance:

ZRANGEBYSCORE zset (1.3 5

Will return all the values with score > 1.3 and <= 5, while for instance:

ZRANGEBYSCORE zset (5 (10

Will return all the values with score > 5 and < 10 (5 and 10 excluded).

Time complexity:

O(log(N))+O(M) with N being the number of elements in the sorted set and M the number of elements returned by the command, so if M is constant (for instance you always ask for the first ten elements with LIMIT) you can consider it O(log(N))

Specified by:

zrangeByScoreWithScores in interface JedisCommands

Parameters:

key -

min -

max -

Returns:

Multi bulk reply specifically a list of elements in the specified score range.

See Also:

zrangeByScore(String, double, double), zrangeByScore(String, double, double, int, int), zrangeByScoreWithScores(String, double, double), zrangeByScoreWithScores(String, double, double, int, int), zcount(String, double, double)

zrangeByScoreWithScores

public Set<Tuple> zrangeByScoreWithScores(String key,
                                 String min,
                                 String max)

Specified by:

zrangeByScoreWithScores in interface JedisCommands

zrangeByScoreWithScores

public Set<Tuple> zrangeByScoreWithScores(String key,
                                 double min,
                                 double max,
                                 int offset,
                                 int count)

Return the all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).

The elements having the same score are returned sorted lexicographically as ASCII strings (this follows from a property of Redis sorted sets and does not involve further computation).

Using the optional LIMIT it's possible to get only a range of the matching elements in an SQL-alike way. Note that if offset is large the commands needs to traverse the list for offset elements and this adds up to the O(M) figure.

The ZCOUNT command is similar to ZRANGEBYSCORE but instead of returning the actual elements in the specified interval, it just returns the number of matching elements.

Exclusive intervals and infinity

min and max can be -inf and +inf, so that you are not required to know what's the greatest or smallest element in order to take, for instance, elements "up to a given value".

Also while the interval is for default closed (inclusive) it's possible to specify open intervals prefixing the score with a "(" character, so for instance:

ZRANGEBYSCORE zset (1.3 5

Will return all the values with score > 1.3 and <= 5, while for instance:

ZRANGEBYSCORE zset (5 (10

Will return all the values with score > 5 and < 10 (5 and 10 excluded).

Time complexity:

O(log(N))+O(M) with N being the number of elements in the sorted set and M the number of elements returned by the command, so if M is constant (for instance you always ask for the first ten elements with LIMIT) you can consider it O(log(N))

Specified by:

zrangeByScoreWithScores in interface JedisCommands

Parameters:

key -

min -

max -

Returns:

Multi bulk reply specifically a list of elements in the specified score range.

See Also:

zrangeByScore(String, double, double), zrangeByScore(String, double, double, int, int), zrangeByScoreWithScores(String, double, double), zrangeByScoreWithScores(String, double, double, int, int), zcount(String, double, double)

zrangeByScoreWithScores

public Set<Tuple> zrangeByScoreWithScores(String key,
                                 String min,
                                 String max,
                                 int offset,
                                 int count)

Specified by:

zrangeByScoreWithScores in interface JedisCommands

zrevrangeByScore

public Set<String> zrevrangeByScore(String key,
                           double max,
                           double min)

Specified by:

zrevrangeByScore in interface JedisCommands

zrevrangeByScore

public Set<String> zrevrangeByScore(String key,
                           String max,
                           String min)

Specified by:

zrevrangeByScore in interface JedisCommands

zrevrangeByScore

public Set<String> zrevrangeByScore(String key,
                           double max,
                           double min,
                           int offset,
                           int count)

Specified by:

zrevrangeByScore in interface JedisCommands

zrevrangeByScoreWithScores

public Set<Tuple> zrevrangeByScoreWithScores(String key,
                                    double max,
                                    double min)

Specified by:

zrevrangeByScoreWithScores in interface JedisCommands

zrevrangeByScoreWithScores

public Set<Tuple> zrevrangeByScoreWithScores(String key,
                                    double max,
                                    double min,
                                    int offset,
                                    int count)

Specified by:

zrevrangeByScoreWithScores in interface JedisCommands

zrevrangeByScoreWithScores

public Set<Tuple> zrevrangeByScoreWithScores(String key,
                                    String max,
                                    String min,
                                    int offset,
                                    int count)

Specified by:

zrevrangeByScoreWithScores in interface JedisCommands

zrevrangeByScore

public Set<String> zrevrangeByScore(String key,
                           String max,
                           String min,
                           int offset,
                           int count)

Specified by:

zrevrangeByScore in interface JedisCommands

zrevrangeByScoreWithScores

public Set<Tuple> zrevrangeByScoreWithScores(String key,
                                    String max,
                                    String min)

Specified by:

zrevrangeByScoreWithScores in interface JedisCommands

zremrangeByRank

public Long zremrangeByRank(String key,
                   long start,
                   long end)

Remove all elements in the sorted set at key with rank between start and end. Start and end are 0-based with rank 0 being the element with the lowest score. Both start and end can be negative numbers, where they indicate offsets starting at the element with the highest rank. For example: -1 is the element with the highest score, -2 the element with the second highest score and so forth.

Time complexity: O(log(N))+O(M) with N being the number of elements in the sorted set and M the number of elements removed by the operation

Specified by:

zremrangeByRank in interface JedisCommands

zremrangeByScore

public Long zremrangeByScore(String key,
                    double start,
                    double end)

Remove all the elements in the sorted set at key with a score between min and max (including elements with score equal to min or max).

Time complexity:

O(log(N))+O(M) with N being the number of elements in the sorted set and M the number of elements removed by the operation

Specified by:

zremrangeByScore in interface JedisCommands

Parameters:

key -

start -

end -

Returns:

Integer reply, specifically the number of elements removed.

zremrangeByScore

public Long zremrangeByScore(String key,
                    String start,
                    String end)

Specified by:

zremrangeByScore in interface JedisCommands

zunionstore

public Long zunionstore(String dstkey,
               String... sets)

Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey. It is mandatory to provide the number of input keys N, before passing the input keys and the other (optional) arguments.

As the terms imply, the ZINTERSTORE command requires an element to be present in each of the given inputs to be inserted in the result. The ZUNIONSTORE command inserts all elements across all inputs.

Using the WEIGHTS option, it is possible to add weight to each input sorted set. This means that the score of each element in the sorted set is first multiplied by this weight before being passed to the aggregation. When this option is not given, all weights default to 1.

With the AGGREGATE option, it's possible to specify how the results of the union or intersection are aggregated. This option defaults to SUM, where the score of an element is summed across the inputs where it exists. When this option is set to be either MIN or MAX, the resulting set will contain the minimum or maximum score of an element across the inputs where it exists.

Time complexity: O(N) + O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set

Specified by:

zunionstore in interface MultiKeyCommands

Parameters:

dstkey -

sets -

Returns:

Integer reply, specifically the number of elements in the sorted set at dstkey

See Also:

zunionstore(String, String...), zunionstore(String, ZParams, String...), zinterstore(String, String...), zinterstore(String, ZParams, String...)

zunionstore

public Long zunionstore(String dstkey,
               ZParams params,
               String... sets)

Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey. It is mandatory to provide the number of input keys N, before passing the input keys and the other (optional) arguments.

As the terms imply, the ZINTERSTORE command requires an element to be present in each of the given inputs to be inserted in the result. The ZUNIONSTORE command inserts all elements across all inputs.

Using the WEIGHTS option, it is possible to add weight to each input sorted set. This means that the score of each element in the sorted set is first multiplied by this weight before being passed to the aggregation. When this option is not given, all weights default to 1.

With the AGGREGATE option, it's possible to specify how the results of the union or intersection are aggregated. This option defaults to SUM, where the score of an element is summed across the inputs where it exists. When this option is set to be either MIN or MAX, the resulting set will contain the minimum or maximum score of an element across the inputs where it exists.

Time complexity: O(N) + O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set

Specified by:

zunionstore in interface MultiKeyCommands

Parameters:

dstkey -

sets -

params -

Returns:

Integer reply, specifically the number of elements in the sorted set at dstkey

See Also:

zunionstore(String, String...), zunionstore(String, ZParams, String...), zinterstore(String, String...), zinterstore(String, ZParams, String...)

zinterstore

public Long zinterstore(String dstkey,
               String... sets)

Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey. It is mandatory to provide the number of input keys N, before passing the input keys and the other (optional) arguments.

As the terms imply, the ZINTERSTORE command requires an element to be present in each of the given inputs to be inserted in the result. The ZUNIONSTORE command inserts all elements across all inputs.

Using the WEIGHTS option, it is possible to add weight to each input sorted set. This means that the score of each element in the sorted set is first multiplied by this weight before being passed to the aggregation. When this option is not given, all weights default to 1.

With the AGGREGATE option, it's possible to specify how the results of the union or intersection are aggregated. This option defaults to SUM, where the score of an element is summed across the inputs where it exists. When this option is set to be either MIN or MAX, the resulting set will contain the minimum or maximum score of an element across the inputs where it exists.

Time complexity: O(N) + O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set

Specified by:

zinterstore in interface MultiKeyCommands

Parameters:

dstkey -

sets -

Returns:

Integer reply, specifically the number of elements in the sorted set at dstkey

See Also:

zunionstore(String, String...), zunionstore(String, ZParams, String...), zinterstore(String, String...), zinterstore(String, ZParams, String...)

zinterstore

public Long zinterstore(String dstkey,
               ZParams params,
               String... sets)

Creates a union or intersection of N sorted sets given by keys k1 through kN, and stores it at dstkey. It is mandatory to provide the number of input keys N, before passing the input keys and the other (optional) arguments.

As the terms imply, the ZINTERSTORE command requires an element to be present in each of the given inputs to be inserted in the result. The ZUNIONSTORE command inserts all elements across all inputs.

Using the WEIGHTS option, it is possible to add weight to each input sorted set. This means that the score of each element in the sorted set is first multiplied by this weight before being passed to the aggregation. When this option is not given, all weights default to 1.

With the AGGREGATE option, it's possible to specify how the results of the union or intersection are aggregated. This option defaults to SUM, where the score of an element is summed across the inputs where it exists. When this option is set to be either MIN or MAX, the resulting set will contain the minimum or maximum score of an element across the inputs where it exists.

Time complexity: O(N) + O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set

Specified by:

zinterstore in interface MultiKeyCommands

Parameters:

dstkey -

sets -

params -

Returns:

Integer reply, specifically the number of elements in the sorted set at dstkey

See Also:

zunionstore(String, String...), zunionstore(String, ZParams, String...), zinterstore(String, String...), zinterstore(String, ZParams, String...)

strlen

public Long strlen(String key)

Specified by:

strlen in interface JedisCommands

lpushx

public Long lpushx(String key,
          String... string)

Specified by:

lpushx in interface JedisCommands

persist

public Long persist(String key)

Undo a expire at turning the expire key into a normal key.

Time complexity: O(1)

Specified by:

persist in interface JedisCommands

Parameters:

key -

Returns:

Integer reply, specifically: 1: the key is now persist. 0: the key is not persist (only happens when key not set).

rpushx

public Long rpushx(String key,
          String... string)

Specified by:

rpushx in interface JedisCommands

echo

public String echo(String string)

Specified by:

echo in interface JedisCommands

linsert

public Long linsert(String key,
           BinaryClient.LIST_POSITION where,
           String pivot,
           String value)

Specified by:

linsert in interface JedisCommands

brpoplpush

public String brpoplpush(String source,
                String destination,
                int timeout)

Pop a value from a list, push it to another list and return it; or block until one is available

Specified by:

brpoplpush in interface MultiKeyCommands

Parameters:

source -

destination -

timeout -

Returns:

the element

setbit

public Boolean setbit(String key,
             long offset,
             boolean value)

Sets or clears the bit at offset in the string value stored at key

Specified by:

setbit in interface JedisCommands

Parameters:

key -

offset -

value -

Returns:

setbit

public Boolean setbit(String key,
             long offset,
             String value)

Specified by:

setbit in interface JedisCommands

getbit

public Boolean getbit(String key,
             long offset)

Returns the bit value at offset in the string value stored at key

Specified by:

getbit in interface JedisCommands

Parameters:

key -

offset -

Returns:

setrange

public Long setrange(String key,
            long offset,
            String value)

Specified by:

setrange in interface JedisCommands

getrange

public String getrange(String key,
              long startOffset,
              long endOffset)

Specified by:

getrange in interface JedisCommands

configGet

public List<String> configGet(String pattern)

Retrieve the configuration of a running Redis server. Not all the configuration parameters are supported.

CONFIG GET returns the current configuration parameters. This sub command only accepts a single argument, that is glob style pattern. All the configuration parameters matching this parameter are reported as a list of key-value pairs.

Example:

 $ redis-cli config get '*'
 1. "dbfilename"
 2. "dump.rdb"
 3. "requirepass"
 4. (nil)
 5. "masterauth"
 6. (nil)
 7. "maxmemory"
 8. "0\n"
 9. "appendfsync"
 10. "everysec"
 11. "save"
 12. "3600 1 300 100 60 10000"
 
 $ redis-cli config get 'm*'
 1. "masterauth"
 2. (nil)
 3. "maxmemory"
 4. "0\n"
 

Specified by:

configGet in interface AdvancedJedisCommands

Parameters:

pattern -

Returns:

Bulk reply.

configSet

public String configSet(String parameter,
               String value)

Alter the configuration of a running Redis server. Not all the configuration parameters are supported.

The list of configuration parameters supported by CONFIG SET can be obtained issuing a CONFIG GET * command.

The configuration set using CONFIG SET is immediately loaded by the Redis server that will start acting as specified starting from the next command.

Parameters value format

The value of the configuration parameter is the same as the one of the same parameter in the Redis configuration file, with the following exceptions:

• The save paramter is a list of space-separated integers. Every pair of integers specify the time and number of changes limit to trigger a save. For instance the command CONFIG SET save "3600 10 60 10000" will configure the server to issue a background saving of the RDB file every 3600 seconds if there are at least 10 changes in the dataset, and every 60 seconds if there are at least 10000 changes. To completely disable automatic snapshots just set the parameter as an empty string.
• All the integer parameters representing memory are returned and accepted only using bytes as unit.

Specified by:

configSet in interface AdvancedJedisCommands

Parameters:

parameter -

value -

Returns:

Status code reply

eval

public Object eval(String script,
          int keyCount,
          String... params)

Specified by:

eval in interface ScriptingCommands

subscribe

public void subscribe(JedisPubSub jedisPubSub,
             String... channels)

Specified by:

subscribe in interface MultiKeyCommands

publish

public Long publish(String channel,
           String message)

Specified by:

publish in interface MultiKeyCommands

psubscribe

public void psubscribe(JedisPubSub jedisPubSub,
              String... patterns)

Specified by:

psubscribe in interface MultiKeyCommands

getParams

protected static String[] getParams(List<String> keys,
                 List<String> args)

eval

public Object eval(String script,
          List<String> keys,
          List<String> args)

Specified by:

eval in interface ScriptingCommands

eval

public Object eval(String script)

Specified by:

eval in interface ScriptingCommands

evalsha

public Object evalsha(String script)

Specified by:

evalsha in interface ScriptingCommands

evalsha

public Object evalsha(String sha1,
             List<String> keys,
             List<String> args)

Specified by:

evalsha in interface ScriptingCommands

evalsha

public Object evalsha(String sha1,
             int keyCount,
             String... params)

Specified by:

evalsha in interface ScriptingCommands

scriptExists

public Boolean scriptExists(String sha1)

Specified by:

scriptExists in interface ScriptingCommands

scriptExists

public List<Boolean> scriptExists(String... sha1)

Specified by:

scriptExists in interface ScriptingCommands

scriptLoad

public String scriptLoad(String script)

Specified by:

scriptLoad in interface ScriptingCommands

slowlogGet

public List<Slowlog> slowlogGet()

Specified by:

slowlogGet in interface AdvancedJedisCommands

slowlogGet

public List<Slowlog> slowlogGet(long entries)

Specified by:

slowlogGet in interface AdvancedJedisCommands

objectRefcount

public Long objectRefcount(String string)

Specified by:

objectRefcount in interface AdvancedJedisCommands

objectEncoding

public String objectEncoding(String string)

Specified by:

objectEncoding in interface AdvancedJedisCommands

objectIdletime

public Long objectIdletime(String string)

Specified by:

objectIdletime in interface AdvancedJedisCommands

bitcount

public Long bitcount(String key)

Specified by:

bitcount in interface JedisCommands

bitcount

public Long bitcount(String key,
            long start,
            long end)

Specified by:

bitcount in interface JedisCommands

bitop

public Long bitop(BitOP op,
         String destKey,
         String... srcKeys)

Specified by:

bitop in interface MultiKeyCommands

sentinelMasters

public List<Map<String,String>> sentinelMasters()

 redis 127.0.0.1:26381> sentinel masters
 1)  1) "name"
     2) "mymaster"
     3) "ip"
     4) "127.0.0.1"
     5) "port"
     6) "6379"
     7) "runid"
     8) "93d4d4e6e9c06d0eea36e27f31924ac26576081d"
     9) "flags"
    10) "master"
    11) "pending-commands"
    12) "0"
    13) "last-ok-ping-reply"
    14) "423"
    15) "last-ping-reply"
    16) "423"
    17) "info-refresh"
    18) "6107"
    19) "num-slaves"
    20) "1"
    21) "num-other-sentinels"
    22) "2"
    23) "quorum"
    24) "2"
 
 

Returns:

sentinelGetMasterAddrByName

public List<String> sentinelGetMasterAddrByName(String masterName)

 redis 127.0.0.1:26381> sentinel get-master-addr-by-name mymaster
 1) "127.0.0.1"
 2) "6379"
 

Parameters:

masterName -

Returns:

two elements list of strings : host and port.

sentinelReset

public Long sentinelReset(String pattern)

 redis 127.0.0.1:26381> sentinel reset mymaster
 (integer) 1
 

Parameters:

pattern -

Returns:

sentinelSlaves

public List<Map<String,String>> sentinelSlaves(String masterName)

 redis 127.0.0.1:26381> sentinel slaves mymaster
 1)  1) "name"
     2) "127.0.0.1:6380"
     3) "ip"
     4) "127.0.0.1"
     5) "port"
     6) "6380"
     7) "runid"
     8) "d7f6c0ca7572df9d2f33713df0dbf8c72da7c039"
     9) "flags"
    10) "slave"
    11) "pending-commands"
    12) "0"
    13) "last-ok-ping-reply"
    14) "47"
    15) "last-ping-reply"
    16) "47"
    17) "info-refresh"
    18) "657"
    19) "master-link-down-time"
    20) "0"
    21) "master-link-status"
    22) "ok"
    23) "master-host"
    24) "localhost"
    25) "master-port"
    26) "6379"
    27) "slave-priority"
    28) "100"
 

Parameters:

masterName -

Returns:

dump

public byte[] dump(String key)

restore

public String restore(String key,
             int ttl,
             byte[] serializedValue)

pexpire

public Long pexpire(String key,
           int milliseconds)

pexpireAt

public Long pexpireAt(String key,
             long millisecondsTimestamp)

pttl

public Long pttl(String key)

incrByFloat

public Double incrByFloat(String key,
                 double increment)

psetex

public String psetex(String key,
            int milliseconds,
            String value)

set

public String set(String key,
         String value,
         String nxxx)

set

public String set(String key,
         String value,
         String nxxx,
         String expx,
         int time)

clientKill

public String clientKill(String client)

clientSetname

public String clientSetname(String name)

migrate

public String migrate(String host,
             int port,
             String key,
             int destinationDb,
             int timeout)

hincrByFloat

public Double hincrByFloat(String key,
                  String field,
                  double increment)

scan

public ScanResult<String> scan(int cursor)

Specified by:

scan in interface MultiKeyCommands

scan

public ScanResult<String> scan(int cursor,
                      ScanParams params)

hscan

public ScanResult<Map.Entry<String,String>> hscan(String key,
                                         int cursor)

Specified by:

hscan in interface JedisCommands

hscan

public ScanResult<Map.Entry<String,String>> hscan(String key,
                                         int cursor,
                                         ScanParams params)

sscan

public ScanResult<String> sscan(String key,
                       int cursor)

Specified by:

sscan in interface JedisCommands

sscan

public ScanResult<String> sscan(String key,
                       int cursor,
                       ScanParams params)

zscan

public ScanResult<Tuple> zscan(String key,
                      int cursor)

Specified by:

zscan in interface JedisCommands

zscan

public ScanResult<Tuple> zscan(String key,
                      int cursor,
                      ScanParams params)

clusterNodes

public String clusterNodes()

Specified by:

clusterNodes in interface ClusterCommands

clusterMeet

public String clusterMeet(String ip,
                 int port)

Specified by:

clusterMeet in interface ClusterCommands

clusterAddSlots

public String clusterAddSlots(int... slots)

Specified by:

clusterAddSlots in interface ClusterCommands

clusterDelSlots

public String clusterDelSlots(int... slots)

Specified by:

clusterDelSlots in interface ClusterCommands

clusterInfo

public String clusterInfo()

Specified by:

clusterInfo in interface ClusterCommands

clusterGetKeysInSlot

public List<String> clusterGetKeysInSlot(int slot,
                                int count)

Specified by:

clusterGetKeysInSlot in interface ClusterCommands

clusterSetSlotNode

public String clusterSetSlotNode(int slot,
                        String nodeId)

Specified by:

clusterSetSlotNode in interface ClusterCommands

clusterSetSlotMigrating

public String clusterSetSlotMigrating(int slot,
                             String nodeId)

Specified by:

clusterSetSlotMigrating in interface ClusterCommands

clusterSetSlotImporting

public String clusterSetSlotImporting(int slot,
                             String nodeId)

Specified by:

clusterSetSlotImporting in interface ClusterCommands

asking

public String asking()

pubsubChannels

public List<String> pubsubChannels(String pattern)

pubsubNumPat

public Long pubsubNumPat()

pubsubNumSub

public Map<String,String> pubsubNumSub(String... channels)