redis.clients.jedis.commands

Interface MultiKeyCommands

All Known Implementing Classes:

Jedis

public interface MultiKeyCommands

Method Summary

Modifier and Type	Method and Description
Long	bitop(BitOP op, String destKey, String... srcKeys)
String	blmove(String srcKey, String dstKey, ListDirection from, ListDirection to, double timeout)
KeyedListElement	blpop(double timeout, String... keys)
List<String>	blpop(int timeout, String... keys)
List<String>	blpop(String... args)
KeyedListElement	brpop(double timeout, String... keys)
List<String>	brpop(int timeout, String... keys)
List<String>	brpop(String... args)
String	brpoplpush(String source, String destination, int timeout)
KeyedZSetElement	bzpopmax(double timeout, String... keys)
KeyedZSetElement	bzpopmin(double timeout, String... keys)
Boolean	copy(String srcKey, String dstKey, boolean replace)
Boolean	copy(String srcKey, String dstKey, int db, boolean replace)
Long	del(String... keys)
Long	exists(String... keys)
Long	georadiusByMemberStore(String key, String member, double radius, GeoUnit unit, GeoRadiusParam param, GeoRadiusStoreParam storeParam)
Long	georadiusStore(String key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusParam param, GeoRadiusStoreParam storeParam)
Set<String>	keys(String pattern) Returns all the keys matching the glob-style pattern.
String	lmove(String srcKey, String dstKey, ListDirection from, ListDirection to)
List<String>	mget(String... keys)
String	mset(String... keysvalues)
Long	msetnx(String... keysvalues)
long	pfcount(String... keys)
String	pfmerge(String destkey, String... sourcekeys)
void	psubscribe(JedisPubSub jedisPubSub, String... patterns)
Long	publish(String channel, String message)
String	randomKey()
String	rename(String oldkey, String newkey)
Long	renamenx(String oldkey, String newkey)
String	rpoplpush(String srckey, String dstkey)
ScanResult<String>	scan(String cursor)
ScanResult<String>	scan(String cursor, ScanParams params) Iterates the set of keys in the currently selected Redis database.
ScanResult<String>	scan(String cursor, ScanParams params, String type)
Set<String>	sdiff(String... keys)
Long	sdiffstore(String dstkey, String... keys)
Set<String>	sinter(String... keys)
Long	sinterstore(String dstkey, String... keys)
Long	smove(String srckey, String dstkey, String member)
Long	sort(String key, SortingParams sortingParameters, String dstkey)
Long	sort(String key, String dstkey)
LCSMatchResult	strAlgoLCSKeys(String keyA, String keyB, StrAlgoLCSParams params)
void	subscribe(JedisPubSub jedisPubSub, String... channels)
Set<String>	sunion(String... keys)
Long	sunionstore(String dstkey, String... keys)
Long	touch(String... keys)
Long	unlink(String... keys)
String	unwatch()
String	watch(String... keys)
List<Map.Entry<String,List<StreamEntry>>>	xread(int count, long block, Map.Entry<String,StreamEntryID>... streams) Deprecated. This method will be removed due to bug regarding block param. Use xread(redis.clients.jedis.params.XReadParams, java.util.Map).
List<Map.Entry<String,List<StreamEntry>>>	xread(XReadParams xReadParams, Map<String,StreamEntryID> streams)
List<Map.Entry<String,List<StreamEntry>>>	xreadGroup(String groupname, String consumer, int count, long block, boolean noAck, Map.Entry<String,StreamEntryID>... streams) Deprecated. This method will be removed due to bug regarding block param. Use xreadGroup(java.lang.String, java.lang.String, redis.clients.jedis.params.XReadGroupParams, java.util.Map).
List<Map.Entry<String,List<StreamEntry>>>	xreadGroup(String groupname, String consumer, XReadGroupParams xReadGroupParams, Map<String,StreamEntryID> streams)
Set<String>	zdiff(String... keys)
Long	zdiffStore(String dstkey, String... keys)
Set<Tuple>	zdiffWithScores(String... keys)
Set<String>	zinter(ZParams params, String... keys)
Long	zinterstore(String dstkey, String... sets)
Long	zinterstore(String dstkey, ZParams params, String... sets)
Set<Tuple>	zinterWithScores(ZParams params, String... keys)
Set<String>	zunion(ZParams params, String... keys)
Long	zunionstore(String dstkey, String... sets)
Long	zunionstore(String dstkey, ZParams params, String... sets)
Set<Tuple>	zunionWithScores(ZParams params, String... keys)

Method Detail

copy

Boolean copy(String srcKey,
             String dstKey,
             int db,
             boolean replace)

copy

Boolean copy(String srcKey,
             String dstKey,
             boolean replace)

del

Long del(String... keys)

unlink

Long unlink(String... keys)

exists

Long exists(String... keys)

lmove

String lmove(String srcKey,
             String dstKey,
             ListDirection from,
             ListDirection to)

blmove

String blmove(String srcKey,
              String dstKey,
              ListDirection from,
              ListDirection to,
              double timeout)

blpop

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

blpop

KeyedListElement blpop(double timeout,
                       String... keys)

brpop

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

brpop

KeyedListElement brpop(double timeout,
                       String... keys)

blpop

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

brpop

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

bzpopmax

KeyedZSetElement bzpopmax(double timeout,
                          String... keys)

bzpopmin

KeyedZSetElement bzpopmin(double timeout,
                          String... keys)

keys

Set<String> keys(String pattern)

Returns all the keys matching the glob-style pattern. For example if you have in the database the keys "foo" and "foobar" the command "KEYS foo*" will return "foo foobar".
Warning: consider this as a command that should be used in production environments with extreme care. It may ruin performance when it is executed against large databases. This command is intended for debugging and special operations, such as changing your keyspace layout. Don't use it in your regular application code. If you're looking for a way to find keys in a subset of your keyspace, consider using scan(String, ScanParams) or sets.

