GETDEL - Upstash Documentation

Use GETDEL to read the value of a key and delete the key in the same atomic step.

The reply is the value, or null when the key does not exist, and an error when the value is not a string. Because nothing can run between the read and the delete, exactly one caller can obtain the value, which is what makes it right for one-shot data such as a one-time token, a password reset code, or a handoff between two processes. It replaces the GET plus DEL pair and its race.

Syntax#

GETDEL <key>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	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	Bulk string or Null bulk string or null array
RESP3	Bulk string or Null

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

GETDEL my-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();type MyType = {    a: number;    b: string;}await redis.getdel<MyType>("key");// returns {a: 1, b: "2"}

upstash_redis

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

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.getdel("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.GetDel(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.getDel("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.get_del("my-key")?;    println!("{result:?}");    Ok(())}