Package org.springframework.data.redis.connection

Interface ReactiveStreamCommands

All Known Subinterfaces:

ReactiveClusterStreamCommands

public interface ReactiveStreamCommands

Stream-specific Redis commands executed using reactive infrastructure.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl, Tugdual Grall, Dengliming, Mark John Moreno, jinkshower

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReactiveStreamCommands.AcknowledgeCommand	XACK command parameters.
static class	ReactiveStreamCommands.AddStreamRecord	XADD command parameters.
static class	ReactiveStreamCommands.DeleteCommand	XDEL command parameters.
static class	ReactiveStreamCommands.GroupCommand
static class	ReactiveStreamCommands.PendingRecordsCommand	Value Object holding parameters for obtaining pending messages.
static class	ReactiveStreamCommands.RangeCommand	XRANGE/XREVRANGE command parameters.
static class	ReactiveStreamCommands.ReadCommand	XRANGE/XREVRANGE command parameters.
static class	ReactiveStreamCommands.TrimCommand	XTRIM command parameters.
static class	ReactiveStreamCommands.XClaimCommand	XCLAIM command parameters.
static class	ReactiveStreamCommands.XInfoCommand

Method Summary

Modifier and Type	Method	Description
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.ReadCommand,Flux<ByteBufferRecord>>>	read(Publisher<ReactiveStreamCommands.ReadCommand> commands)	Read records from one or more StreamOffsets.
default Mono<Long>	xAck(ByteBuffer key, String group, String... recordIds)	Acknowledge one or more records as processed.
default Mono<Long>	xAck(ByteBuffer key, String group, RecordId... recordIds)	Acknowledge one or more records as processed.
Flux<ReactiveRedisConnection.NumericResponse<ReactiveStreamCommands.AcknowledgeCommand,Long>>	xAck(Publisher<ReactiveStreamCommands.AcknowledgeCommand> commands)	Acknowledge one or more records as processed.
default Mono<RecordId>	xAdd(ByteBuffer key, Map<ByteBuffer,ByteBuffer> body)	Add stream record with given body to key.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.AddStreamRecord,RecordId>>	xAdd(Publisher<ReactiveStreamCommands.AddStreamRecord> commands)	Add stream record with given body to key.
default Mono<RecordId>	xAdd(ByteBufferRecord record)	Add stream record with given body to key.
default Mono<RecordId>	xAdd(ByteBufferRecord record, RedisStreamCommands.XAddOptions xAddOptions)	Add stream record with the specified options.
default Flux<ByteBufferRecord>	xClaim(ByteBuffer key, String group, String newOwner, Duration minIdleTime, RecordId... recordIds)	Change the ownership of a pending message to the given new consumer.
default Flux<ByteBufferRecord>	xClaim(ByteBuffer key, String group, String newOwner, RedisStreamCommands.XClaimOptions options)	Change the ownership of a pending message to the given new consumer.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XClaimCommand,Flux<ByteBufferRecord>>>	xClaim(Publisher<ReactiveStreamCommands.XClaimCommand> commands)	Change the ownership of a pending message to the given new consumer.
default Flux<RecordId>	xClaimJustId(ByteBuffer key, String group, String newOwner, RedisStreamCommands.XClaimOptions options)	Change the ownership of a pending message to the given new consumer without increasing the delivered count.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XClaimCommand,Flux<RecordId>>>	xClaimJustId(Publisher<ReactiveStreamCommands.XClaimCommand> commands)	Change the ownership of a pending message to the given new consumer without increasing the delivered count.
default Mono<Long>	xDel(ByteBuffer key, String... recordIds)	Removes the specified entries from the stream.
default Mono<Long>	xDel(ByteBuffer key, RecordId... recordIds)	Removes the specified entries from the stream.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.DeleteCommand,Long>>	xDel(Publisher<ReactiveStreamCommands.DeleteCommand> commands)	Removes the specified entries from the stream.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.GroupCommand,String>>	xGroup(Publisher<ReactiveStreamCommands.GroupCommand> commands)	Execute the given ReactiveStreamCommands.GroupCommand to create, destroy,... groups.
default Mono<String>	xGroup(ReactiveStreamCommands.GroupCommand command)	Execute the given ReactiveStreamCommands.GroupCommand to create, destroy,... groups.
default Mono<String>	xGroupCreate(ByteBuffer key, String groupName, ReadOffset readOffset)	Create a consumer group.
default Mono<String>	xGroupCreate(ByteBuffer key, String groupName, ReadOffset readOffset, boolean mkStream)	Create a consumer group.
default Mono<String>	xGroupDelConsumer(ByteBuffer key, String groupName, String consumerName)	Delete a consumer from a consumer group.
default Mono<String>	xGroupDelConsumer(ByteBuffer key, Consumer consumer)	Delete a consumer from a consumer group.
default Mono<String>	xGroupDestroy(ByteBuffer key, String groupName)	Destroy a consumer group.
default Mono<StreamInfo.XInfoStream>	xInfo(ByteBuffer key)	Obtain general information about the stream stored at the specified key.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XInfoCommand,StreamInfo.XInfoStream>>	xInfo(Publisher<ReactiveStreamCommands.XInfoCommand> commands)	Obtain general information about the stream stored at the specified key.
default Flux<StreamInfo.XInfoConsumer>	xInfoConsumers(ByteBuffer key, String groupName)	Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XInfoCommand,Flux<StreamInfo.XInfoConsumer>>>	xInfoConsumers(Publisher<ReactiveStreamCommands.XInfoCommand> commands)	Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.
default Flux<StreamInfo.XInfoGroup>	xInfoGroups(ByteBuffer key)	Obtain general information about the stream stored at the specified key.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XInfoCommand,Flux<StreamInfo.XInfoGroup>>>	xInfoGroups(Publisher<ReactiveStreamCommands.XInfoCommand> commands)	Obtain general information about the stream stored at the specified key.
default Mono<Long>	xLen(ByteBuffer key)	Get the size of the stream stored at key.
Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	xLen(Publisher<ReactiveRedisConnection.KeyCommand> commands)	Get the size of the stream stored at ReactiveRedisConnection.KeyCommand.getKey()
default Mono<PendingMessagesSummary>	xPending(ByteBuffer key, String groupName)	Obtain the PendingMessagesSummary for a given consumer group.
default Mono<PendingMessages>	xPending(ByteBuffer key, String groupName, String consumerName)	Obtained detailed information about all pending messages for a given consumer.
default Mono<PendingMessages>	xPending(ByteBuffer key, String groupName, String consumerName, Range<?> range, Long count)	Obtain detailed information about pending messages for a given Range and consumer within a consumer group.
default Mono<PendingMessages>	xPending(ByteBuffer key, String groupName, Range<?> range, Long count)	Obtain detailed information about pending messages for a given Range within a consumer group.
default Mono<PendingMessages>	xPending(ByteBuffer key, Consumer consumer)	Obtained detailed information about all pending messages for a given Consumer.
default Mono<PendingMessages>	xPending(ByteBuffer key, Consumer consumer, Range<?> range, Long count)	Obtain detailed information about pending messages for a given Range and Consumer within a consumer group.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.PendingRecordsCommand,PendingMessages>>	xPending(Publisher<ReactiveStreamCommands.PendingRecordsCommand> commands)	Obtain detailed information about pending messages applying given options.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.PendingRecordsCommand,PendingMessagesSummary>>	xPendingSummary(Publisher<ReactiveStreamCommands.PendingRecordsCommand> commands)	Obtain the PendingMessagesSummary for a given consumer group.
default Flux<ByteBufferRecord>	xRange(ByteBuffer key, Range<String> range)	Read records from a stream within a specific Range.
default Flux<ByteBufferRecord>	xRange(ByteBuffer key, Range<String> range, Limit limit)	Read records from a stream within a specific Range applying a Limit.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.RangeCommand,Flux<ByteBufferRecord>>>	xRange(Publisher<ReactiveStreamCommands.RangeCommand> commands)	Read records from a stream within a specific Range applying a Limit.
default Flux<ByteBufferRecord>	xRead(StreamOffset<ByteBuffer>... streams)	Read records from one or more StreamOffsets.
default Flux<ByteBufferRecord>	xRead(StreamReadOptions readOptions, StreamOffset<ByteBuffer>... streams)	Read records from one or more StreamOffsets.
default Flux<ByteBufferRecord>	xReadGroup(Consumer consumer, StreamOffset<ByteBuffer>... streams)	Read records from one or more StreamOffsets using a consumer group.
default Flux<ByteBufferRecord>	xReadGroup(Consumer consumer, StreamReadOptions readOptions, StreamOffset<ByteBuffer>... streams)	Read records from one or more StreamOffsets using a consumer group.
default Flux<ByteBufferRecord>	xRevRange(ByteBuffer key, Range<String> range)	Read records from a stream within a specific Range in reverse order.
default Flux<ByteBufferRecord>	xRevRange(ByteBuffer key, Range<String> range, Limit limit)	Read records from a stream within a specific Range applying a Limit in reverse order.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.RangeCommand,Flux<ByteBufferRecord>>>	xRevRange(Publisher<ReactiveStreamCommands.RangeCommand> commands)	Read records from a stream within a specific Range applying a Limit in reverse order.
default Mono<Long>	xTrim(ByteBuffer key, long count)	Trims the stream to count elements.
default Mono<Long>	xTrim(ByteBuffer key, long count, boolean approximateTrimming)	Trims the stream to count elements.
Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	xTrim(Publisher<ReactiveStreamCommands.TrimCommand> commands)	Trims the stream to count elements.

