XTRIM - Upstash Documentation

Arguments

keybodystringrequired

The key of the stream.

optionsbodyobjectrequired

strategybody'MAXLEN' | 'MINID'required

The trimming strategy:

thresholdbodynumber | stringrequired

The threshold value for trimming:

For MAXLEN: The maximum number of entries to keep (number)
For MINID: The minimum ID to keep (string). Entries with IDs lower than this will be removed

exactnessbody'~' | '='

Use ~ for approximate trimming (more efficient, default) or = for exact trimming.

limitbodynumber

Limit how many entries will be trimmed at most (only valid with approximate trimming ~).

number

The number of entries removed from the stream.

Approximate trim by max length

const result = await redis.xtrim("mystream", {  strategy: "MAXLEN",  threshold: 100,  exactness: "~"});

Exact trim by max length

const result = await redis.xtrim("mystream", {  strategy: "MAXLEN",   threshold: 50,  exactness: "="});

Trim by minimum ID

const result = await redis.xtrim("mystream", {  strategy: "MINID",  threshold: "1638360173533-0",  exactness: "="});

Approximate trim with limit

const result = await redis.xtrim("mystream", {  strategy: "MAXLEN",  threshold: 1000,  exactness: "~",  limit: 100});