redis.hset(hash_name, field, value)

assert redis.hexpireat(hash_name, field, int(time.time()) + 10) == [1]

Arguments

key
str
required

The key of the hash.

fields
Union[str, List[str]]
required

The field or list of fields to set an expiration time for.

timestamp
int
required

The expiration time as a Unix timestamp in seconds.

nx
bool

Set expiry only when the field has no expiry. Defaults to False.

xx
bool

Set expiry only when the field has an existing expiry. Defaults to False.

gt
bool

Set expiry only when the new expiry is greater than the current one. Defaults to False.

lt
bool

Set expiry only when the new expiry is less than the current one. Defaults to False.

Response

A list of integers indicating whether the expiry was successfully set.

  • -2 if the field does not exist in the hash or if the key doesn’t exist.
  • 0 if the expiration was not set due to the condition.
  • 1 if the expiration was successfully set.
  • 2 if called with 0 seconds/milliseconds or a past Unix time.

For more details, see HEXPIREAT documentation.

redis.hset(hash_name, field, value)

assert redis.hexpireat(hash_name, field, int(time.time()) + 10) == [1]