redis.clients.jedis.commands

Interface StreamCommands

All Known Subinterfaces:

JedisCommands

All Known Implementing Classes:

Jedis, JedisCluster, JedisPooled, JedisSharding, UnifiedJedis

public interface StreamCommands

Method Summary

Modifier and Type	Method and Description
long	xack(String key, String group, StreamEntryID... ids) XACK key group ID [ID ...]
default StreamEntryID	xadd(String key, Map<String,String> hash, XAddParams params) XADD key [NOMKSTREAM] [MAXLEN|MINID [=|~] threshold [LIMIT count]] *|ID field value [field value ...]
StreamEntryID	xadd(String key, StreamEntryID id, Map<String,String> hash) XADD key ID field string [field string ...]
StreamEntryID	xadd(String key, XAddParams params, Map<String,String> hash)
Map.Entry<StreamEntryID,List<StreamEntry>>	xautoclaim(String key, String group, String consumerName, long minIdleTime, StreamEntryID start, XAutoClaimParams params) XAUTOCLAIM key group consumer min-idle-time start [COUNT count]
Map.Entry<StreamEntryID,List<StreamEntryID>>	xautoclaimJustId(String key, String group, String consumerName, long minIdleTime, StreamEntryID start, XAutoClaimParams params) XAUTOCLAIM key group consumer min-idle-time start [COUNT count] JUSTID
List<StreamEntry>	xclaim(String key, String group, String consumerName, long minIdleTime, XClaimParams params, StreamEntryID... ids) XCLAIM ...
List<StreamEntryID>	xclaimJustId(String key, String group, String consumerName, long minIdleTime, XClaimParams params, StreamEntryID... ids) XCLAIM ...
long	xdel(String key, StreamEntryID... ids) XDEL key ID [ID ...]
String	xgroupCreate(String key, String groupName, StreamEntryID id, boolean makeStream) XGROUP CREATE
boolean	xgroupCreateConsumer(String key, String groupName, String consumerName) XGROUP CREATECONSUMER
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) Deprecated. Use xinfoGroups(java.lang.String).
List<StreamGroupInfo>	xinfoGroups(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
StreamFullInfo	xinfoStreamFull(String key) Introspection command used in order to retrieve all information about the stream
StreamFullInfo	xinfoStreamFull(String key, int count) Introspection command used in order to retrieve all information about the stream
long	xlen(String key) XLEN key
StreamPendingSummary	xpending(String key, String groupName) XPENDING key group
List<StreamPendingEntry>	xpending(String key, String groupName, StreamEntryID start, StreamEntryID end, int count, String consumerName) Deprecated. Use xpending(java.lang.String, java.lang.String, redis.clients.jedis.params.XPendingParams).
List<StreamPendingEntry>	xpending(String key, String groupName, XPendingParams params) XPENDING key group [[IDLE min-idle-time] start end count [consumer]]
List<StreamEntry>	xrange(String key, StreamEntryID start, StreamEntryID end) XRANGE key start end
List<StreamEntry>	xrange(String key, StreamEntryID start, StreamEntryID end, int count) XRANGE key start end COUNT count
List<StreamEntry>	xrange(String key, String start, String end)
List<StreamEntry>	xrange(String key, String start, String end, int count)
List<Map.Entry<String,List<StreamEntry>>>	xread(XReadParams xReadParams, Map<String,StreamEntryID> streams) XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]
List<Map.Entry<String,List<StreamEntry>>>	xreadGroup(String groupName, String consumer, XReadGroupParams xReadGroupParams, Map<String,StreamEntryID> streams) XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]
List<StreamEntry>	xrevrange(String key, StreamEntryID end, StreamEntryID start) XREVRANGE key end start
List<StreamEntry>	xrevrange(String key, StreamEntryID end, StreamEntryID start, int count) XREVRANGE key end start COUNT count
List<StreamEntry>	xrevrange(String key, String end, String start)
List<StreamEntry>	xrevrange(String key, String end, String start, int count)
long	xtrim(String key, long maxLen, boolean approximate) XTRIM key MAXLEN [~] count
long	xtrim(String key, XTrimParams params) XTRIM key MAXLEN|MINID [=|~] threshold [LIMIT count]

Method Detail

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

default StreamEntryID xadd(String key,
                           Map<String,String> hash,
                           XAddParams params)

XADD key [NOMKSTREAM] [MAXLEN|MINID [=|~] threshold [LIMIT count]] *|ID field value [field value ...]

Parameters:

key -

hash -

params -

Returns:

the ID of the added entry

xadd

StreamEntryID xadd(String key,
                   XAddParams params,
                   Map<String,String> hash)

xlen

long xlen(String key)

XLEN key

Parameters:

key -

Returns:

length of stream

xrange

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

XRANGE key start end

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

Returns:

The entries with IDs matching the specified range.

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)

