Upstash Documentation

HEXPIRE

Sets an expiration time for one or more fields in a hash.
1 min read

Arguments#

keystringrequired#

The key of the hash.

fieldstring | number | (string | number)[]required#

The field or fields to set an expiration time for.

secondsnumberrequired#

The time-to-live (TTL) in seconds.

optionstring#

Optional condition for setting the expiration:

  • NX: Set the expiration only if the field does not already have an expiration.
  • XX: Set the expiration only if the field already has an expiration.
  • GT: Set the expiration only if the new TTL is greater than the current TTL.
  • LT: Set the expiration only if the new TTL is less than the current TTL.

Response#

HEXISTSHEXPIREAT