Package redis.clients.jedis.commands

Interface JedisCommands

All Known Implementing Classes:

Jedis, ShardedJedis

public interface JedisCommands

Common interface for sharded and non-sharded Jedis

Method Summary

Modifier and Type	Method	Description
Long	append(String key, String value)
Long	bitcount(String key)
Long	bitcount(String key, long start, long end)
List<Long>	bitfield(String key, String... arguments)	Executes BITFIELD Redis command
List<Long>	bitfieldReadonly(String key, String... arguments)
Long	bitpos(String key, boolean value)
Long	bitpos(String key, boolean value, BitPosParams params)
List<String>	blpop(int timeout, String key)
List<String>	brpop(int timeout, String key)
Long	decr(String key)
Long	decrBy(String key, long decrement)
Long	del(String key)
byte[]	dump(String key)
String	echo(String string)
Boolean	exists(String key)
Long	expire(String key, int seconds)
Long	expireAt(String key, long unixTime)
Long	geoadd(String key, double longitude, double latitude, String member)
Long	geoadd(String key, Map<String,GeoCoordinate> memberCoordinateMap)
Double	geodist(String key, String member1, String member2)
Double	geodist(String key, String member1, String member2, GeoUnit unit)
List<String>	geohash(String key, String... members)
List<GeoCoordinate>	geopos(String key, String... members)
List<GeoRadiusResponse>	georadius(String key, double longitude, double latitude, double radius, GeoUnit unit)
List<GeoRadiusResponse>	georadius(String key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusParam param)
List<GeoRadiusResponse>	georadiusByMember(String key, String member, double radius, GeoUnit unit)
List<GeoRadiusResponse>	georadiusByMember(String key, String member, double radius, GeoUnit unit, GeoRadiusParam param)
List<GeoRadiusResponse>	georadiusByMemberReadonly(String key, String member, double radius, GeoUnit unit)
List<GeoRadiusResponse>	georadiusByMemberReadonly(String key, String member, double radius, GeoUnit unit, GeoRadiusParam param)
List<GeoRadiusResponse>	georadiusReadonly(String key, double longitude, double latitude, double radius, GeoUnit unit)
List<GeoRadiusResponse>	georadiusReadonly(String key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusParam param)
String	get(String key)
Boolean	getbit(String key, long offset)
String	getrange(String key, long startOffset, long endOffset)
String	getSet(String key, String value)
Long	hdel(String key, String... field)
Boolean	hexists(String key, String field)
String	hget(String key, String field)
Map<String,String>	hgetAll(String key)
Long	hincrBy(String key, String field, long value)
Double	hincrByFloat(String key, String field, double value)
Set<String>	hkeys(String key)
Long	hlen(String key)
List<String>	hmget(String key, String... fields)
String	hmset(String key, Map<String,String> hash)
ScanResult<Map.Entry<String,String>>	hscan(String key, String cursor)
ScanResult<Map.Entry<String,String>>	hscan(String key, String cursor, ScanParams params)
Long	hset(String key, String field, String value)
Long	hset(String key, Map<String,String> hash)
Long	hsetnx(String key, String field, String value)
Long	hstrlen(String key, String field)	Used for HSTRLEN Redis command
List<String>	hvals(String key)
Long	incr(String key)
Long	incrBy(String key, long increment)
Double	incrByFloat(String key, double increment)
String	lindex(String key, long index)
Long	linsert(String key, ListPosition where, String pivot, String value)
Long	llen(String key)
String	lpop(String key)
List<String>	lpop(String key, int count)
Long	lpos(String key, String element)
Long	lpos(String key, String element, LPosParams params)
List<Long>	lpos(String key, String element, LPosParams params, long count)
Long	lpush(String key, String... string)
Long	lpushx(String key, String... string)
List<String>	lrange(String key, long start, long stop)
Long	lrem(String key, long count, String value)
String	lset(String key, long index, String value)
String	ltrim(String key, long start, long stop)
Long	move(String key, int dbIndex)
Long	persist(String key)
Long	pexpire(String key, long milliseconds)
Long	pexpireAt(String key, long millisecondsTimestamp)
Long	pfadd(String key, String... elements)
long	pfcount(String key)
String	psetex(String key, long milliseconds, String value)
Long	pttl(String key)
String	restore(String key, int ttl, byte[] serializedValue)
String	restoreReplace(String key, int ttl, byte[] serializedValue)
String	rpop(String key)
List<String>	rpop(String key, int count)
Long	rpush(String key, String... string)
Long	rpushx(String key, String... string)
Long	sadd(String key, String... member)
Long	scard(String key)
String	set(String key, String value)
String	set(String key, String value, SetParams params)
Boolean	setbit(String key, long offset, boolean value)
Boolean	setbit(String key, long offset, String value)
String	setex(String key, int seconds, String value)
Long	setnx(String key, String value)
Long	setrange(String key, long offset, String value)
Boolean	sismember(String key, String member)
Set<String>	smembers(String key)
List<Boolean>	smismember(String key, String... members)
List<String>	sort(String key)
List<String>	sort(String key, SortingParams sortingParameters)
String	spop(String key)
Set<String>	spop(String key, long count)
String	srandmember(String key)
List<String>	srandmember(String key, int count)
Long	srem(String key, String... member)
ScanResult<String>	sscan(String key, String cursor)
ScanResult<String>	sscan(String key, String cursor, ScanParams params)
Long	strlen(String key)
String	substr(String key, int start, int end)
Long	touch(String key)
Long	ttl(String key)
String	type(String key)
Long	unlink(String key)
long	xack(String key, String group, StreamEntryID... ids)	XACK key group ID [ID ...]
StreamEntryID	xadd(String key, StreamEntryID id, Map<String,String> hash)	XADD key ID field string [field string ...]
StreamEntryID	xadd(String key, StreamEntryID id, Map<String,String> hash, long maxLen, boolean approximateLength)	XADD key MAXLEN ~ LEN ID field string [field string ...]
List<StreamEntry>	xclaim(String key, String group, String consumername, long minIdleTime, long newIdleTime, int retries, boolean force, StreamEntryID... ids)	XCLAIM [IDLE ] [TIME ] [RETRYCOUNT ] [FORCE] [JUSTID]
long	xdel(String key, StreamEntryID... ids)	XDEL key ID [ID ...]
String	xgroupCreate(String key, String groupname, StreamEntryID id, boolean makeStream)	XGROUP CREATE
Long	xgroupDelConsumer(String key, String groupname, String consumername)	XGROUP DELCONSUMER
long	xgroupDestroy(String key, String groupname)	XGROUP DESTROY
String	xgroupSetID(String key, String groupname, StreamEntryID id)	XGROUP SETID
List<StreamConsumersInfo>	xinfoConsumers(String key, String group)	Introspection command used in order to retrieve different information about consumers in the group
List<StreamGroupInfo>	xinfoGroup(String key)	Introspection command used in order to retrieve different information about groups in the stream
StreamInfo	xinfoStream(String key)	Introspection command used in order to retrieve different information about the stream
Long	xlen(String key)	XLEN key
List<StreamPendingEntry>	xpending(String key, String groupname, StreamEntryID start, StreamEntryID end, int count, String consumername)	XPENDING key group [start end count] [consumer]
List<StreamEntry>	xrange(String key, StreamEntryID start, StreamEntryID end, int count)	XRANGE key start end [COUNT count]
List<StreamEntry>	xrevrange(String key, StreamEntryID end, StreamEntryID start, int count)	XREVRANGE key end start [COUNT ]
long	xtrim(String key, long maxLen, boolean approximate)	XTRIM key MAXLEN [~] count
Long	zadd(String key, double score, String member)
Long	zadd(String key, double score, String member, ZAddParams params)
Long	zadd(String key, Map<String,Double> scoreMembers)
Long	zadd(String key, Map<String,Double> scoreMembers, ZAddParams params)
Long	zcard(String key)
Long	zcount(String key, double min, double max)
Long	zcount(String key, String min, String max)
Double	zincrby(String key, double increment, String member)
Double	zincrby(String key, double increment, String member, ZIncrByParams params)
Long	zlexcount(String key, String min, String max)
List<Double>	zmscore(String key, String... members)
Tuple	zpopmax(String key)
Set<Tuple>	zpopmax(String key, int count)
Tuple	zpopmin(String key)
Set<Tuple>	zpopmin(String key, int count)
Set<String>	zrange(String key, long start, long stop)
Set<String>	zrangeByLex(String key, String min, String max)
Set<String>	zrangeByLex(String key, String min, String max, int offset, int count)
Set<String>	zrangeByScore(String key, double min, double max)
Set<String>	zrangeByScore(String key, double min, double max, int offset, int count)
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)
Set<Tuple>	zrangeByScoreWithScores(String key, double min, double max, int offset, int count)
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 stop)
Long	zrank(String key, String member)
Long	zrem(String key, String... members)
Long	zremrangeByLex(String key, String min, String max)
Long	zremrangeByRank(String key, long start, long stop)
Long	zremrangeByScore(String key, double min, double max)
Long	zremrangeByScore(String key, String min, String max)
Set<String>	zrevrange(String key, long start, long stop)
Set<String>	zrevrangeByLex(String key, String max, String min)
Set<String>	zrevrangeByLex(String key, String max, String min, int offset, int count)
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 stop)
Long	zrevrank(String key, String member)
ScanResult<Tuple>	zscan(String key, String cursor)
ScanResult<Tuple>	zscan(String key, String cursor, ScanParams params)
Double	zscore(String key, String member)

Method Detail

set

String set(String key,
           String value)

set

String set(String key,
           String value,
           SetParams params)

get

String get(String key)

exists

Boolean exists(String key)

persist

Long persist(String key)

type

String type(String key)

dump

byte[] dump(String key)

restore

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

restoreReplace

String restoreReplace(String key,
                      int ttl,
                      byte[] serializedValue)

expire

Long expire(String key,
            int seconds)

pexpire

Long pexpire(String key,
             long milliseconds)

expireAt

Long expireAt(String key,
              long unixTime)

pexpireAt

Long pexpireAt(String key,
               long millisecondsTimestamp)

ttl

Long ttl(String key)

pttl

Long pttl(String key)

touch

Long touch(String key)

setbit

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

setbit

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

getbit

Boolean getbit(String key,
               long offset)

setrange

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

getrange

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

getSet

String getSet(String key,
              String value)

setnx

Long setnx(String key,
           String value)

setex

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

psetex

String psetex(String key,
              long milliseconds,
              String value)

decrBy

Long decrBy(String key,
            long decrement)

decr

Long decr(String key)

incrBy

Long incrBy(String key,
            long increment)

incrByFloat

Double incrByFloat(String key,
                   double increment)

incr

Long incr(String key)

append

Long append(String key,
            String value)

