RANDOMKEY - Upstash Documentation

Use RANDOMKEY to get the name of a random key from the database without reading its value.

The reply is null when the database is empty. Keys are picked by sampling the keyspace rather than by drawing uniformly from it, and nothing prevents the same key from coming up repeatedly, so treat it as a way to look at a sample of your data while debugging rather than as a way to iterate over it. Use SCAN when you need to cover every key.

Syntax#

RANDOMKEY

Arguments#

This command takes no arguments.

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	Null bulk string or null array or Bulk string
RESP3	Null or Bulk string

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

RANDOMKEY

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const key = await redis.randomkey();

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.randomkey()print(result)

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.randomkey()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.RandomKey(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.randomKey();  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("RANDOMKEY");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}