AI agent builder

XSETID

Syntax text Syntax diagram API methods

XSETID key last-id [ENTRIESADDED entries-added]
  [MAXDELETEDID max-deleted-id]

Client:

No method signature available for this client.

XSETID(
    key: RedisArgument,
    lastId: RedisArgument,
    options?: XSetIdOptions
) → Any

xsetid(
    $key: string,
    $lastId: string,
    ?int $entriesAdded = null: Any,
    ?string $maxDeleteId = null: Any
) → Status

XSETID is an internal command. Users should not call it directly.

Redis primary shards use it to replicate the last delivered entry ID of the stream.

Required arguments

key

The stream key.

last-id

The ID to set as the stream's last-generated ID.

ENTRIESADDED entries-added

Set the stream's entries-added counter.

MAXDELETEDID max-deleted-id

Set the stream's maximum deleted entry ID.

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

RESP2 RESP3

Simple string reply: OK.

Starting with Redis version 7.0.0: Added the entries_added and max_deleted_entry_id arguments.