Method Details

xAck

default Mono<Long> xAck(ByteBuffer key,
 String group,
 String... recordIds)

Acknowledge one or more records as processed.

Parameters:

key - the stream key.

group - name of the consumer group.

recordIds - record Id's to acknowledge.

Returns:

Mono emitting the nr of acknowledged messages.

See Also:

• Redis Documentation: XADD

xAck

default Mono<Long> xAck(ByteBuffer key,
 String group,
 RecordId... recordIds)

Acknowledge one or more records as processed.

Parameters:

key - the stream key.

group - name of the consumer group.

recordIds - record Id's to acknowledge.

Returns:

Mono emitting the nr of acknowledged messages.

See Also:

• Redis Documentation: XADD

xAck

Flux<ReactiveRedisConnection.NumericResponse<ReactiveStreamCommands.AcknowledgeCommand,Long>> xAck(Publisher<ReactiveStreamCommands.AcknowledgeCommand> commands)

Acknowledge one or more records as processed.

Parameters:

commands - must not be null.

Returns:

Flux emitting the nr of acknowledged messages per ReactiveStreamCommands.AcknowledgeCommand.

See Also:

• Redis Documentation: XACK

xAdd

default Mono<RecordId> xAdd(ByteBuffer key,
 Map<ByteBuffer,ByteBuffer> body)

