SEARCH.ALIASDEL - Upstash Documentation

Use SEARCH.ALIASDEL to remove a search index alias.

Only the alias is removed: the index it pointed to, and the documents indexed in it, are untouched and remain reachable under their real name. Queries that still use the alias fail once it is gone.

See Deleting an Alias for the feature guide.

Syntax#

SEARCH.ALIASDEL <alias>

Response#

Returns 1 if the alias was deleted or 0 if the alias was not found.

Examples#

Redis CLI

SEARCH.ALIASDEL products

@upstash/redis

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

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.search.alias.delete(alias="products")

ioredis

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

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 result = await search.alias.delete({ alias: "products" });

curl

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