substr

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

hset

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

hset

Long hset(String key,
          Map<String,String> hash)

hget

String hget(String key,
            String field)

hsetnx

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

hmset

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

hmget

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

hincrBy

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

hincrByFloat

Double hincrByFloat(String key,
                    String field,
                    double value)

hexists

Boolean hexists(String key,
                String field)

hdel

Long hdel(String key,
          String... field)

hlen

Long hlen(String key)

hkeys

Set<String> hkeys(String key)

hvals

List<String> hvals(String key)

hgetAll

Map<String,String> hgetAll(String key)

rpush

Long rpush(String key,
           String... string)

lpush

Long lpush(String key,
           String... string)

llen

Long llen(String key)

lrange

List<String> lrange(String key,
                    long start,
                    long stop)

ltrim

String ltrim(String key,
             long start,
             long stop)

lindex

String lindex(String key,
              long index)

lset

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

lrem

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

lpop

String lpop(String key)

lpop

List<String> lpop(String key,
                  int count)

lpos

Long lpos(String key,
          String element)

lpos

Long lpos(String key,
          String element,
          LPosParams params)

lpos

List<Long> lpos(String key,
                String element,
                LPosParams params,
                long count)

rpop

String rpop(String key)

rpop

List<String> rpop(String key,
                  int count)

sadd

Long sadd(String key,
          String... member)

smembers

Set<String> smembers(String key)

srem

Long srem(String key,
          String... member)

spop

String spop(String key)

spop

Set<String> spop(String key,
                 long count)

scard

Long scard(String key)

sismember

Boolean sismember(String key,
                  String member)

smismember

List<Boolean> smismember(String key,
                         String... members)

srandmember

String srandmember(String key)

srandmember

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

strlen

Long strlen(String key)

zadd

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

zadd

Long zadd(String key,
          double score,
          String member,
          ZAddParams params)

zadd

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

zadd

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

zrange

Set<String> zrange(String key,
                   long start,
                   long stop)

zrem

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

zincrby

Double zincrby(String key,
               double increment,
               String member)

zincrby

Double zincrby(String key,
               double increment,
               String member,
               ZIncrByParams params)

zrank

Long zrank(String key,
           String member)

zrevrank

Long zrevrank(String key,
              String member)

zrevrange

Set<String> zrevrange(String key,
                      long start,
                      long stop)

zrangeWithScores

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

zrevrangeWithScores

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

zcard

Long zcard(String key)

zscore

Double zscore(String key,
              String member)

zmscore

List<Double> zmscore(String key,
                     String... members)

