HSETEX

Syntax text Syntax diagram API methods

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

Client:

hsetex(
    name: str,
    key: Optional[str] = None,
    value: Optional[str] = None,
    mapping: Optional[dict] = None,
    items: Optional[list] = None,
    ex: Optional[ExpiryT] = None,
    px: Optional[ExpiryT] = None,
    exat: Optional[AbsExpiryT] = None,
    pxat: Optional[AbsExpiryT] = None,
    data_persist_option: Optional[HashDataPersistOptions] = None,
    keepttl: bool = False
) → Union[Awaitable[int], int]

hsetex(
    key: byte[],
    params: HSetExParams,
    field: byte[],
    value: byte[]
) → long  // If the field already exists, and the HSET just produced an update of the value, 0 is returned, otherwise if a new field is created 1 is returned.

hsetex(
    key: byte[],
    params: HSetExParams,
    hash: Map<byte[], byte[]>
) → long  // If the field already exists, and the HSET just produced an update of the value, 0 is returned, otherwise if a new field is created 1 is returned.

hsetex(
    key: String,
    params: HSetExParams,
    field: String,
    value: String
) → long  // If the field already exists, and the HSET just produced an update of the value, 0 is returned, otherwise if a new field is created 1 is returned.

hsetex(
    key: String,
    params: HSetExParams,
    hash: Map<String, String>
) → long  // If the field already exists, and the HSET just produced an update of the value, 0 is returned, otherwise if a new field is created 1 is returned.

hsetex(
    key: K,  // the key of the hash.
    map: Map<K, V>  // the field/value pairs to update.
) → Long  // Long long-reply: 0 if no fields were set, 1 if all the fields were set @since 6.6

hsetex(
    key: K,  // the key of the hash.
    hSetExArgs: HSetExArgs,  // hsetex arguments.
    map: Map<K, V>  // the field/value pairs to update.
) → Long  // Long long-reply: 0 if no fields were set, 1 if all the fields were set @since 6.6

hsetex(
    key: K,  // the key of the hash.
    map: Map<K, V>  // the field/value pairs to update.
) → RedisFuture<Long>  // Long long-reply: 0 if no fields were set, 1 if all the fields were set @since 6.6

hsetex(
    key: K,  // the key of the hash.
    hSetExArgs: HSetExArgs,  // hsetex arguments.
    map: Map<K, V>  // the field/value pairs to update.
) → RedisFuture<Long>  // Long long-reply: 0 if no fields were set, 1 if all the fields were set @since 6.6

hsetex(
    key: K,  // the key of the hash.
    map: Map<K, V>  // the field/value pairs to update.
) → Mono<Long>  // Long long-reply: 0 if no fields were set, 1 if all the fields were set @since 6.6

hsetex(
    key: K,  // the key of the hash.
    hSetExArgs: HSetExArgs,  // hsetex arguments.
    map: Map<K, V>  // the field/value pairs to update.
) → Mono<Long>  // Long long-reply: 0 if no fields were set, 1 if all the fields were set @since 6.6

HSetEX(
    ctx: context.Context,
    key: string,
    fieldsAndValues: ...string
) → *IntCmd

hsetex(
    $key: string,
    $fieldValueMap: array,
    string $setModifier = HSETEX::SET_NULL: Any,
    string $ttlModifier = HSETEX::TTL_NULL: Any,
    int|bool $ttlModifierValue = false: Any
) → int

hset_ex(
    key: K,
    hash_field_expiration_options: &'a HashFieldExpirationOptions,
    fields_values: &'a [(F, V)]
) → (bool)

hset_ex(
    key: K,
    hash_field_expiration_options: &'a HashFieldExpirationOptions,
    fields_values: &'a [(F, V)]
) → (bool)

Available since:: Redis Open Source 8.0.0
Time complexity:: O(N) where N is the number of fields being set.
ACL categories:: @write, @hash, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Set the value of one or more fields of a given hash key and optionally set their expiration time or time-to-live (TTL). If the given key already holds a value, it is overwritten and any previous TTLs associated with the key are discarded.

Required arguments

key

The name of the key that holds the hash.

FIELDS numfields field value [field value ...]

The hash field-value pairs to set. numfields is the number of fields, followed by that many field-value pairs.

Optional arguments

The following options modify the command's behavior. The EX, PX, EXAT, PXAT, and KEEPTTL options are mutually exclusive.

FNX

Only set the fields if none of them already exist. FNX and FXX are mutually exclusive.

FXX

Only set the fields if all of them already exist.

EX seconds

Set the specified expiration time, in seconds.

PX milliseconds

Set the specified expiration time, in milliseconds.

EXAT unix-time-seconds

Set the specified Unix time, in seconds, at which the fields will expire.

PXAT unix-time-milliseconds

Set the specified Unix time, in milliseconds, at which the fields will expire.

KEEPTTL

Retain the TTL associated with the fields.

Examples

redis> HSETEX mykey EXAT 1740470400 FIELDS 2 field1 "Hello" field2 "World"
(integer) 1
redis> HTTL mykey FIELDS 2 field1 field2
1) (integer) 55627
2) (integer) 55627
redis> HSETEX mykey FNX EX 60 FIELDS 2 field1 "Hello" field2 "World"
(integer) 0
redis> HSETEX mykey FXX EX 60 KEEPTTL FIELDS 2 field1 "hello" field2 "world"
(error) ERR Only one of EX, PX, EXAT, PXAT or KEEPTTL arguments can be specified
redis> HSETEX mykey FXX KEEPTTL FIELDS 2 field1 "hello" field2 "world"
(integer) 1
redis> HTTL mykey FIELDS 2 field1 field2
1) (integer) 55481
2) (integer) 55481

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

One of the following:

Integer reply: 0 if no fields were set.
Integer reply: 1 if all the fields wereset.