XACK - Upstash Documentation

Use XACK to tell a consumer group that entries have been processed.

Acknowledged entries leave the group's pending entries list, so they are no longer counted as in flight and can no longer be claimed by another consumer. The reply counts the IDs that were actually pending, which means acknowledging twice is harmless and returns 0 the second time.

Acknowledging does not delete the entry from the stream: other groups still see it, and it stays until trimmed. Use XACKDEL when the entry should also be removed.

Syntax#

XACK <key> <group> <ID> [<ID> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<group>`	Yes	No	Consumer group name.
`<ID>`	Yes	Yes	Stream entry ID.

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	Integer
RESP3	Integer

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

XACK my-key workers 0-0

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const result = await redis.xack("mystream", "mygroup", "1638360173533-0");

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.xack("my-key", "workers", "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.xAck("my-key", "workers", "0-0");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.xack("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.XAck(context.Background(), "my-key", "workers", "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.xack("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("my-key", "workers", &["0-0"])?;    println!("{result:?}");    Ok(())}