io.valkey.commands

Interface StreamPipelineCommands

All Known Subinterfaces:

PipelineCommands

All Known Implementing Classes:

AbstractPipeline, AbstractTransaction, ClusterPipeline, MultiClusterPipeline, MultiClusterTransaction, MultiNodePipelineBase, Pipeline, PipelineBase, PipeliningBase, ReliableTransaction, ShardedPipeline, Transaction, TransactionBase

public interface StreamPipelineCommands

Method Summary

Modifier and Type	Method and Description
Response<Long>	xack(String key, String group, StreamEntryID... ids) XACK key group ID [ID ...]
default Response<StreamEntryID>	xadd(String key, Map<String,String> hash, XAddParams params) XADD key [NOMKSTREAM] [MAXLEN|MINID [=|~] threshold [LIMIT count]] *|ID field value [field value ...]
Response<StreamEntryID>	xadd(String key, StreamEntryID id, Map<String,String> hash) XADD key ID field string [field string ...]
Response<StreamEntryID>	xadd(String key, XAddParams params, Map<String,String> hash)
Response<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]
Response<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
Response<List<StreamEntry>>	xclaim(String key, String group, String consumerName, long minIdleTime, XClaimParams params, StreamEntryID... ids) {@code XCLAIM key group consumer min-idle-time ...
Response<List<StreamEntryID>>	xclaimJustId(String key, String group, String consumerName, long minIdleTime, XClaimParams params, StreamEntryID... ids) {@code XCLAIM key group consumer min-idle-time ...
Response<Long>	xdel(String key, StreamEntryID... ids) XDEL key ID [ID ...]
Response<String>	xgroupCreate(String key, String groupName, StreamEntryID id, boolean makeStream) XGROUP CREATE key groupName <id or $>
Response<Boolean>	xgroupCreateConsumer(String key, String groupName, String consumerName) XGROUP CREATECONSUMER key groupName consumerName
Response<Long>	xgroupDelConsumer(String key, String groupName, String consumerName) XGROUP DELCONSUMER key groupName consumerName
Response<Long>	xgroupDestroy(String key, String groupName) XGROUP DESTROY key groupName
Response<String>	xgroupSetID(String key, String groupName, StreamEntryID id) XGROUP SETID key groupName <id or $>
Response<List<StreamConsumersInfo>>	xinfoConsumers(String key, String group) Deprecated. Use xinfoConsumers2(java.lang.String, java.lang.String).
Response<List<StreamConsumerInfo>>	xinfoConsumers2(String key, String group) Introspection command used in order to retrieve different information about consumers in the group
Response<List<StreamGroupInfo>>	xinfoGroups(String key) Introspection command used in order to retrieve different information about groups in the stream
Response<StreamInfo>	xinfoStream(String key) Introspection command used in order to retrieve different information about the stream
Response<StreamFullInfo>	xinfoStreamFull(String key) Introspection command used in order to retrieve all information about the stream
Response<StreamFullInfo>	xinfoStreamFull(String key, int count) Introspection command used in order to retrieve all information about the stream
Response<Long>	xlen(String key) XLEN key
Response<StreamPendingSummary>	xpending(String key, String groupName) XPENDING key group
Response<List<StreamPendingEntry>>	xpending(String key, String groupName, XPendingParams params) XPENDING key group [[IDLE min-idle-time] start end count [consumer]]
Response<List<StreamEntry>>	xrange(String key, StreamEntryID start, StreamEntryID end) XRANGE key start end
Response<List<StreamEntry>>	xrange(String key, StreamEntryID start, StreamEntryID end, int count) XRANGE key start end COUNT count
Response<List<StreamEntry>>	xrange(String key, String start, String end)
Response<List<StreamEntry>>	xrange(String key, String start, String end, int count)
Response<List<Map.Entry<String,List<StreamEntry>>>>	xread(XReadParams xReadParams, Map<String,StreamEntryID> streams) XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]
Response<Map<String,List<StreamEntry>>>	xreadAsMap(XReadParams xReadParams, Map<String,StreamEntryID> streams) XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]
Response<List<Map.Entry<String,List<StreamEntry>>>>	xreadGroup(String groupName, String consumer, XReadGroupParams xReadGroupParams, Map<String,StreamEntryID> streams) XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]
Response<Map<String,List<StreamEntry>>>	xreadGroupAsMap(String groupName, String consumer, XReadGroupParams xReadGroupParams, Map<String,StreamEntryID> streams) XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]
Response<List<StreamEntry>>	xrevrange(String key, StreamEntryID end, StreamEntryID start) XREVRANGE key end start
Response<List<StreamEntry>>	xrevrange(String key, StreamEntryID end, StreamEntryID start, int count) XREVRANGE key end start COUNT count
Response<List<StreamEntry>>	xrevrange(String key, String end, String start)
Response<List<StreamEntry>>	xrevrange(String key, String end, String start, int count)
Response<Long>	xtrim(String key, long maxLen, boolean approximate) XTRIM key MAXLEN [~] count
Response<Long>	xtrim(String key, XTrimParams params) XTRIM key MAXLEN|MINID [=|~] threshold [LIMIT count]

