org.springframework.data.redis.core

Interface StreamOperations<K,HK,HV>

All Superinterfaces:

HashMapperProvider<HK,HV>

public interface StreamOperations<K,HK,HV>
extends HashMapperProvider<HK,HV>

Redis stream specific operations.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl

Method Summary

Modifier and Type	Method and Description
default Long	acknowledge(K key, String group, RecordId... recordIds) Acknowledge one or more records as processed.
Long	acknowledge(K key, String group, String... recordIds) Acknowledge one or more records as processed.
default Long	acknowledge(String group, Record<K,?> record) Acknowledge the given record as processed.
default RecordId	add(K key, Map<? extends HK,? extends HV> content) Append a record to the stream key.
default RecordId	add(MapRecord<K,? extends HK,? extends HV> record) Append a record, backed by a Map holding the field/value pairs, to the stream.
RecordId	add(Record<K,?> record) Append the record, backed by the given value, to the stream.
StreamInfo.XInfoConsumers	consumers(K key, String group) Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.
String	createGroup(K key, ReadOffset readOffset, String group) Create a consumer group.
default String	createGroup(K key, String group) Create a consumer group at the latest offset.
Long	delete(K key, RecordId... recordIds) Removes the specified records from the stream.
default Long	delete(K key, String... recordIds) Removes the specified records from the stream.
default Long	delete(Record<K,?> record) Removes a given Record from the stream.
Boolean	deleteConsumer(K key, Consumer consumer) Delete a consumer from a consumer group.
Boolean	destroyGroup(K key, String group) Destroy a consumer group.
<V> HashMapper<V,HK,HV>	getHashMapper(Class<V> targetType) Get the HashMapper for a specific type.
StreamInfo.XInfoGroups	groups(K key) Obtain information about consumer groups associated with the stream stored at the specified key.
StreamInfo.XInfoStream	info(K key) Obtain general information about the stream stored at the specified key.
default PendingMessages	pending(K key, Consumer consumer) Obtained detailed information about all pending messages for a given Consumer.
PendingMessages	pending(K key, Consumer consumer, Range<?> range, long count) Obtain detailed information about pending messages for a given Range and Consumer within a consumer group.
PendingMessagesSummary	pending(K key, String group) Obtain the PendingMessagesSummary for a given consumer group.
PendingMessages	pending(K key, String group, Range<?> range, long count) Obtain detailed information about pending messages for a given Range within a consumer group.
default <V> List<ObjectRecord<K,V>>	range(Class<V> targetType, K key, Range<String> range) Read all records from a stream within a specific Range as ObjectRecord.
default <V> List<ObjectRecord<K,V>>	range(Class<V> targetType, K key, Range<String> range, RedisZSetCommands.Limit limit) Read records from a stream within a specific Range applying a RedisZSetCommands.Limit as ObjectRecord.
default List<MapRecord<K,HK,HV>>	range(K key, Range<String> range) Read records from a stream within a specific Range.
List<MapRecord<K,HK,HV>>	range(K key, Range<String> range, RedisZSetCommands.Limit limit) Read records from a stream within a specific Range applying a RedisZSetCommands.Limit.
default <V> List<ObjectRecord<K,V>>	read(Class<V> targetType, Consumer consumer, StreamOffset<K>... streams) Read records from one or more StreamOffsets using a consumer group as ObjectRecord.
default <V> List<ObjectRecord<K,V>>	read(Class<V> targetType, Consumer consumer, StreamReadOptions readOptions, StreamOffset<K>... streams) Read records from one or more StreamOffsets using a consumer group as ObjectRecord.
default <V> List<ObjectRecord<K,V>>	read(Class<V> targetType, StreamOffset<K>... streams) Read records from one or more StreamOffsets as ObjectRecord.
default <V> List<ObjectRecord<K,V>>	read(Class<V> targetType, StreamReadOptions readOptions, StreamOffset<K>... streams) Read records from one or more StreamOffsets as ObjectRecord.
default List<MapRecord<K,HK,HV>>	read(Consumer consumer, StreamOffset<K>... streams) Read records from one or more StreamOffsets using a consumer group.
List<MapRecord<K,HK,HV>>	read(Consumer consumer, StreamReadOptions readOptions, StreamOffset<K>... streams) Read records from one or more StreamOffsets using a consumer group.
default List<MapRecord<K,HK,HV>>	read(StreamOffset<K>... streams) Read records from one or more StreamOffsets.
List<MapRecord<K,HK,HV>>	read(StreamReadOptions readOptions, StreamOffset<K>... streams) Read records from one or more StreamOffsets.
default <V> List<ObjectRecord<K,V>>	reverseRange(Class<V> targetType, K key, Range<String> range) Read records from a stream within a specific Range in reverse order as ObjectRecord.
default <V> List<ObjectRecord<K,V>>	reverseRange(Class<V> targetType, K key, Range<String> range, RedisZSetCommands.Limit limit) Read records from a stream within a specific Range applying a RedisZSetCommands.Limit in reverse order as ObjectRecord.
default List<MapRecord<K,HK,HV>>	reverseRange(K key, Range<String> range) Read records from a stream within a specific Range in reverse order.
List<MapRecord<K,HK,HV>>	reverseRange(K key, Range<String> range, RedisZSetCommands.Limit limit) Read records from a stream within a specific Range applying a RedisZSetCommands.Limit in reverse order.
Long	size(K key) Get the length of a stream.
Long	trim(K key, long count) Trims the stream to count elements.

Method Detail

acknowledge

@Nullable
Long acknowledge(K 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:

length of acknowledged records. null when used in pipeline / transaction.

See Also:

Redis Documentation: XACK

acknowledge

@Nullable
default Long acknowledge(K 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:

length of acknowledged records. null when used in pipeline / transaction.

See Also:

Redis Documentation: XACK

acknowledge

default Long acknowledge(String group,
                         Record<K,?> record)

Acknowledge the given record as processed.

Parameters:

group - name of the consumer group.

record - the Record to acknowledge.

Returns:

length of acknowledged records. null when used in pipeline / transaction.

See Also:

Redis Documentation: XACK

add

@Nullable
default RecordId add(K key,
                               Map<? extends HK,? extends HV> content)

Append a record to the stream key.

Parameters:

key - the stream key.

content - record content as Map.

Returns:

the record Id. null when used in pipeline / transaction.

See Also:

Redis Documentation: XADD

add

@Nullable
default RecordId add(MapRecord<K,? extends HK,? extends HV> record)

Append a record, backed by a Map holding the field/value pairs, to the stream.

Parameters:

record - the record to append.

Returns:

the record Id. null when used in pipeline / transaction.

See Also:

Redis Documentation: XADD

add

@Nullable
RecordId add(Record<K,?> record)

Append the record, backed by the given value, to the stream. The value is mapped as hash and serialized.

Parameters:

record - must not be null.

Returns:

the record Id. null when used in pipeline / transaction.

See Also:

MapRecord, ObjectRecord

delete

@Nullable
default Long delete(K key,
                              String... recordIds)

Removes the specified records from the stream. Returns the number of records 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:

number of removed entries. null when used in pipeline / transaction.

See Also:

Redis Documentation: XDEL

delete

@Nullable
default Long delete(Record<K,?> record)

Removes a given Record from the stream.

Parameters:

record - must not be null.

Returns:

he Mono emitting the number of removed records.

delete

@Nullable
Long delete(K key,
                      RecordId... recordIds)

Removes the specified records from the stream. Returns the number of records 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:

the Mono emitting the number of removed records.

See Also:

Redis Documentation: XDEL

createGroup

default String createGroup(K key,
                           String group)

Create a consumer group at the latest offset. This command creates the stream if it does not already exist.

Parameters:

key - the key the stream is stored at.

group - name of the consumer group.

Returns:

OK if successful. null when used in pipeline / transaction.

createGroup

@Nullable
String createGroup(K key,
                             ReadOffset readOffset,
                             String group)

Create a consumer group. This command creates the stream if it does not already exist.

Parameters:

key - the key the stream is stored at.

readOffset - the ReadOffset to apply.

group - name of the consumer group.

Returns:

OK if successful. null when used in pipeline / transaction.

deleteConsumer

@Nullable
Boolean deleteConsumer(K key,
                                 Consumer consumer)

Delete a consumer from a consumer group.

Parameters:

key - the stream key.

consumer - consumer identified by group name and consumer key.

Returns:

true if successful. null when used in pipeline / transaction.

destroyGroup

@Nullable
Boolean destroyGroup(K key,
                               String group)

Destroy a consumer group.

Parameters:

key - the stream key.

group - name of the consumer group.

Returns:

true if successful. null when used in pipeline / transaction.

consumers

StreamInfo.XInfoConsumers consumers(K key,
                                    String group)

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.

group - name of the consumer group.

Returns:

null when used in pipeline / transaction.

Since:

2.3

groups

StreamInfo.XInfoGroups groups(K key)

Obtain information about consumer groups associated with the stream stored at the specified key.

Parameters:

key - the key the stream is stored at.

Returns:

null when used in pipeline / transaction.

Since:

2.3

info

StreamInfo.XInfoStream info(K key)

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

Parameters:

key - the key the stream is stored at.

Returns:

null when used in pipeline / transaction.

Since:

2.3

pending

@Nullable
PendingMessagesSummary pending(K key,
                                         String group)

Obtain the PendingMessagesSummary for a given consumer group.

Parameters:

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

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

Returns:

a summary of pending messages within the given consumer group or null when used in pipeline / transaction.

Since:

2.3

See Also:

Redis Documentation: xpending

pending

default PendingMessages pending(K 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:

pending messages for the given Consumer or null when used in pipeline / transaction.

Since:

2.3

See Also:

Redis Documentation: xpending

pending

PendingMessages pending(K key,
                        String group,
                        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.

group - 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.

Returns:

pending messages for the given consumer group or null when used in pipeline / transaction.

Since:

2.3

See Also:

Redis Documentation: xpending

pending

PendingMessages pending(K 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.

Returns:

pending messages for the given Consumer or null when used in pipeline / transaction.

Since:

2.3

See Also:

Redis Documentation: xpending

size

@Nullable
Long size(K key)

Get the length of a stream.

Parameters:

key - the stream key.

Returns:

length of the stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XLEN

range

@Nullable
default List<MapRecord<K,HK,HV>> range(K key,
                                                 Range<String> range)

Read records from a stream within a specific Range.

Parameters:

key - the stream key.

range - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XRANGE

range

@Nullable
List<MapRecord<K,HK,HV>> range(K key,
                                         Range<String> range,
                                         RedisZSetCommands.Limit limit)

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

Parameters:

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XRANGE

range

default <V> List<ObjectRecord<K,V>> range(Class<V> targetType,
                                          K key,
                                          Range<String> range)

Read all records from a stream within a specific Range as ObjectRecord.

Parameters:

targetType - the target type of the payload.

key - the stream key.

range - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XRANGE

range

default <V> List<ObjectRecord<K,V>> range(Class<V> targetType,
                                          K key,
                                          Range<String> range,
                                          RedisZSetCommands.Limit limit)

Read records from a stream within a specific Range applying a RedisZSetCommands.Limit as ObjectRecord.

Parameters:

targetType - the target type of the payload.

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XRANGE

read

@Nullable
default List<MapRecord<K,HK,HV>> read(StreamOffset<K>... streams)

Read records from one or more StreamOffsets.

Parameters:

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREAD

read

default <V> List<ObjectRecord<K,V>> read(Class<V> targetType,
                                         StreamOffset<K>... streams)

Read records from one or more StreamOffsets as ObjectRecord.

Parameters:

targetType - the target type of the payload.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREAD

read

@Nullable
List<MapRecord<K,HK,HV>> read(StreamReadOptions readOptions,
                                        StreamOffset<K>... streams)

Read records from one or more StreamOffsets.

Parameters:

readOptions - read arguments.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREAD

read

@Nullable
default <V> List<ObjectRecord<K,V>> read(Class<V> targetType,
                                                   StreamReadOptions readOptions,
                                                   StreamOffset<K>... streams)

Read records from one or more StreamOffsets as ObjectRecord.

Parameters:

targetType - the target type of the payload.

readOptions - read arguments.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREAD

read

@Nullable
default List<MapRecord<K,HK,HV>> read(Consumer consumer,
                                                StreamOffset<K>... streams)

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

Parameters:

consumer - consumer/group.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREADGROUP

read

@Nullable
default <V> List<ObjectRecord<K,V>> read(Class<V> targetType,
                                                   Consumer consumer,
                                                   StreamOffset<K>... streams)

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

Parameters:

targetType - the target type of the payload.

consumer - consumer/group.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREADGROUP

read

@Nullable
List<MapRecord<K,HK,HV>> read(Consumer consumer,
                                        StreamReadOptions readOptions,
                                        StreamOffset<K>... 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:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREADGROUP

read

@Nullable
default <V> List<ObjectRecord<K,V>> read(Class<V> targetType,
                                                   Consumer consumer,
                                                   StreamReadOptions readOptions,
                                                   StreamOffset<K>... streams)

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

Parameters:

targetType - the target type of the payload.

consumer - consumer/group.

readOptions - read arguments.

streams - the streams to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREADGROUP

reverseRange

@Nullable
default List<MapRecord<K,HK,HV>> reverseRange(K 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:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREVRANGE

reverseRange

@Nullable
List<MapRecord<K,HK,HV>> reverseRange(K key,
                                                Range<String> range,
                                                RedisZSetCommands.Limit limit)

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

Parameters:

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREVRANGE

reverseRange

default <V> List<ObjectRecord<K,V>> reverseRange(Class<V> targetType,
                                                 K key,
                                                 Range<String> range)

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

Parameters:

targetType - the target type of the payload.

key - the stream key.

range - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREVRANGE

reverseRange

default <V> List<ObjectRecord<K,V>> reverseRange(Class<V> targetType,
                                                 K key,
                                                 Range<String> range,
                                                 RedisZSetCommands.Limit limit)

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

Parameters:

targetType - the target type of the payload.

key - the stream key.

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

Redis Documentation: XREVRANGE

trim

@Nullable
Long trim(K key,
                    long count)

Trims the stream to count elements.

Parameters:

key - the stream key.

count - length of the stream.

Returns:

number of removed entries. null when used in pipeline / transaction.

See Also:

Redis Documentation: XTRIM

getHashMapper

<V> HashMapper<V,HK,HV> getHashMapper(Class<V> targetType)

Get the HashMapper for a specific type.

Specified by:

getHashMapper in interface HashMapperProvider<HK,HV>

Type Parameters:

V -

Parameters:

targetType - must not be null.

Returns:

the HashMapper suitable for a given type;