17 Stream Commands🔗ℹ
A struct representing individual entries within a stream.
A struct representing pending entries within a stream group.
A struct representing information about a stream.
A struct representing an individual stream group.
A struct representing an individual stream consumer.
Acknowledges all of the messages represented by the given
ids within the group belonging to the stream at
key and returns the total number of acknowledged messages.
Commands used by this function: XACK
Adds an entry to the stream at key with fields
flds-and-vals. flds-and-vals must contain an even
number of items (one field name and one value for each field).
See the Redis documentation for the value of the id parameter.
Either max-length or max-length/approximate can be
provided, but not both.
Commands used by this function: XADD
Removes consumer from the stream group named group
belonging to the stream at key.
Commands used by this function: XGROUP_DELCONSUMER
Returns all of the consumers belonging to the group of the
stream at key.
Commands used by this function: XINFO_CONSUMERS
Returns information about the stream at key.
Commands used by this function: XINFO_STREAM
Creates a stream group called group for the stream at
key.
Commands used by this function: XGROUP_CREATE
Reads entries from a stream group for every stream and id pair given
via the streams alist and returns a list of lists where the
first element of each sublist is the name of the stream and
the second is the list of entries retrieved for that
stream.
The special 'new-entries id value maps to the special id
">", meaning that only entries that haven’t yet been
retrieved by this consumer should be returned.
Commands used by this function: XREADGROUP
Removes the group named group from the stream at
key.
Commands used by this function: XGROUP_REMOVE
Sets the starting id for the stream group named
group belonging to the stream at key.
Commands used by this function: XGROUP_SETID
Returns all of the groups belonging to the stream at key.
Commands used by this function: XINFO_GROUPS
Returns the length of the stream at key.
Commands used by this function: XLEN
Reads entries from every stream and id pair given via the
streams alist and returns a list of lists where the
first element of each sublist is the name of the stream and
the second is the list of entries retrieved for that
stream.
The special 'new-entries id value maps to the special id
"$", meaning that only entries added after the read was
initiated should be retrieved.
Commands used by this function: XREAD
Removes the entries represented by each id from the stream
at key, returning the total number of removed entries.
Commands used by this function: XDEL
Trims the stream at key to either max-length or
max-length/approximate. Usually, you will want to use the
latter for performance. Either keyword argument must be provided
but not both.
Commands used by this function: XTRIM
Returns at most limit entries between start and
stop from the stream at key. If limit is
#f, then all the entries are returned.
start and stop accept a stream entry id or one of
the special values 'first-entry and 'last-entry,
which map to the special ids "-" and "+",
respectively, which mean the very first and the very last item in
the stream.
When reverse? is #t the entries are returned in
reverse order and start and stop are swapped.
Commands used by this function: XRANGE
Retrieves limit pending entries for the group
belonging to the stream at key between start and
stop.
Commands used by this function: XPENDING