# HSETEX

> Set fields with expiration.

Use `HSETEX` to write hash fields and set their expiration in the same atomic call.

`FIELDS <numfields>` introduces the field and value pairs and the count must match. `EX`, `PX`, `EXAT`, and `PXAT` give the written fields a lifetime or an absolute deadline, and `KEEPTTL` keeps whatever expiration those fields already had. Without any of these options the fields are written without an expiration, so a previously set one is dropped.

`FNX` writes only when none of the given fields exist and `FXX` only when all of them do, which turns the command into an atomic conditional write: create-if-absent or update-if-present, with the expiration applied in the same step. The reply is `1` when the fields were written and `0` when the condition prevented it.

## Syntax

```redis
HSETEX <key>
  [FNX | FXX]
  [EX <seconds> | PX <milliseconds> | EXAT <unix-time-seconds> |
    PXAT <unix-time-milliseconds> | KEEPTTL]
  FIELDS <numfields> <field> <value> [<field> <value> ...]
```

## Arguments

| Argument | Required | Repeatable | Description |
| --- | --- | --- | --- |
| `<key>` | Yes | No | Redis key targeted by the command. |
| `(FNX \| FXX)` | No | No | Write only when the condition holds: `FNX` when none of the given fields exist, `FXX` when all of them do. |
| `(EX <seconds> \| PX <milliseconds> \| EXAT <unix-time-seconds> \| PXAT <unix-time-milliseconds> \| KEEPTTL)` | No | No | Choose one form: `EX` (set a lifetime in seconds); `PX` (set a lifetime in milliseconds); `EXAT` (expire at a Unix timestamp in seconds); `PXAT` (expire at a Unix timestamp in milliseconds); `KEEPTTL` (preserve the existing key lifetime). |
| `FIELDS <numfields> <field> <value> [<field> <value> ...]` | Yes | No | Field-value pairs to set. Give the pair count first, then that many field and value pairs. |

## 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 | Integer: `1` if the fields were set, `0` otherwise |
| RESP3 | Integer: `1` if the fields were set, `0` otherwise |

<Note>
  Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.
</Note>

## Examples

TCP examples use the TLS `REDIS_URL` from the Upstash console. REST examples use `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN`.

<AccordionGroup>

<Accordion title="Redis CLI" icon="terminal">

```bash
HSETEX my-key FIELDS 1 field value
```

</Accordion>

<Accordion title="@upstash/redis" icon="node-js" iconType="brands">

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

const redis = Redis.fromEnv();

// Set fields with 1 hour expiration
await redis.hsetex("user:123", { expiration: { ex: 3600 } }, {
  name: "John",
  email: "john@example.com"
});
```

</Accordion>

<Accordion title="upstash_redis" icon="python" iconType="brands">

```python
from upstash_redis import Redis

redis = Redis.from_env()
result = redis.hsetex("my-key", field="field", value="value")
print(result)
```

</Accordion>

<Accordion title="ioredis" icon="node-js" iconType="brands">

```ts
import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.hsetex("my-key", "FIELDS", "1", "field", "value");
console.log(result);
```

</Accordion>

<Accordion title="node-redis" icon="node-js" iconType="brands">

```ts
import { createClient } from "redis";

const client = await createClient({ url: process.env.REDIS_URL })
  .on("error", console.error)
  .connect();
const result = await client.hSetEx("my-key", { field: "value" });
console.log(result);
```

</Accordion>

<Accordion title="redis-py" icon="python" iconType="brands">

```python
import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.hsetex("my-key", mapping={"field": "value"})
print(result)
```

</Accordion>

<Accordion title="go-redis" icon="golang" iconType="brands">

```go
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.HSetEX(context.Background(), "my-key", "1", "field", "value").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(result)
}
```

</Accordion>

<Accordion title="jedis" icon="java" iconType="brands">

```java
import java.net.URI;

import redis.clients.jedis.Jedis;

try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.hsetex("my-key", redis.clients.jedis.params.HSetExParams.hSetExParams(), "field", "value");
  System.out.println(result);
}
```

</Accordion>

<Accordion title="redis-rs" icon="rust" iconType="brands">

```rust
use redis::{HashFieldExpirationOptions, 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.hset_ex(
        "my-key",
        &HashFieldExpirationOptions::default(),
        &[("field", "value")],
    )?;
    println!("{result:?}");
    Ok(())
}
```

</Accordion>

</AccordionGroup>