EXISTS - Upstash Documentation

Use EXISTS to check whether one or more keys exist.

The reply is the number of the given keys that exist, so with a single key it is simply 1 or 0. A key listed several times is counted each time it is present, which means EXISTS k k returns 2 when k exists. Checking existence never transfers the value, so it stays cheap even for large values.

Syntax#

EXISTS <key> [<key> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	Yes	Redis key targeted by the command.

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

EXISTS my-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.set("key1", "value1")await redis.set("key2", "value2")const keys = await redis.exists("key1", "key2", "key3");console.log(keys) // 2

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.exists("my-key")print(result)

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.exists("my-key")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.Exists(context.Background(), "my-key").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.exists("my-key");  System.out.println(result);}

redis-rs

use redis::TypedCommands;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 result = connection.exists("my-key")?;    println!("{result:?}");    Ok(())}