HEXPIRE - Upstash Documentation

Use HEXPIRE to give individual hash fields a lifetime in seconds, after which those fields are removed from the hash. Expiration here is per field, not per key: the hash itself stays alive as long as it still has fields, and the key is deleted automatically when the last surviving field expires. This makes it possible to keep short-lived and long-lived data in one hash, for example a user record whose verification code expires while the rest of the record stays. FIELDS <numfields> introduces the list of fields and the count must match the number of names that follow. The optional condition works as it does on EXPIRE: NX only when the field has no expiration, XX only when it already has one, GT only when the new expiration is later than the current one, and LT only when it is earlier. The reply holds one status code per field, in order: 1 when the expiration was set, 0 when the condition prevented it, 2 when the field was deleted immediately because the given lifetime was zero or negative, and -2 when the field does not exist.

Syntax

HEXPIRE <key> <seconds>
  [NX | XX | GT | LT]
  FIELDS <numfields> <field> [<field> ...]

Arguments

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<seconds>`	Yes	No	Lifetime in seconds.
`(NX \| XX \| GT \| LT)`	No	No	Choose one form: `NX` (only when the field has no expiration); `XX` (only when the field already has one); `GT` (only when the new expiration is later than the current one); `LT` (only when it is earlier).
`FIELDS <numfields> <field> [<field> ...]`	Yes	No	Fields to target. Give the field count first, then that many field names.

Important points

NX cannot be combined with XX, GT, or LT, and GT and LT cannot be used together.
A field with no expiration counts as an infinite one, so GT never sets an expiration on such a field and LT always does.

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 integer status codes, one per field
RESP3	Array of integer status codes, one per field

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

HEXPIRE my-key 1000 FIELDS 1 field

@upstash/redis

import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();

await redis.hset("my-key", "my-field", "my-value");
const expirationSet = await redis.hexpire("my-key", "my-field", 1);

console.log(expirationSet); // 1

upstash_redis

from upstash_redis import Redis

redis = Redis.from_env()
result = redis.hexpire("my-key", "field", 1000)
print(result)

ioredis

import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.hexpire("my-key", "1000", "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.hExpire("my-key", "field", 1000);
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.hexpire("my-key", 1000, "field")
print(result)

go-redis

package main

import (
    "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.HExpire(context.Background(), "my-key", 1000*time.Second, "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.hexpire("my-key", 1000, "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.hexpire("my-key", 1000, redis::ExpireOption::NONE, &["field"])?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples