VECTOR.DROP - Upstash Documentation

Use VECTOR.DROP to delete a vector index and every vector in it. The reply is 1 when an index was removed and 0 when the key held nothing, so the call is safe to repeat. Since an index occupies an ordinary key, DEL and UNLINK remove it too; VECTOR.DROP is the form that says what is being removed and refuses to touch a key holding another type. Vector indexes are an Upstash extension. See the vector command overview for how an index is created, written to, and queried.

Syntax

VECTOR.DROP <index>

Arguments

Argument	Required	Repeatable	Description
`<index>`	Yes	No	Key holding the vector index.

Important points

Dropping an index that does not exist replies 0 rather than raising an error.
A key holding a value that is not a vector index returns WRONGTYPE.

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: `1` if the index was dropped, `0` if it did not exist
RESP3	Integer: `1` if the index was dropped, `0` if it did not exist

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

VECTOR.DROP my-index

@upstash/redis

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

upstash_redis

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.call("VECTOR.DROP", "my-index");
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.sendCommand(["VECTOR.DROP", "my-index"]);
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.execute_command("VECTOR.DROP", "my-index")
print(result)

go-redis

package main

import (
    "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.Do(context.Background(), "VECTOR.DROP", "my-index").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.sendCommand(() -> "VECTOR.DROP".getBytes(), "my-index");
  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("VECTOR.DROP");
    command.arg("my-index");
    let result: redis::Value = command.query(&mut connection)?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples