HPEXPIREAT

Syntax text Syntax diagram API methods

HPEXPIREAT key unix-time-milliseconds [NX | XX | GT | LT]
  FIELDS numfields field [field ...]

Client:

hpexpireat(
    name: KeyT,
    unix_time_milliseconds: AbsExpiryT,
    *fields: str,
    nx: bool = False,
    xx: bool = False,
    gt: bool = False,
    lt: bool = False
) → ResponseT

HPEXPIREAT(
    key: RedisArgument,
    fields: RedisVariadicArgument,
    timestamp: number | Date,
    mode?: 'NX' | 'XX' | 'GT' | 'LT'
) → Any

hpexpireAt(
    key: byte[],
    unixTimeMillis: long,
    fields: byte[]...
) → List<Long>

hpexpireAt(
    key: byte[],
    unixTimeMillis: long,
    condition: ExpiryOption,
    fields: byte[]...
) → List<Long>

hpexpireAt(
    key: String,
    unixTimeMillis: long,
    fields: String...
) → List<Long>

hpexpireAt(
    key: String,
    unixTimeMillis: long,
    condition: ExpiryOption,
    fields: String...
) → List<Long>

hpexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → List<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp type: posix time.
    expireArgs: ExpireArgs,  // the expiry arguments.
    fields: K...  // one or more fields to set the TTL for.
) → List<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Date,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → List<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Date,  // the milliseconds-timestamp type: posix time.
    expireArgs: ExpireArgs,  // the expiry arguments.
    fields: K...  // one or more fields to set the TTL for.
) → List<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Instant,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → List<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → RedisFuture<List<Long>>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp type: posix time.
    expireArgs: ExpireArgs,  // the expiry arguments.
    fields: K...  // one or more fields to set the TTL for.
) → RedisFuture<List<Long>>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Date,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → RedisFuture<List<Long>>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Date,  // the milliseconds-timestamp type: posix time.
    expireArgs: ExpireArgs,  // the expiry arguments.
    fields: K...  // one or more fields to set the TTL for.
) → RedisFuture<List<Long>>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Instant,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → RedisFuture<List<Long>>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → Flux<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp type: posix time.
    expireArgs: ExpireArgs,  // the expiry arguments.
    fields: K...  // one or more fields to set the TTL for.
) → Flux<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Date,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → Flux<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Date,  // the milliseconds-timestamp type: posix time.
    expireArgs: ExpireArgs,  // the expiry arguments.
    fields: K...  // one or more fields to set the TTL for.
) → Flux<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

hpexpireat(
    key: K,  // the key.
    timestamp: Instant,  // the milliseconds-timestamp type: posix time.
    fields: K...  // one or more fields to set the TTL for.
) → Flux<Long>  // a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field @since 6.4

HPExpireAt(
    ctx: context.Context,
    key: string,
    tm: time.Time,
    fields: ...string
) → *IntSliceCmd

hpexpireat(
    $key: string,
    $unixTimeMilliseconds: int,
    $fields: array,
    string $flag = null: Any
) → array|null

hpexpire_at(
    key: K,
    ts: i64,
    opt: ExpireOption,
    fields: F
) → (Vec<IntegerReplyOrNoOp>)

hpexpire_at(
    key: K,
    ts: i64,
    opt: ExpireOption,
    fields: F
) → (Vec<IntegerReplyOrNoOp>)

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

HPEXPIREAT has the same effect and semantics as HEXPIREAT, but the Unix time at which the field will expire is specified in milliseconds since Unix epoch instead of seconds.

Required arguments

key

The name of the key that holds the hash.

unix-time-milliseconds

The absolute Unix expiration timestamp, in milliseconds since Unix epoch. A timestamp in the past deletes the field immediately.

FIELDS numfields field [field ...]

The hash fields to operate on. numfields is the number of fields, followed by that many field names.

Optional arguments

The following options modify the command's behavior. They are mutually exclusive.

NX

For each specified field, set expiration only when the field has no expiration.

XX

For each specified field, set expiration only when the field has an existing expiration.

GT

For each specified field, set expiration only when the new expiration is greater than the current one. A non-volatile key is treated as an infinite TTL for the purposes of GT.

LT

For each specified field, set expiration only when the new expiration is less than the current one. A non-volatile key is treated as an infinite TTL for the purposes of LT.

Examples

redis> HSET mykey field1 "hello" field2 "world"
(integer) 2
redis> HPEXPIREAT mykey 1715704971000 FIELDS 2 field1 field2
1) (integer) 1
2) (integer) 1
redis> HPTTL mykey FIELDS 2 field1 field2
1) (integer) 303340
2) (integer) 303340

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:

Array reply. For each field:
- Integer reply: -2 if no such field exists in the provided hash key, or the provided key does not exist.
- Integer reply: 0 if the specified NX, XX, GT, or LT condition has not been met.
- Integer reply: 1 if the expiration time was set/updated.
- Integer reply: 2 when HEXPIRE or HPEXPIRE is called with 0 seconds or milliseconds, or when HEXPIREAT or HPEXPIREAT is called with a past Unix time in seconds or milliseconds.
Simple error reply:
- if parsing failed, mandatory arguments are missing, unknown arguments are specified, or argument values are of the wrong type or out of range.
- if the provided key exists but is not a hash.

One of the following:

Array reply. For each field:
- Integer reply: -2 if no such field exists in the provided hash key, or the provided key does not exist.
- Integer reply: 0 if the specified NX, XX, GT, or LT condition has not been met.
- Integer reply: 1 if the expiration time was set/updated.
- Integer reply: 2 when HEXPIRE or HPEXPIRE is called with 0 seconds or milliseconds, or when HEXPIREAT or HPEXPIREAT is called with a past Unix time in seconds or milliseconds.
Simple error reply:
- if parsing failed, mandatory arguments are missing, unknown arguments are specified, or argument values are of the wrong type or out of range.
- if the provided key exists but is not a hash.