zpopmax

Tuple zpopmax(String key)

zpopmax

Set<Tuple> zpopmax(String key,
                   int count)

zpopmin

Tuple zpopmin(String key)

zpopmin

Set<Tuple> zpopmin(String key,
                   int count)

sort

List<String> sort(String key)

sort

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

zcount

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

zcount

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

zrangeByScore

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

zrangeByScore

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

zrevrangeByScore

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

zrangeByScore

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

zrevrangeByScore

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

zrangeByScore

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

zrevrangeByScore

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

zrangeByScoreWithScores

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

zrevrangeByScoreWithScores

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

zrangeByScoreWithScores

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

zrevrangeByScore

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

zrangeByScoreWithScores

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

zrevrangeByScoreWithScores

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

zrangeByScoreWithScores

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

zrevrangeByScoreWithScores

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

zrevrangeByScoreWithScores

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

zremrangeByRank

Long zremrangeByRank(String key,
                     long start,
                     long stop)

zremrangeByScore

Long zremrangeByScore(String key,
                      double min,
                      double max)

zremrangeByScore

Long zremrangeByScore(String key,
                      String min,
                      String max)

zlexcount

Long zlexcount(String key,
               String min,
               String max)

zrangeByLex

Set<String> zrangeByLex(String key,
                        String min,
                        String max)

zrangeByLex

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

zrevrangeByLex

Set<String> zrevrangeByLex(String key,
                           String max,
                           String min)

zrevrangeByLex

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

zremrangeByLex

Long zremrangeByLex(String key,
                    String min,
                    String max)

linsert

Long linsert(String key,
             ListPosition where,
             String pivot,
             String value)

lpushx

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

rpushx

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

blpop

List<String> blpop(int timeout,
                   String key)

brpop

List<String> brpop(int timeout,
                   String key)

del

Long del(String key)

unlink

Long unlink(String key)

echo

String echo(String string)

move

Long move(String key,
          int dbIndex)

bitcount

Long bitcount(String key)

bitcount

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

bitpos

Long bitpos(String key,
            boolean value)

bitpos

Long bitpos(String key,
            boolean value,
            BitPosParams params)

hscan

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

hscan

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

sscan

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

zscan

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

zscan

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

sscan

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

pfadd

Long pfadd(String key,
           String... elements)

pfcount

long pfcount(String key)

geoadd

Long geoadd(String key,
            double longitude,
            double latitude,
            String member)

geoadd

Long geoadd(String key,
            Map<String,GeoCoordinate> memberCoordinateMap)

geodist

Double geodist(String key,
               String member1,
               String member2)

geodist

Double geodist(String key,
               String member1,
               String member2,
               GeoUnit unit)

geohash

List<String> geohash(String key,
                     String... members)

geopos

List<GeoCoordinate> geopos(String key,
                           String... members)

georadius

List<GeoRadiusResponse> georadius(String key,
                                  double longitude,
                                  double latitude,
                                  double radius,
                                  GeoUnit unit)

georadiusReadonly

List<GeoRadiusResponse> georadiusReadonly(String key,
                                          double longitude,
                                          double latitude,
                                          double radius,
                                          GeoUnit unit)

georadius

List<GeoRadiusResponse> georadius(String key,
                                  double longitude,
                                  double latitude,
                                  double radius,
                                  GeoUnit unit,
                                  GeoRadiusParam param)

georadiusReadonly

List<GeoRadiusResponse> georadiusReadonly(String key,
                                          double longitude,
                                          double latitude,
                                          double radius,
                                          GeoUnit unit,
                                          GeoRadiusParam param)

georadiusByMember

List<GeoRadiusResponse> georadiusByMember(String key,
                                          String member,
                                          double radius,
                                          GeoUnit unit)

georadiusByMemberReadonly

List<GeoRadiusResponse> georadiusByMemberReadonly(String key,
                                                  String member,
                                                  double radius,
                                                  GeoUnit unit)

georadiusByMember

List<GeoRadiusResponse> georadiusByMember(String key,
                                          String member,
                                          double radius,
                                          GeoUnit unit,
                                          GeoRadiusParam param)

georadiusByMemberReadonly

List<GeoRadiusResponse> georadiusByMemberReadonly(String key,
                                                  String member,
                                                  double radius,
                                                  GeoUnit unit,
                                                  GeoRadiusParam param)

bitfield

List<Long> bitfield(String key,
                    String... arguments)

Executes BITFIELD Redis command

Parameters:

key -

arguments -

Returns:

