KEYS - Upstash Documentation

Use KEYS to list every key in the database whose name matches a glob-style pattern. The pattern supports * for any sequence of characters, ? for a single character, [...] for character classes, and \ to escape a literal, so user:*:session matches all session keys of all users and * matches everything. The command walks the entire keyspace and returns all matches in one reply, which on a database of any real size means a long block and a very large response. Treat it as a debugging and maintenance tool: on hot paths use SCAN, which accepts the same MATCH patterns but walks the keyspace in small batches, or keep an index of your keys in a set instead.

Syntax

KEYS <pattern>

Arguments

Argument	Required	Repeatable	Description
`<pattern>`	Yes	No	Glob-style pattern to match keys against.

Important points

This command can expose administrative information or make a broad destructive change. Restrict it to trusted code paths.
This operation can inspect a large part of the database. Prefer cursor-based scans where possible and avoid unbounded use on hot paths.

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	Array of bulk-string keys
RESP3	Array of bulk-string keys

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

KEYS *

@upstash/redis

import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();

const keys = await redis.keys("prefix*");

upstash_redis

from upstash_redis import Redis

redis = Redis.from_env()
result = redis.keys("*")
print(result)

ioredis

import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.keys("*");
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.keys("*");
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.keys("*")
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.Keys(context.Background(), "*").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.keys("*");
  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.keys("*")?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples