Redis::Commands::Stream

Append an entry with the specified data to the stream with the given key and gives it the specified id. If the id is "*", Redis will assign it an id of the form "#{Time.utc.to_unix_ms}-#{autoincrementing_index}". If maxlen is provided, Redis will trim the stream to the specified length. If maxlen is of the form ~ 1000, Redis will trim it to approximately that length, removing entries when it can do so efficiently. This method returns the id that Redis stores.

redis.xadd "my-stream", "*", {"name" => "foo", "id" => UUID.random.to_s}

Append an entry with the specified data to the stream with the given key and gives it the specified id. If the id is "*", Redis will assign it an id of the form "#{Time.utc.to_unix_ms}-#{autoincrementing_index}". If maxlen is provided, Redis will trim the stream to the specified length. If maxlen is of the form ~ 1000, Redis will trim it to approximately that length, removing entries when it can do so efficiently. This method returns the id that Redis stores.

redis.xadd "my-stream", "*", maxlen: {"~", "1000"}, fields: {"name" => "foo", "id" => UUID.random.to_s}

Append an entry with the specified data to the stream with the given key and gives it the specified id. If the id is "*", Redis will assign it an id of the form "#{Time.utc.to_unix_ms}-#{autoincrementing_index}". If maxlen is provided, Redis will trim the stream to the specified length. If maxlen is of the form ~ 1000, Redis will trim it to approximately that length, removing entries when it can do so efficiently. This method returns the id that Redis stores.

redis.xadd "my-stream", "*", {name: "foo", id: UUID.random.to_s}

DEPRECATED Using keyword arguments for stream event fields is deprecated and will be removed in a future release. It causes conflicts with optional maxlen and minid when passed as string values. Use the fields: {foo: "bar"} overload instead.

DEPRECATED Using keyword arguments for stream event fields is deprecated and will be removed in a future release. It causes conflicts with optional maxlen and minid when passed as string values. Use the fields: {foo: "bar"} overload instead.

Run a Redis XGROUP subcommand for a given stream. See the XGROUP command in the Redis documentation for more information.

redis.xgroup "DESTROY", "my-stream", "my-group"

Run a Redis XGROUP subcommand for a given stream. See the XGROUP command in the Redis documentation for more information.

redis.xgroup :create, "my-stream", "my-group", mkstream: true

Run a Redis XGROUP subcommand for a given stream. See the XGROUP command in the Redis documentation for more information.

redis.xgroup "CREATE", "my-stream", "my-group", "0"

Create the consumer group groupname in the stream contained in key.

Create a consumer consumer_name in the consumer group groupname in the stream contained in key.

consumer_id = UUID.v7.to_s
redis.xgroup_create "orders", "fulfillment", mkstream: true
redis.xgroup_create_consumer "orders", "fulfillment", consumer_id

Delete the given consumer from the given group in the stream stored in key.

Delete the consumer group group in the stream contained in key.

Return the details about the stream stored in key.

stream = Redis::Streaming::XInfoStreamResponse.new(
  redis.xinfo_stream("orders")
)
# => Redis::Streaming::XInfoStreamResponse(
#     @entries_added=1,
#     @first_entry=
#      Redis::Streaming::Message(
#       @delivery_count=0,
#       @id="1780361273088-0",
#       @last_delivered_at=1970-01-01 00:00:00Z,
#       @values={"id" => "0"}),
#     @groups=1,
#     @idmp_duration=100,
#     @idmp_maxsize=100,
#     @iids_added=0,
#     @iids_duplicates=0,
#     @iids_tracked=0,
#     @last_entry=
#      Redis::Streaming::Message(
#       @delivery_count=0,
#       @id="1780361273088-0",
#       @last_delivered_at=1970-01-01 00:00:00Z,
#       @values={"id" => "0"}),
#     @last_generated_id="1780361273088-0",
#     @length=1,
#     @max_deleted_entry_id="0-0",
#     @pids_tracked=0,
#     @radix_tree_keys=1,
#     @radix_tree_nodes=2,
#     @recorded_first_entry_id="1780361273088-0")

Return the number of entries in the given stream

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

Return the entries in the given stream between the start and end ids. If count is provided, Redis will return only that number of entries.

Execute an XREADGROUP command on the Redis server.

This is returned in its raw form from Redis, but you can pass it to a Redis::Streaming::XReadGroupResponse to make it easier to work with.

Execute an XREADGROUP command on the Redis server. If block is not nil, the server will block for up to that much time (if you pass a number, it will be interpreted as milliseconds) until any new messages enter the stream.

This is returned in its raw form from Redis, but you can pass it to a Redis::Streaming::XReadGroupResponse to make it easier to work with.

# Long-poll for up to 10 messages from the stream with key `my_stream`,
# blocking for up to 2 seconds if there are no messages waiting.
response = redis.xreadgroup "group", "consumer",
  streams: {my_stream: ">"},
  count: 10,
  block: 2.seconds
response = Redis::Streaming::XReadGroupResponse.new(response)

Return the entries in the given stream between the start and end ids. If count is provided, Redis will return only that number of entries.