HGETDEL - Upstash Documentation

Use HGETDEL to read hash fields and delete them in the same atomic step.

The reply holds the previous value of each requested field, in the order requested, with null for fields that were not present. Reading and removing together removes the race that an HGET followed by an HDEL would leave open, which makes the command a good fit for one-shot values such as one-time codes, claim tickets, or queued items keyed by name: exactly one caller gets the value.

FIELDS <numfields> introduces the field list and the count must match. The key is deleted when its last field is removed.

Syntax#

HGETDEL <key> FIELDS <numfields> <field> [<field> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`FIELDS <numfields> <field> [<field> ...]`	Yes	No	Fields to target. Give the field count first, then that many field names.

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 values or null values, one per field
RESP3	Array of bulk-string values or null values, one per field

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

HGETDEL my-key FIELDS 1 field

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();// Set some hash fieldsawait redis.hset("user:123", { name: "John", age: "30", email: "john@example.com" });// Get and delete specific fieldsconst result = await redis.hgetdel("user:123", "name", "email");console.log(result); // { name: "John", email: "john@example.com" }// Verify fields were deletedconst name = await redis.hget("user:123", "name");console.log(name); // null

upstash_redis

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

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.hgetdel("my-key", "field")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.HGetDel(context.Background(), "my-key", "1", "field").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.hgetdel("my-key", "1", "field");  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.hget_del("my-key", &["field"])?;    println!("{result:?}");    Ok(())}