Method Detail

xadd

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

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

Returns:

the ID of the added entry

xadd

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

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

Returns:

the ID of the added entry

xadd

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

xlen

Response<Long> xlen(String key)

XLEN key

Returns:

length of stream

xrange

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

XRANGE key start end

Parameters:

key - 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

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

XRANGE key start end COUNT count

Parameters:

key - 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

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

XREVRANGE key end start

Parameters:

key - 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

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

XREVRANGE key end start COUNT count

Parameters:

key - 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

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

xrange

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

xrevrange

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

xrevrange

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

xack

Response<Long> xack(String key,
                    String group,
                    StreamEntryID... ids)

XACK key group ID [ID ...]

xgroupCreate

Response<String> xgroupCreate(String key,
                              String groupName,
                              StreamEntryID id,
                              boolean makeStream)

XGROUP CREATE key groupName <id or $>

xgroupSetID

Response<String> xgroupSetID(String key,
                             String groupName,
                             StreamEntryID id)

XGROUP SETID key groupName <id or $>

xgroupDestroy

Response<Long> xgroupDestroy(String key,
                             String groupName)

XGROUP DESTROY key groupName

xgroupCreateConsumer

Response<Boolean> xgroupCreateConsumer(String key,
                                       String groupName,
                                       String consumerName)

XGROUP CREATECONSUMER key groupName consumerName

xgroupDelConsumer

Response<Long> xgroupDelConsumer(String key,
                                 String groupName,
                                 String consumerName)

XGROUP DELCONSUMER key groupName consumerName

xpending

Response<StreamPendingSummary> xpending(String key,
                                        String groupName)

XPENDING key group

xpending

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

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

xdel

Response<Long> xdel(String key,
                    StreamEntryID... ids)

XDEL key ID [ID ...]

xtrim

Response<Long> xtrim(String key,
                     long maxLen,
                     boolean approximate)

XTRIM key MAXLEN [~] count

xtrim

Response<Long> xtrim(String key,
                     XTrimParams params)

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

xclaim

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

XCLAIM key group consumer min-idle-time <ID-1> ... <ID-N> [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>] [FORCE]

xclaimJustId

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

XCLAIM key group consumer min-idle-time <ID-1> ... <ID-N> [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>] [FORCE] JUSTID

xautoclaim

Response<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

Response<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

Response<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

Response<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

Response<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

xinfoGroups

Response<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

@Deprecated
Response<List<StreamConsumersInfo>> xinfoConsumers(String key,
                                                               String group)

Deprecated. Use xinfoConsumers2(java.lang.String, java.lang.String).

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 group

xinfoConsumers2

Response<List<StreamConsumerInfo>> xinfoConsumers2(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 StreamConsumerInfo containing information about consumers that belong to the group

xread

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

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

xreadAsMap

Response<Map<String,List<StreamEntry>>> xreadAsMap(XReadParams xReadParams,
                                                   Map<String,StreamEntryID> streams)

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

xreadGroup

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

XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]

xreadGroupAsMap

Response<Map<String,List<StreamEntry>>> xreadGroupAsMap(String groupName,
                                                        String consumer,
                                                        XReadGroupParams xReadGroupParams,
                                                        Map<String,StreamEntryID> streams)

XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]