HSETEX

Set hash fields with expiration support.

The HSETEX command sets the specified fields with their values and optionally sets their expiration time or TTL. It supports conditional operations to control when fields should be set.

Arguments

key · string · required

The key of the hash.

options · object

Options for conditional setting and expiration.

Show properties

conditional · 'FNX' | 'fnx' | 'FXX' | 'fxx'

Conditional setting options (case-insensitive):

• FNX: Only set fields if the hash does not exist
• FXX: Only set fields if the hash already exists

expiration · object

Expiration options for the hash.

Show expiration

ex · number

Set expiration time in seconds.

px · number

Set expiration time in milliseconds.

exat · number

Set expiration as Unix timestamp in seconds.

pxat · number

Set expiration as Unix timestamp in milliseconds.

keepttl · true

Retain the existing time to live (TTL) associated with the hash key when setting fields. If the hash has an expiration, it will be preserved. Set to true to enable.

fields · { [fieldName]: TValue } · required

An object of fields and their values to set.

Response

The number of fields that were set. Returns 0 if conditions are not met (e.g., conditional: "FNX" but hash exists, or conditional: "FXX" but hash doesn’t exist).

Basic Example

// Set fields with 1 hour expiration
await redis.hsetex("user:123", { expiration: { ex: 3600 } }, { 
  name: "John", 
  email: "[e-mail]" 
});

Use Cases

• Session Management: Create sessions with automatic expiration
• Cache with TTL: Store cached data that expires automatically
• Temporary Data: Create temporary records with built-in cleanup
• Rate Limiting: Store rate limit counters with automatic reset
• Conditional Updates: Ensure data consistency with FNX/FXX options