WAIT - Upstash Documentation

Use WAIT to block until preceding writes have been acknowledged by a number of replicas, or until a timeout expires.

The reply is the number of replicas that acknowledged, which can be lower than <numreplicas> when the timeout is reached, so callers must check it instead of assuming success. A timeout of 0 waits indefinitely.

WAIT raises the durability you can observe for a write, which is useful right before an action that must not be undone by a failover, such as replying to a payment webhook. It does not make Redis strongly consistent: an acknowledged write can still be lost if the primary and the acknowledging replicas fail together.

On Upstash the command waits for the writes enqueued before it began, including writes made by other connections, which is broader than the per-connection wording used by some Redis clients.

Syntax#

WAIT <numreplicas> <timeout>

Arguments#

Argument	Required	Repeatable	Description
`numreplicas`	Yes	No	Non-negative number of replicas that should acknowledge prior writes on this connection.
`timeout`	Yes	No	Maximum wait in milliseconds; `0` means no timeout.

Important points#

This deployment waits for writes enqueued before WAIT begins, including writes from other connections. That is broader than the per-connection wording used by Redis clients.
The reply can be lower than numreplicas when the timeout expires. This improves observed replication durability but does not make Redis a strongly consistent store.

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

WAIT 1 1000

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.wait("1", "1000");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.wait(1, 1000);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.wait("1", "1000")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "time"    "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.Wait(context.Background(), 1, time.Second).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.waitReplicas(1, 1000);  System.out.println(result);}

redis-rs

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 mut command = redis::cmd("WAIT");    command.arg("1");    command.arg("1000");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}