SEARCH.WAITINDEXING - Upstash Documentation

Use SEARCH.WAITINDEXING to block until all pending index updates are processed and visible to queries.

See Waiting for Indexing for guidance on when to wait for index updates.

The command accepts an index name or alias and waits for every update queued before the command began. Writes that arrive later may require another call.

Syntax#

SEARCH.WAITINDEXING <name>

Important points#

Warning

Do not call SEARCH.WAITINDEXING after every write. Batch updates are necessary for optimal indexing performance. Use this command only when you need to ensure queries reflect recent changes, such as in tests or CI pipelines.

Response#

Returns 1 when indexing is complete or 0 if the index was not found.

Examples#

Redis CLI

SEARCH.WAITINDEXING products

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const products = redis.search.index({ name: "products" });const result = await products.waitIndexing();

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()products = redis.search.index(name="products")result = products.wait_indexing()

ioredis

import IORedis from "ioredis";import { createSearch } from "@upstash/search-ioredis";const redis = new IORedis(process.env.REDIS_URL!);const search = createSearch(redis);const products = search.index({ name: "products" });const result = await products.waitIndexing();

node-redis

import { createClient } from "redis";import { createSearch } from "@upstash/search-redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const search = createSearch(client);const products = search.index({ name: "products" });const result = await products.waitIndexing();

curl

curl -X POST https://YOUR_ENDPOINT.upstash.io \  -H "Authorization: Bearer $UPSTASH_REDIS_REST_TOKEN" \  -d '["SEARCH.WAITINDEXING", "products"]'