Skip to main content
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

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.
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.