bitfieldReadonly

List<Long> bitfieldReadonly(String key,
                            String... arguments)

hstrlen

Long hstrlen(String key,
             String field)

Used for HSTRLEN Redis command

Parameters:

key -

field -

Returns:

length of the value for key

xadd

StreamEntryID xadd(String key,
                   StreamEntryID id,
                   Map<String,String> hash)

XADD key ID field string [field string ...]

Parameters:

key -

id -

hash -

Returns:

the ID of the added entry

xadd

StreamEntryID xadd(String key,
                   StreamEntryID id,
                   Map<String,String> hash,
                   long maxLen,
                   boolean approximateLength)

XADD key MAXLEN ~ LEN ID field string [field string ...]

Parameters:

key -

id -

hash -

maxLen -

approximateLength -

Returns:

xlen

Long xlen(String key)

XLEN key

Parameters:

key -

Returns:

xrange

List<StreamEntry> xrange(String key,
                         StreamEntryID start,
                         StreamEntryID end,
                         int count)

XRANGE key start end [COUNT count]

Parameters:

key -

start - minimum StreamEntryID for the retrieved range, passing null will indicate minimum ID possible in the stream

end - maximum StreamEntryID for the retrieved range, passing null will indicate maximum ID possible in the stream

count - maximum number of entries returned

Returns:

The entries with IDs matching the specified range.

xrevrange

List<StreamEntry> xrevrange(String key,
                            StreamEntryID end,
                            StreamEntryID start,
                            int count)

XREVRANGE key end start [COUNT ]

Parameters:

key -

start - minimum StreamEntryID for the retrieved range, passing null will indicate minimum ID possible in the stream

end - maximum StreamEntryID for the retrieved range, passing null will indicate maximum ID possible in the stream

count - The entries with IDs matching the specified range.

Returns:

the entries with IDs matching the specified range, from the higher ID to the lower ID matching.

xack

long xack(String key,
          String group,
          StreamEntryID... ids)

XACK key group ID [ID ...]

Parameters:

key -

group -

ids -

Returns:

xgroupCreate

String xgroupCreate(String key,
                    String groupname,
                    StreamEntryID id,
                    boolean makeStream)

XGROUP CREATE

Parameters:

key -

groupname -

id -

makeStream -

Returns:

xgroupSetID

String xgroupSetID(String key,
                   String groupname,
                   StreamEntryID id)

XGROUP SETID

Parameters:

key -

groupname -

id -

Returns:

xgroupDestroy

long xgroupDestroy(String key,
                   String groupname)

XGROUP DESTROY

Parameters:

key -

groupname -

Returns:

xgroupDelConsumer

Long xgroupDelConsumer(String key,
                       String groupname,
                       String consumername)

XGROUP DELCONSUMER

Parameters:

key -

groupname -

consumername -

Returns:

xpending

List<StreamPendingEntry> xpending(String key,
                                  String groupname,
                                  StreamEntryID start,
                                  StreamEntryID end,
                                  int count,
                                  String consumername)

XPENDING key group [start end count] [consumer]

Parameters:

key -

groupname -

start -

end -

count -

consumername -

Returns:

xdel

long xdel(String key,
          StreamEntryID... ids)

XDEL key ID [ID ...]

Parameters:

key -

ids -

Returns:

xtrim

long xtrim(String key,
           long maxLen,
           boolean approximate)

XTRIM key MAXLEN [~] count

Parameters:

key -

maxLen -

approximate -

Returns:

xclaim

List<StreamEntry> xclaim(String key,
                         String group,
                         String consumername,
                         long minIdleTime,
                         long newIdleTime,
                         int retries,
                         boolean force,
                         StreamEntryID... ids)

XCLAIM [IDLE ] [TIME ] [RETRYCOUNT ] [FORCE] [JUSTID]

xinfoStream

StreamInfo xinfoStream(String key)

Introspection command used in order to retrieve different information about the stream

Parameters:

key - Stream name

Returns:

StreamInfo that contains information about the stream

xinfoGroup

List<StreamGroupInfo> xinfoGroup(String key)

Introspection command used in order to retrieve different information about groups in the stream

Parameters:

key - Stream name

Returns:

List of StreamGroupInfo containing information about groups

xinfoConsumers

List<StreamConsumersInfo> xinfoConsumers(String key,
                                         String group)

Introspection command used in order to retrieve different information about consumers in the group

Parameters:

key - Stream name

group - Group name

Returns:

List of StreamConsumersInfo containing information about consumers that belong to the the group