Interface TransactionalStreamCommands<K,F,V>
-
- Type Parameters:
K
- the type of the keys, oftenString
F
- the key type of the messages, generallyString
V
- the value type of the messages
- All Superinterfaces:
TransactionalRedisCommands
- All Known Implementing Classes:
BlockingTransactionalStreamCommandsImpl
public interface TransactionalStreamCommands<K,F,V> extends TransactionalRedisCommands
Allows executing commands manipulating streams. See the stream command list for further information about these commands.The messages are represented as
Map<F, V>
. This API is intended to be used in a Redis transaction (MULTI
), thus, all command methods returnvoid
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
xack(K key, String group, String... ids)
Execute the command XACK.void
xadd(K key, XAddArgs args, Map<F,V> payload)
Execute the command XADD.void
xadd(K key, Map<F,V> payload)
Execute the command XADD.void
xautoclaim(K key, String group, String consumer, Duration minIdleTime, String start)
Execute the command XAUTOCLAIM.void
xautoclaim(K key, String group, String consumer, Duration minIdleTime, String start, int count)
Execute the command XAUTOCLAIM.void
xautoclaim(K key, String group, String consumer, Duration minIdleTime, String start, int count, boolean justId)
Execute the command XAUTOCLAIM.void
xclaim(K key, String group, String consumer, Duration minIdleTime, XClaimArgs args, String... id)
Execute the command XCLAIM.void
xclaim(K key, String group, String consumer, Duration minIdleTime, String... id)
Execute the command XCLAIM.void
xdel(K key, String... id)
Execute the command XDEL.void
xgroupCreate(K key, String groupname, String from)
Execute the command XGROUP CREATE.void
xgroupCreate(K key, String groupname, String from, XGroupCreateArgs args)
Execute the command XGROUP CREATE.void
xgroupCreateConsumer(K key, String groupname, String consumername)
Execute the command XGROUP CREATECONSUMER.void
xgroupDelConsumer(K key, String groupname, String consumername)
Execute the command XGROUP DELCONSUMER.void
xgroupDestroy(K key, String groupname)
Execute the command XGROUP DESTROY.void
xgroupSetId(K key, String groupname, String from)
Execute the command XGROUP SETID.void
xgroupSetId(K key, String groupname, String from, XGroupSetIdArgs args)
Execute the command XGROUP SETID.void
xlen(K key)
Execute the command XLEN.void
xrange(K key, StreamRange range)
Execute the command XRANGE.void
xrange(K key, StreamRange range, int count)
Execute the command XRANGE.void
xread(Map<K,String> lastIdsPerStream)
Execute the command XREAD.void
xread(Map<K,String> lastIdsPerStream, XReadArgs args)
Execute the command XREAD.void
xread(K key, String id)
Execute the command XREAD.void
xread(K key, String id, XReadArgs args)
Execute the command XREAD.void
xreadgroup(String group, String consumer, Map<K,String> lastIdsPerStream)
Execute the command XREADGROUP.void
xreadgroup(String group, String consumer, Map<K,String> lastIdsPerStream, XReadGroupArgs args)
Execute the command XREADGROUP.void
xreadgroup(String group, String consumer, K key, String id)
Execute the command XREADGROUP.void
xreadgroup(String group, String consumer, K key, String id, XReadGroupArgs args)
Execute the command XREADGROUP.void
xrevrange(K key, StreamRange range)
Execute the command XRANGE.void
xrevrange(K key, StreamRange range, int count)
Execute the command XREVRANGE.void
xtrim(K key, XTrimArgs args)
Execute the command XTRIM.void
xtrim(K key, String threshold)
Execute the command XTRIM.-
Methods inherited from interface io.quarkus.redis.datasource.TransactionalRedisCommands
getDataSource
-
-
-
-
Method Detail
-
xack
void xack(K key, String group, String... ids)
Execute the command XACK. Summary: Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL.The
XACK
command removes one or multiple messages from the Pending Entries List (PEL) of a stream consumer group. A message is pending, and as such stored inside the PEL, when it was delivered to some consumer, normally as a side effect of callingXREADGROUP
, or when a consumer took ownership of a message callingXCLAIM
. The pending message was delivered to some consumer but the server is yet not sure it was processed at least once. So new calls toXREADGROUP
to grab the messages history for a consumer (for instance using an ID of 0), will return such message. Similarly, the pending message will be listed by theXPENDING
command, that inspects the PEL.Once a consumer successfully processes a message, it should call
XACK
so that such message does not get processed again, and as a side effect, the PEL entry about this message is also purged, releasing memory from the Redis server.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- the keygroup
- the name of the consumer groupids
- the message ids to acknowledge
-
xadd
void xadd(K key, Map<F,V> payload)
Execute the command XADD. Summary: Appends the specified stream entry to the stream at the specified key. If the key does not exist, as a side effect of running this command the key is created with a stream value. The creation of stream's key can be disabled with theNOMKSTREAM
option.An entry is composed of a list of field-value pairs. The field-value pairs are stored in the same order they are given by the user. Commands that read the stream, such as
XRANGE
orXREAD
, are guaranteed to return the fields and values exactly in the same order they were added byXADD
.XADD
is the only Redis command that can add data to a stream, but there are other commands, such asXDEL
andXTRIM
, that are able to remove data from a stream.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- the keypayload
- the payload to write to the stream, must not benull
-
xadd
void xadd(K key, XAddArgs args, Map<F,V> payload)
Execute the command XADD. Summary: Appends the specified stream entry to the stream at the specified key. If the key does not exist, as a side effect of running this command the key is created with a stream value. The creation of stream's key can be disabled with theNOMKSTREAM
option.An entry is composed of a list of field-value pairs. The field-value pairs are stored in the same order they are given by the user. Commands that read the stream, such as
XRANGE
orXREAD
, are guaranteed to return the fields and values exactly in the same order they were added byXADD
.XADD
is the only Redis command that can add data to a stream, but there are other commands, such asXDEL
andXTRIM
, that are able to remove data from a stream.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- the keyargs
- the extra parameterspayload
- the payload to write to the stream, must not benull
-
xautoclaim
void xautoclaim(K key, String group, String consumer, Duration minIdleTime, String start)
Execute the command XAUTOCLAIM. Summary: Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.This command transfers ownership of pending stream entries that match the specified criteria. Conceptually,
XAUTOCLAIM
is equivalent to callingXPENDING
and thenXCLAIM
, but provides a more straightforward way to deal with message delivery failures viaSCAN
-like semantics.Like
XCLAIM
, the command operates on the stream entries atkey
and in the context of the providedgroup
. It transfers ownership to @{code consumer} of messages pending for more thanmin-idle-time
milliseconds and having an equal or greater ID thanstart
.Group: stream Requires Redis 6.2.0+
- Parameters:
key
- key the keygroup
- string the consumer groupconsumer
- string the consumer idminIdleTime
- the min pending time of the message to claimstart
- the min id of the message to claim
-
xautoclaim
void xautoclaim(K key, String group, String consumer, Duration minIdleTime, String start, int count)
Execute the command XAUTOCLAIM. Summary: Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.This command transfers ownership of pending stream entries that match the specified criteria. Conceptually,
XAUTOCLAIM
is equivalent to callingXPENDING
and thenXCLAIM
, but provides a more straightforward way to deal with message delivery failures viaSCAN
-like semantics.Like
XCLAIM
, the command operates on the stream entries atkey
and in the context of the providedgroup
. It transfers ownership to @{code consumer} of messages pending for more thanmin-idle-time
milliseconds and having an equal or greater ID thanstart
.Group: stream Requires Redis 6.2.0+
- Parameters:
key
- key the keygroup
- string the consumer groupconsumer
- string the consumer idminIdleTime
- the min pending time of the message to claimstart
- the min id of the message to claimcount
- the upper limit of the number of entries to claim, default is 100.
-
xautoclaim
void xautoclaim(K key, String group, String consumer, Duration minIdleTime, String start, int count, boolean justId)
Execute the command XAUTOCLAIM. Summary: Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.This command transfers ownership of pending stream entries that match the specified criteria. Conceptually,
XAUTOCLAIM
is equivalent to callingXPENDING
and thenXCLAIM
, but provides a more straightforward way to deal with message delivery failures viaSCAN
-like semantics.Like
XCLAIM
, the command operates on the stream entries atkey
and in the context of the providedgroup
. It transfers ownership to @{code consumer} of messages pending for more thanmin-idle-time
milliseconds and having an equal or greater ID thanstart
.Group: stream Requires Redis 6.2.0+
- Parameters:
key
- key the keygroup
- string the consumer groupconsumer
- string the consumer idminIdleTime
- the min pending time of the message to claimstart
- the min id of the message to claimcount
- the upper limit of the number of entries to claim, default is 100.justId
- iftrue
the returned structure would only contain the id of the messages and not the payloads
-
xclaim
void xclaim(K key, String group, String consumer, Duration minIdleTime, String... id)
Execute the command XCLAIM. Summary: In the context of a stream consumer group, this command changes the ownership of a pending message, so that the new owner is the consumer specified as the command argument.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroup
- string the consumer groupconsumer
- string the consumer idminIdleTime
- the min pending time of the message to claimid
- the message ids to claim, must not be empty, must not containnull
-
xclaim
void xclaim(K key, String group, String consumer, Duration minIdleTime, XClaimArgs args, String... id)
Execute the command XCLAIM. Summary: In the context of a stream consumer group, this command changes the ownership of a pending message, so that the new owner is the consumer specified as the command argument.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroup
- string the consumer groupconsumer
- string the consumer idminIdleTime
- the min pending time of the message to claimargs
- the extra command parametersid
- the message ids to claim, must not be empty, must not containnull
-
xdel
void xdel(K key, String... id)
Execute the command XDEL. Summary: Removes the specified entries from a stream, and returns the number of entries deleted. This number may be less than the number of IDs passed to the command in the case where some of the specified IDs do not exist in the stream.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keyid
- the message ids, must not be empty, must not containnull
-
xgroupCreate
void xgroupCreate(K key, String groupname, String from)
Execute the command XGROUP CREATE. Summary: Create a new consumer group uniquely identified bygroupname
for the stream stored atkey
Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroupname
- the name of the group, must be unique, and notnull
from
- the last delivered entry in the stream from the new group's perspective. The special ID$
is the ID of the last entry in the stream, but you can substitute it with any valid ID.
-
xgroupCreate
void xgroupCreate(K key, String groupname, String from, XGroupCreateArgs args)
Execute the command XGROUP CREATE. Summary: Create a new consumer group uniquely identified bygroupname
for the stream stored atkey
Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroupname
- the name of the group, must be unique, and notnull
from
- the last delivered entry in the stream from the new group's perspective. The special ID$
is the ID of the last entry in the stream, but you can substitute it with any valid ID.args
- the extra command parameters
-
xgroupCreateConsumer
void xgroupCreateConsumer(K key, String groupname, String consumername)
Execute the command XGROUP CREATECONSUMER. Summary: Create a consumer namedconsumername
in the consumer groupgroupname
of the stream that's stored atkey
.Consumers are also created automatically whenever an operation, such as
XREADGROUP
, references a consumer that doesn't exist.Group: stream Requires Redis 6.2.0+
- Parameters:
key
- key the keygroupname
- the name of the group, must be unique, and notnull
consumername
- the consumer name
-
xgroupDelConsumer
void xgroupDelConsumer(K key, String groupname, String consumername)
Execute the command XGROUP DELCONSUMER. Summary: Deletes a consumer from the consumer group.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroupname
- the name of the group, must be unique, and notnull
consumername
- the consumer name
-
xgroupDestroy
void xgroupDestroy(K key, String groupname)
Execute the command XGROUP DESTROY. Summary: Completely destroys a consumer group. The consumer group will be destroyed even if there are active consumers, and pending messages, so make sure to call this command only when really needed.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroupname
- the name of the group, must be unique, and notnull
-
xgroupSetId
void xgroupSetId(K key, String groupname, String from)
Execute the command XGROUP SETID. Summary: Set the last delivered ID for a consumer group.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroupname
- the name of the group, must be unique, and notnull
from
- the last delivered entry in the stream from the new group's perspective. The special ID$
is the ID of the last entry in the stream, but you can substitute it with any valid ID.
-
xgroupSetId
void xgroupSetId(K key, String groupname, String from, XGroupSetIdArgs args)
Execute the command XGROUP SETID. Summary: Set the last delivered ID for a consumer group.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keygroupname
- the name of the group, must be unique, and notnull
from
- the last delivered entry in the stream from the new group's perspective. The special ID$
is the ID of the last entry in the stream, but you can substitute it with any valid ID.args
- the extra command parameters
-
xlen
void xlen(K key)
Execute the command XLEN. Summary: Returns the number of entries inside a stream.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the key
-
xrange
void xrange(K key, StreamRange range, int count)
Execute the command XRANGE. Summary: The command returns the stream entries matching a given range of IDs.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keyrange
- the range, must not benull
count
- the max number of entries to return
-
xrange
void xrange(K key, StreamRange range)
Execute the command XRANGE. Summary: The command returns the stream entries matching a given range of IDs.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keyrange
- the range, must not benull
-
xread
void xread(K key, String id)
Execute the command XREAD. Summary: Read data from one or multiple streams, only returning entries with an ID greater than the last received ID reported by the caller. This command has an option to block if items are not available, in a similar fashion toBRPOP
orBZPOPMIN
and others.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the key of the streamid
- the last read id
-
xread
void xread(Map<K,String> lastIdsPerStream)
Execute the command XREAD. Summary: Read data from one or multiple streams, only returning entries with an ID greater than the last received ID reported by the caller. This command has an option to block if items are not available, in a similar fashion toBRPOP
orBZPOPMIN
and others.Group: stream Requires Redis 5.0.0+
- Parameters:
lastIdsPerStream
- the map of key -> id indicating the last received id per stream to read
-
xread
void xread(K key, String id, XReadArgs args)
Execute the command XREAD. Summary: Read data from one or multiple streams, only returning entries with an ID greater than the last received ID reported by the caller. This command has an option to block if items are not available, in a similar fashion toBRPOP
orBZPOPMIN
and others.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the key of the streamid
- the last read idargs
- the extra parameter
-
xread
void xread(Map<K,String> lastIdsPerStream, XReadArgs args)
Execute the command XREAD. Summary: Read data from one or multiple streams, only returning entries with an ID greater than the last received ID reported by the caller. This command has an option to block if items are not available, in a similar fashion toBRPOP
orBZPOPMIN
and others.Group: stream Requires Redis 5.0.0+
- Parameters:
lastIdsPerStream
- the map of key -> id indicating the last received id per stream to readargs
- the extra parameter
-
xreadgroup
void xreadgroup(String group, String consumer, K key, String id)
Execute the command XREADGROUP. Summary: TheXREADGROUP
command is a special version of theXREAD
command with support for consumer groups.Group: stream Requires Redis 5.0.0+
- Parameters:
group
- the group nameconsumer
- the consumer namekey
- the stream keyid
- the last read id
-
xreadgroup
void xreadgroup(String group, String consumer, Map<K,String> lastIdsPerStream)
Execute the command XREADGROUP. Summary: TheXREADGROUP
command is a special version of theXREAD
command with support for consumer groups.Group: stream Requires Redis 5.0.0+
- Parameters:
group
- the group nameconsumer
- the consumer namelastIdsPerStream
- the map of key -> id indicating the last received id per stream to read
-
xreadgroup
void xreadgroup(String group, String consumer, K key, String id, XReadGroupArgs args)
Execute the command XREADGROUP. Summary: TheXREADGROUP
command is a special version of theXREAD
command with support for consumer groups.Group: stream Requires Redis 5.0.0+
- Parameters:
group
- the group nameconsumer
- the consumer namekey
- the stream keyid
- the last read idargs
- the extra parameter
-
xreadgroup
void xreadgroup(String group, String consumer, Map<K,String> lastIdsPerStream, XReadGroupArgs args)
Execute the command XREADGROUP. Summary: TheXREADGROUP
command is a special version of theXREAD
command with support for consumer groups.Group: stream Requires Redis 5.0.0+
- Parameters:
group
- the group nameconsumer
- the consumer namelastIdsPerStream
- the map of key -> id indicating the last received id per stream to readargs
- the extra parameter
-
xrevrange
void xrevrange(K key, StreamRange range, int count)
Execute the command XREVRANGE. Summary: This command is exactly likeXRANGE
, but with the notable difference of returning the entries in reverse order, and also taking the start-end range in reverse order: inXREVRANGE
you need to state the end ID and later the start ID, and the command will produce all the element between (or exactly like) the two IDs, starting from the end side.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keyrange
- the range, must not benull
count
- the max number of entries to return
-
xrevrange
void xrevrange(K key, StreamRange range)
Execute the command XRANGE. Summary: This command is exactly likeXRANGE
, but with the notable difference of returning the entries in reverse order, and also taking the start-end range in reverse order: inXREVRANGE
you need to state the end ID and later the start ID, and the command will produce all the element between (or exactly like) the two IDs, starting from the end side.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- key the keyrange
- the range, must not benull
-
xtrim
void xtrim(K key, String threshold)
Execute the command XTRIM. Summary: Trims the stream by evicting older entries (entries with lower IDs) if needed.Group: stream Requires Redis 5.0.0+
- Parameters:
key
- the keythreshold
- the threshold
-
-