While the time complexity for this operation is O(N), the constant times are fairly low. For example, Redis running on an entry level laptop can scan a 1 million key database in 40 milliseconds.

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)

Parameters:

pattern -

Returns:

Multi bulk reply

See Also:

Redis KEYS documentation

mget

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

mset

String mset(String... keysvalues)

msetnx

Long msetnx(String... keysvalues)

rename

String rename(String oldkey,
              String newkey)

renamenx

Long renamenx(String oldkey,
              String newkey)

rpoplpush

String rpoplpush(String srckey,
                 String dstkey)

sdiff

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

sdiffstore

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

sinter

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

sinterstore

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

smove

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

sort

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

sort

Long sort(String key,
          String dstkey)

sunion

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

sunionstore

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

watch

String watch(String... keys)

unwatch

String unwatch()

zdiff

Set<String> zdiff(String... keys)

zdiffWithScores

Set<Tuple> zdiffWithScores(String... keys)

zdiffStore

Long zdiffStore(String dstkey,
                String... keys)

zinterstore

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

zinterstore

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

zinter

Set<String> zinter(ZParams params,
                   String... keys)

zinterWithScores

Set<Tuple> zinterWithScores(ZParams params,
                            String... keys)

zunion

Set<String> zunion(ZParams params,
                   String... keys)

zunionWithScores

Set<Tuple> zunionWithScores(ZParams params,
                            String... keys)

zunionstore

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

zunionstore

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

brpoplpush

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

publish

Long publish(String channel,
             String message)

subscribe

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

psubscribe

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

randomKey

String randomKey()

bitop

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

scan

ScanResult<String> scan(String cursor)

Parameters:

cursor -

Returns:

result

See Also:

scan(String, ScanParams)

scan

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

Iterates the set of keys in the currently selected Redis database.

Since this command allows for incremental iteration, returning only a small number of elements per call, it can be used in production without the downside of commands like keys(String) or JedisCommands.smembers(String) )} that may block the server for a long time (even several seconds) when called against big collections of keys or elements.

SCAN basic usage
SCAN is a cursor based iterator. This means that at every call of the command, the server returns an updated cursor that the user needs to use as the cursor argument in the next call. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0.

Scan guarantees
The SCAN command, and the other commands in the SCAN family, are able to provide to the user a set of guarantees associated to full iterations.

• A full iteration always retrieves all the elements that were present in the collection from the start to the end of a full iteration. This means that if a given element is inside the collection when an iteration is started, and is still there when an iteration terminates, then at some point SCAN returned it to the user.
• A full iteration never returns any element that was NOT present in the collection from the start to the end of a full iteration. So if an element was removed before the start of an iteration, and is never added back to the collection for all the time an iteration lasts, SCAN ensures that this element will never be returned.

However because SCAN has very little state associated (just the cursor) it has the following drawbacks:

• A given element may be returned multiple times. It is up to the application to handle the case of duplicated elements, for example only using the returned elements in order to perform operations that are safe when re-applied multiple times.
• Elements that were not constantly present in the collection during a full iteration, may be returned or not: it is undefined.

Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the DB.

Parameters:

cursor - The cursor.

params - the scan parameters. For example a glob-style match pattern

Returns:

the scan result with the results of this iteration and the new position of the cursor

See Also:

Redis SCAN documentation

scan

ScanResult<String> scan(String cursor,
                        ScanParams params,
                        String type)

pfmerge

String pfmerge(String destkey,
               String... sourcekeys)

pfcount

long pfcount(String... keys)

touch

Long touch(String... keys)

xread

@Deprecated
List<Map.Entry<String,List<StreamEntry>>> xread(int count,
                                                            long block,
                                                            Map.Entry<String,StreamEntryID>... streams)

Deprecated. This method will be removed due to bug regarding block param. Use xread(redis.clients.jedis.params.XReadParams, java.util.Map).

XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]

Parameters:

count -

block -

streams -

Returns:

xread

List<Map.Entry<String,List<StreamEntry>>> xread(XReadParams xReadParams,
                                                Map<String,StreamEntryID> streams)

xreadGroup

@Deprecated
List<Map.Entry<String,List<StreamEntry>>> xreadGroup(String groupname,
                                                                 String consumer,
                                                                 int count,
                                                                 long block,
                                                                 boolean noAck,
                                                                 Map.Entry<String,StreamEntryID>... streams)

Deprecated. This method will be removed due to bug regarding block param. Use xreadGroup(java.lang.String, java.lang.String, redis.clients.jedis.params.XReadGroupParams, java.util.Map).

XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]

Parameters:

groupname -

consumer -

count -

block -

noAck -

streams -

Returns:

xreadGroup

List<Map.Entry<String,List<StreamEntry>>> xreadGroup(String groupname,
                                                     String consumer,
                                                     XReadGroupParams xReadGroupParams,
                                                     Map<String,StreamEntryID> streams)

georadiusStore

Long georadiusStore(String key,
                    double longitude,
                    double latitude,
                    double radius,
                    GeoUnit unit,
                    GeoRadiusParam param,
                    GeoRadiusStoreParam storeParam)

georadiusByMemberStore

Long georadiusByMemberStore(String key,
                            String member,
                            double radius,
                            GeoUnit unit,
                            GeoRadiusParam param,
                            GeoRadiusStoreParam storeParam)

strAlgoLCSKeys

LCSMatchResult strAlgoLCSKeys(String keyA,
                              String keyB,
                              StrAlgoLCSParams params)