Add stream record with given body to key.

Parameters:

key - must not be null.

body - must not be null.

Returns:

Mono emitting the server generated id.

See Also:

• Redis Documentation: XADD

xAdd

default Mono<RecordId> xAdd(ByteBufferRecord record)

Add stream record with given body to key.

Parameters:

record - must not be null.

Returns:

Mono the id.

See Also:

• Redis Documentation: XADD

xAdd

default Mono<RecordId> xAdd(ByteBufferRecord record,
 RedisStreamCommands.XAddOptions xAddOptions)

Add stream record with the specified options.

Parameters:

record - must not be null.

xAddOptions - parameters for the XADD call. Must not be null.

Returns:

Mono the id.

Since:

3.4

See Also:

• Redis Documentation: XADD

xAdd

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.AddStreamRecord,RecordId>> xAdd(Publisher<ReactiveStreamCommands.AddStreamRecord> commands)

Add stream record with given body to key.

Parameters:

commands - must not be null.

Returns:

Flux emitting the RecordId on by for the given ReactiveStreamCommands.AddStreamRecord commands.

See Also:

• Redis Documentation: XADD

xClaimJustId

default Flux<RecordId> xClaimJustId(ByteBuffer key,
 String group,
 String newOwner,
 RedisStreamCommands.XClaimOptions options)

