XTRIM - Upstash Documentation

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

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

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

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

Arguments

key

string

required

The key of the stream.

options

object

required

Show properties

strategy

'MAXLEN' | 'MINID'

required

The trimming strategy:

threshold

number | string

required

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

exactness

'~' | '='

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

limit

number

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

The number of entries removed from the stream.

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

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

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

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

⌘I