XIDMPRECORD

XIDMPRECORD key pid iid stream-id
Available since:
Redis Open Source 8.8.0
Time complexity:
O(1)
ACL categories:
@write, @stream, @fast,
Compatibility:
Redis Software and Redis Cloud compatibility

XIDMPRECORD is an internal command for setting IDMP metadata on an existing stream message, which would be replayed during AOF loading. Users should not call this command directly.

Required arguments

key

is the name of a stream key.

pid

is a producer ID.

iid

is an IDMP (idempotency) ID.

stream-id

is the ID of an existing stream message.

Redis Software and Redis Cloud compatibility

Redis
Software
Redis
Cloud
Notes
❌ Standard
❌ Active-Active
❌ Standard
❌ Active-Active

Return information

One of the following:

  • A simple string reply - OK when the provided pid/iid pair already maps to the same stream ID (that is, the command is idempotent).
  • A simple error reply in one of the following cases:
    • the key does not exist
    • the key does not refer to a stream
    • the stream ID refers to an non-existent or deleted entry
    • pid and/or iid are empty
    • the pid/iid pair already maps to a different stream ID
RATE THIS PAGE
Back to top ↑