Change the ownership of a pending message to the given new consumer without increasing the delivered count.

Parameters:

key - the key the stream is stored at.

group - the name of the consumer group.

newOwner - the name of the new consumer.

options - must not be null.

Returns:

a Flux emitting is that changed user.

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xClaimJustId

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XClaimCommand,Flux<RecordId>>> xClaimJustId(Publisher<ReactiveStreamCommands.XClaimCommand> commands)

Change the ownership of a pending message to the given new consumer without increasing the delivered count.

Parameters:

commands - must not be null.

Returns:

a Flux emitting is that changed user.

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xClaim

default Flux<ByteBufferRecord> xClaim(ByteBuffer key,
 String group,
 String newOwner,
 Duration minIdleTime,
 RecordId... recordIds)

Change the ownership of a pending message to the given new consumer.

Parameters:

key - the key the stream is stored at.

group - the name of the consumer group.

newOwner - the name of the new consumer.

minIdleTime - must not be null.

recordIds - must not be null.

Returns:

a Flux emitting ByteBufferRecord that changed user.

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xClaim

default Flux<ByteBufferRecord> xClaim(ByteBuffer key,
 String group,
 String newOwner,
 RedisStreamCommands.XClaimOptions options)

Change the ownership of a pending message to the given new consumer.

Parameters:

key - the key the stream is stored at.

group - the name of the consumer group.

newOwner - the name of the new consumer.

options - must not be null.

Returns:

a Flux emitting ByteBufferRecord that changed user.

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xClaim

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XClaimCommand,Flux<ByteBufferRecord>>> xClaim(Publisher<ReactiveStreamCommands.XClaimCommand> commands)

Change the ownership of a pending message to the given new consumer.

Parameters:

commands - must not be null.

Returns:

Since:

2.3

See Also:

• Redis Documentation: XCLAIM

xDel

default Mono<Long> xDel(ByteBuffer key,
 String... recordIds)

Removes the specified entries from the stream. Returns the number of items deleted, that may be different from the number of IDs passed in case certain IDs do not exist.

Parameters:

key - the stream key.

recordIds - stream record Id's.

Returns:

Mono emitting the number of removed entries.

See Also:

• Redis Documentation: XDEL

xDel

default Mono<Long> xDel(ByteBuffer key,
 RecordId... recordIds)

Removes the specified entries from the stream. Returns the number of items deleted, that may be different from the number of IDs passed in case certain IDs do not exist.

Parameters:

key - the stream key.

recordIds - stream record Id's.

Returns:

Mono emitting the number of removed entries.

See Also:

• Redis Documentation: XDEL

xDel

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.DeleteCommand,Long>> xDel(Publisher<ReactiveStreamCommands.DeleteCommand> commands)

Removes the specified entries from the stream. Returns the number of items deleted, that may be different from the number of IDs passed in case certain IDs do not exist.

Parameters:

commands - must not be null.

Returns:

Mono emitting the number of removed entries.

See Also:

• Redis Documentation: XDEL

xLen

default Mono<Long> xLen(ByteBuffer key)

Get the size of the stream stored at key.

Parameters:

key - must not be null.

Returns:

Mono emitting the length of the stream.

See Also:

• Redis Documentation: XLEN

