XACKDEL - Upstash Documentation

Use XACKDEL to acknowledge entries in a consumer group and delete them from the stream in one atomic step.

It combines what XACK and XDEL do, which is what you want when a stream serves a single group and processed entries have no reason to stay around. IDS <numids> introduces the list of IDs and the count must match.

The reference policy controls what happens to consumer group references of the deleted entries: KEEPREF, the default, leaves references in other groups' pending lists in place, DELREF removes them everywhere, and ACKED only deletes entries that every group has read and acknowledged, leaving the rest in the stream. The reply holds one status code per requested ID, in the order they were given.

Syntax#

XACKDEL <key> <group>  [KEEPREF | DELREF | ACKED]  IDS <numids> <id> [<id> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<group>`	Yes	No	Consumer group name.
`(KEEPREF \| DELREF \| ACKED)`	No	No	What happens to consumer-group references of the deleted entries: `KEEPREF` (the default) leaves them in place, `DELREF` removes them from every group's pending list, and `ACKED` only removes entries that every group has read and acknowledged.
`IDS <numids> <id> [<id> ...]`	Yes	No	Entry IDs to target. Give the ID count first, then that many IDs.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Array of integer status codes, one per ID
RESP3	Array of integer status codes, one per ID

Status codes#

Code	Meaning
`1`	The entry was deleted.
`-1`	No entry with that ID exists in the stream.
`2`	The entry exists but was not deleted, because `ACKED` was requested and some group has not acknowledged it.

The codes come back in the order the IDs were given. An ID listed more than once is processed once, and every occurrence of it carries the same code.

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

XACKDEL my-key workers IDS 1 0-0

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();// Acknowledge and delete a single entryconst result = await redis.xackdel("mystream", "mygroup", "1638360173533-0");console.log(result); // Array of results for each ID

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.xackdel("my-key", "workers", "0-0")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("XACKDEL", "my-key", "workers", "IDS", "1", "0-0");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.xAckDel("my-key", "workers", "0-0");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.xackdel("my-key", "workers", "0-0")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.XAckDel(context.Background(), "my-key", "workers", "KEEPREF", "0-0").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.xackdel("my-key", "workers", new redis.clients.jedis.StreamEntryID("0-0"));  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.xack_del("my-key", "workers", &["0-0"], redis::streams::StreamDeletionPolicy::KeepRef)?;    println!("{result:?}");    Ok(())}