HGETEX - Upstash Documentation

The HGETEX command returns the values of the specified fields and optionally sets their expiration time or TTL. This allows you to retrieve hash data while managing its lifetime in a single operation.

Arguments#

keystrrequired#

The key of the hash.

fields*List[str]required#

One or more field names to get.

exint#

Set expiration time in seconds.

pxint#

Set expiration time in milliseconds.

exatint#

Set expiration as Unix timestamp in seconds.

pxatint#

Set expiration as Unix timestamp in milliseconds.

persistbool#

Remove expiration from the hash.

Response#

Use Cases#

Session Management: Retrieve session data and extend its lifetime
Cache Refresh: Get cached data and update its TTL
Temporary Data: Access temporary data while managing its expiration
Rate Limiting: Fetch rate limit data and reset expiration

redis.hset("user:123", values={"name": "John", "email": "john@example.com"})# Get fields and set expiration to 60 secondsresult = redis.hgetex("user:123", "name", "email", ex=60)assert result == ["John", "john@example.com"]