xLen

Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> xLen(Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get the size of the stream stored at ReactiveRedisConnection.KeyCommand.getKey()

Parameters:

commands - must not be null.

Returns:

Flux emitting the length of the stream per ReactiveRedisConnection.KeyCommand.

See Also:

• Redis Documentation: XLEN

xPending

default Mono<PendingMessagesSummary> xPending(ByteBuffer key,
 String groupName)

Obtain the PendingMessagesSummary for a given consumer group.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

Returns:

Mono emitting a summary of pending messages within the given consumer group.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPendingSummary

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.PendingRecordsCommand,PendingMessagesSummary>> xPendingSummary(Publisher<ReactiveStreamCommands.PendingRecordsCommand> commands)

Obtain the PendingMessagesSummary for a given consumer group.

Parameters:

commands - must not be null..

Returns:

Flux emitting a summary of pending messages within the given consumer group one by one.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

@Nullable
default Mono<PendingMessages> xPending(ByteBuffer key,
 Consumer consumer)

Obtained detailed information about all pending messages for a given Consumer.

Parameters:

key - the key the stream is stored at. Must not be null.

consumer - the consumer to fetch PendingMessages for. Must not be null.

Returns:

Mono emitting pending messages for the given Consumer.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

@Nullable
default Mono<PendingMessages> xPending(ByteBuffer key,
 String groupName,
 String consumerName)

Obtained detailed information about all pending messages for a given consumer.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

consumerName - the consumer to fetch PendingMessages for. Must not be null.

Returns:

Mono emitting pending messages for the given Consumer.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

default Mono<PendingMessages> xPending(ByteBuffer key,
 String groupName,
 Range<?> range,
 Long count)

Obtain detailed information about pending messages for a given Range within a consumer group.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

range - the range of messages ids to search within. Must not be null.

count - limit the number of results. Must not be null.

Returns:

Mono emitting pending messages for the given consumer group. transaction.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

default Mono<PendingMessages> xPending(ByteBuffer key,
 Consumer consumer,
 Range<?> range,
 Long count)

Obtain detailed information about pending messages for a given Range and Consumer within a consumer group.

Parameters:

key - the key the stream is stored at. Must not be null.

consumer - the name of the Consumer. Must not be null.

range - the range of messages ids to search within. Must not be null.

count - limit the number of results. Must not be null.

Returns:

Mono emitting pending messages for the given Consumer.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

default Mono<PendingMessages> xPending(ByteBuffer key,
 String groupName,
 String consumerName,
 Range<?> range,
 Long count)

Obtain detailed information about pending messages for a given Range and consumer within a consumer group.

Parameters:

key - the key the stream is stored at. Must not be null.

groupName - the name of the consumer group. Must not be null.

consumerName - the name of the consumer. Must not be null.

range - the range of messages ids to search within. Must not be null.

count - limit the number of results. Must not be null.

Returns:

Mono emitting pending messages for the given consumer in given consumer group.

Since:

2.3

See Also:

• Redis Documentation: xpending

xPending

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.PendingRecordsCommand,PendingMessages>> xPending(Publisher<ReactiveStreamCommands.PendingRecordsCommand> commands)

Obtain detailed information about pending messages applying given options.

Parameters:

commands - must not be null.

Returns:

Flux emitting pending messages matching given criteria.

Since:

2.3

See Also:

• Redis Documentation: xpending

xRange

default Flux<ByteBufferRecord> xRange(ByteBuffer key,
 Range<String> range)

Read records from a stream within a specific Range.

Parameters:

key - the stream key.

range - must not be null.

Returns:

Flux emitting with members of the stream.

See Also:

• Redis Documentation: XRANGE

xRange

default Flux<ByteBufferRecord> xRange(ByteBuffer key,
 Range<String> range,
 Limit limit)

Read records from a stream within a specific Range applying a Limit.

Parameters:

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

Flux emitting with members of the stream.

See Also:

• Redis Documentation: XRANGE

xRange

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.RangeCommand,Flux<ByteBufferRecord>>> xRange(Publisher<ReactiveStreamCommands.RangeCommand> commands)

Read records from a stream within a specific Range applying a Limit.

Parameters:

commands - must not be null.

Returns:

Flux emitting with members of the stream per ReactiveStreamCommands.RangeCommand.

See Also:

• Redis Documentation: XRANGE

xRead

default Flux<ByteBufferRecord> xRead(StreamOffset<ByteBuffer>... streams)

Read records from one or more StreamOffsets.

Parameters:

streams - the streams to read from.

Returns:

Flux emitting with members of the stream.

See Also:

• Redis Documentation: XREAD

xRead

default Flux<ByteBufferRecord> xRead(StreamReadOptions readOptions,
 StreamOffset<ByteBuffer>... streams)

Read records from one or more StreamOffsets.

Parameters:

readOptions - read arguments.

streams - the streams to read from.

Returns:

Flux emitting with members of the stream.

See Also:

• Redis Documentation: XREAD

read

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.ReadCommand,Flux<ByteBufferRecord>>> read(Publisher<ReactiveStreamCommands.ReadCommand> commands)

Read records from one or more StreamOffsets.

Parameters:

commands - must not be null.

Returns:

Flux emitting the members of the stream per ReactiveStreamCommands.ReadCommand.

See Also:

• Redis Documentation: XREAD
• Redis Documentation: XREADGROUP

xInfo

default Mono<StreamInfo.XInfoStream> xInfo(ByteBuffer key)

Obtain general information about the stream stored at the specified key.

Parameters:

key - the key the stream is stored at.

Returns:

a Mono emitting StreamInfo.XInfoStream when ready.

Since:

2.3

xInfo

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XInfoCommand,StreamInfo.XInfoStream>> xInfo(Publisher<ReactiveStreamCommands.XInfoCommand> commands)

Obtain general information about the stream stored at the specified key.

Parameters:

commands - must not be null.

Returns:

never null.

Since:

2.3

xInfoGroups

default Flux<StreamInfo.XInfoGroup> xInfoGroups(ByteBuffer key)

Obtain general information about the stream stored at the specified key.

Parameters:

key - the key the stream is stored at.

Returns:

a Flux emitting consumer group info one by one.

Since:

2.3

xInfoGroups

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XInfoCommand,Flux<StreamInfo.XInfoGroup>>> xInfoGroups(Publisher<ReactiveStreamCommands.XInfoCommand> commands)

Obtain general information about the stream stored at the specified key.

Parameters:

commands - must not be null.

Returns:

never null.

Since:

2.3

xInfoConsumers

default Flux<StreamInfo.XInfoConsumer> xInfoConsumers(ByteBuffer key,
 String groupName)

Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.

Parameters:

key - the key the stream is stored at.

groupName - name of the consumer group.

Returns:

a Flux emitting consumer info one by one.

Since:

2.3

xInfoConsumers

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.XInfoCommand,Flux<StreamInfo.XInfoConsumer>>> xInfoConsumers(Publisher<ReactiveStreamCommands.XInfoCommand> commands)

Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.

Parameters:

commands - must not be null.

Returns:

never null.

Since:

2.3

xGroupCreate

default Mono<String> xGroupCreate(ByteBuffer key,
 String groupName,
 ReadOffset readOffset)

Create a consumer group.

Parameters:

key - key the key the stream is stored at.

groupName - name of the consumer group to create.

readOffset - the offset to start at.

Returns:

the Mono emitting ok if successful.

xGroupCreate

default Mono<String> xGroupCreate(ByteBuffer key,
 String groupName,
 ReadOffset readOffset,
 boolean mkStream)

Create a consumer group.

Parameters:

key - key the key the stream is stored at.

groupName - name of the consumer group to create.

readOffset - the offset to start at.

mkStream - if true the group will create the stream if needed (MKSTREAM)

Returns:

the Mono emitting ok if successful.

Since:

2.3

xGroupDelConsumer

@Nullable
default Mono<String> xGroupDelConsumer(ByteBuffer key,
 String groupName,
 String consumerName)

Delete a consumer from a consumer group.

Parameters:

key - the key the stream is stored at.

groupName - the name of the group to remove the consumer from.

consumerName - the name of the consumer to remove from the group.

Returns:

the Mono emitting ok if successful.

xGroupDelConsumer

default Mono<String> xGroupDelConsumer(ByteBuffer key,
 Consumer consumer)

Delete a consumer from a consumer group.

Parameters:

key - the key the stream is stored at.

consumer - the Consumer.

Returns:

the Mono emitting ok if successful.

xGroupDestroy

@Nullable
default Mono<String> xGroupDestroy(ByteBuffer key,
 String groupName)

Destroy a consumer group.

Parameters:

key - the key the stream is stored at.

groupName - name of the consumer group.

Returns:

the Mono emitting ok if successful.

xGroup

default Mono<String> xGroup(ReactiveStreamCommands.GroupCommand command)

Execute the given ReactiveStreamCommands.GroupCommand to create, destroy,... groups.

Parameters:

command - the ReactiveStreamCommands.GroupCommand to run.

Returns:

the Mono emitting the command result.

xGroup

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.GroupCommand,String>> xGroup(Publisher<ReactiveStreamCommands.GroupCommand> commands)

Execute the given ReactiveStreamCommands.GroupCommand to create, destroy,... groups.

Parameters:

commands -

Returns:

Flux emitting the results of the ReactiveStreamCommands.GroupCommand one by one.

xReadGroup

default Flux<ByteBufferRecord> xReadGroup(Consumer consumer,
 StreamOffset<ByteBuffer>... streams)

Read records from one or more StreamOffsets using a consumer group.

Parameters:

consumer - consumer/group.

streams - the streams to read from.

Returns:

Flux emitting the members of the stream

See Also:

• Redis Documentation: XREADGROUP

xReadGroup

default Flux<ByteBufferRecord> xReadGroup(Consumer consumer,
 StreamReadOptions readOptions,
 StreamOffset<ByteBuffer>... streams)

Read records from one or more StreamOffsets using a consumer group.

Parameters:

consumer - consumer/group.

readOptions - read arguments.

streams - the streams to read from.

Returns:

Flux emitting the members of the stream.

See Also:

• Redis Documentation: XREADGROUP

xRevRange

default Flux<ByteBufferRecord> xRevRange(ByteBuffer key,
 Range<String> range)

Read records from a stream within a specific Range in reverse order.

Parameters:

key - the stream key.

range - must not be null.

Returns:

Flux emitting the members of the stream in reverse.

See Also:

• Redis Documentation: XREVRANGE

xRevRange

default Flux<ByteBufferRecord> xRevRange(ByteBuffer key,
 Range<String> range,
 Limit limit)

Read records from a stream within a specific Range applying a Limit in reverse order.

Parameters:

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

Flux emitting the members of the stream in reverse.

See Also:

• Redis Documentation: XREVRANGE

xRevRange

Flux<ReactiveRedisConnection.CommandResponse<ReactiveStreamCommands.RangeCommand,Flux<ByteBufferRecord>>> xRevRange(Publisher<ReactiveStreamCommands.RangeCommand> commands)

Read records from a stream within a specific Range applying a Limit in reverse order.

Parameters:

commands - must not be null.

Returns:

Flux emitting the members of the stream in reverse.

See Also:

• Redis Documentation: XREVRANGE

xTrim

default Mono<Long> xTrim(ByteBuffer key,
 long count)

Trims the stream to count elements.

Parameters:

key - the stream key.

count - length of the stream.

Returns:

Mono emitting the number of removed entries.

See Also:

• Redis Documentation: XTRIM

xTrim

default Mono<Long> xTrim(ByteBuffer key,
 long count,
 boolean approximateTrimming)

Trims the stream to count elements.

Parameters:

key - the stream key.

count - length of the stream.

approximateTrimming - the trimming must be performed in a approximated way in order to maximize performances.

Returns:

Mono emitting the number of removed entries.

Since:

2.4

See Also:

• Redis Documentation: XTRIM

xTrim

Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> xTrim(Publisher<ReactiveStreamCommands.TrimCommand> commands)

Trims the stream to count elements.

Parameters:

commands - must not be null.

Returns:

Flux emitting the number of removed entries per ReactiveStreamCommands.TrimCommand.

See Also:

• Redis Documentation: XTRIM