VECTOR.COUNT - Upstash Documentation

Use VECTOR.COUNT to get the number of vectors currently stored in an index.

Replacing the vector under an existing ID does not change the count, since the ID is what is counted. An index that does not exist counts as 0 rather than raising an error, so the command can be used as a cheap emptiness check without a prior EXISTS.

Vector indexes are an Upstash extension. See the vector command overview for how an index is created, written to, and queried.

Syntax#

VECTOR.COUNT <index>

Arguments#

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

Important points#

An index that does not exist replies 0. Use VECTOR.INFO, which replies null, to tell an empty index from a missing one.

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

VECTOR.COUNT my-index

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.execute_command("VECTOR.COUNT", "my-index")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.Do(context.Background(), "VECTOR.COUNT", "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.COUNT".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.COUNT");    command.arg("my-index");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}