XREVRANGE key end start

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

Returns:

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

xrevrange

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

XREVRANGE key end start 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 - 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.

xrange

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

xrange

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

xrevrange

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

xrevrange

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

xack

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

XACK key group ID [ID ...]

Parameters:

key -

group -

ids -

xgroupCreate

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

XGROUP CREATE

Parameters:

key -

groupName -

id -

makeStream -

xgroupSetID

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

XGROUP SETID

Parameters:

key -

groupName -

id -

xgroupDestroy

long xgroupDestroy(String key,
                   String groupName)

XGROUP DESTROY

Parameters:

key -

groupName -

xgroupCreateConsumer

boolean xgroupCreateConsumer(String key,
                             String groupName,
                             String consumerName)

XGROUP CREATECONSUMER

Parameters:

key -

groupName -

consumerName -

xgroupDelConsumer

long xgroupDelConsumer(String key,
                       String groupName,
                       String consumerName)

XGROUP DELCONSUMER

Parameters:

key -

groupName -

consumerName -

xpending

StreamPendingSummary xpending(String key,
                              String groupName)

XPENDING key group

Parameters:

key -

groupName -

xpending

@Deprecated
List<StreamPendingEntry> xpending(String key,
                                              String groupName,
                                              StreamEntryID start,
                                              StreamEntryID end,
                                              int count,
                                              String consumerName)

Deprecated. Use xpending(java.lang.String, java.lang.String, redis.clients.jedis.params.XPendingParams).

XPENDING key group [start end count] [consumer]

Parameters:

key -

groupName -

start -

end -

count -

consumerName -

xpending

List<StreamPendingEntry> xpending(String key,
                                  String groupName,
                                  XPendingParams params)

XPENDING key group [[IDLE min-idle-time] start end count [consumer]]

Parameters:

key -

groupName -

params -

xdel

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

XDEL key ID [ID ...]

Parameters:

key -

ids -

xtrim

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

XTRIM key MAXLEN [~] count

Parameters:

key -

maxLen -

approximate -

xtrim

long xtrim(String key,
           XTrimParams params)

XTRIM key MAXLEN|MINID [=|~] threshold [LIMIT count]

Parameters:

key -

params -

xclaim

List<StreamEntry> xclaim(String key,
                         String group,
                         String consumerName,
                         long minIdleTime,
                         XClaimParams params,
                         StreamEntryID... ids)

XCLAIM ... [IDLE ] [TIME ] [RETRYCOUNT ] [FORCE]

xclaimJustId

List<StreamEntryID> xclaimJustId(String key,
                                 String group,
                                 String consumerName,
                                 long minIdleTime,
                                 XClaimParams params,
                                 StreamEntryID... ids)

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

xautoclaim

Map.Entry<StreamEntryID,List<StreamEntry>> xautoclaim(String key,
                                                      String group,
                                                      String consumerName,
                                                      long minIdleTime,
                                                      StreamEntryID start,
                                                      XAutoClaimParams params)

XAUTOCLAIM key group consumer min-idle-time start [COUNT count]

Parameters:

key - Stream Key

group - Consumer Group

consumerName - Consumer name to transfer the auto claimed entries

minIdleTime - Entries pending more than minIdleTime will be transferred ownership

start - StreamEntryID - Entries >= start will be transferred ownership, passing null will indicate '-'

params - XAutoClaimParams

xautoclaimJustId

Map.Entry<StreamEntryID,List<StreamEntryID>> xautoclaimJustId(String key,
                                                              String group,
                                                              String consumerName,
                                                              long minIdleTime,
                                                              StreamEntryID start,
                                                              XAutoClaimParams params)

XAUTOCLAIM key group consumer min-idle-time start [COUNT count] JUSTID

Parameters:

key - Stream Key

group - Consumer Group

consumerName - Consumer name to transfer the auto claimed entries

minIdleTime - Entries pending more than minIdleTime will be transferred ownership

start - StreamEntryID - Entries >= start will be transferred ownership, passing null will indicate '-'

params - XAutoClaimParams

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

xinfoStreamFull

StreamFullInfo xinfoStreamFull(String key)

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

Parameters:

key - Stream name

Returns:

StreamFullInfo that contains information about the stream

xinfoStreamFull

StreamFullInfo xinfoStreamFull(String key,
                               int count)

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

Parameters:

key - Stream name

count - stream info count

Returns:

StreamFullInfo that contains information about the stream

xinfoGroup

@Deprecated
List<StreamGroupInfo> xinfoGroup(String key)

Deprecated. Use xinfoGroups(java.lang.String).

xinfoGroups

List<StreamGroupInfo> xinfoGroups(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

xread

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

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

Parameters:

xReadParams -

streams -

xreadGroup

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

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

Parameters:

groupName -

consumer -

xReadGroupParams -

streams -