PEXPIREAT

Syntax text Syntax diagram API methods

PEXPIREAT key unix-time-milliseconds [NX | XX | GT | LT]

Client:

pexpireat(
    name: KeyT,
    when: AbsExpiryT,
    nx: bool,
    xx: bool,
    gt: bool,
    lt: bool
) → int

PEXPIREAT(
    key: RedisArgument,
    millisecondsTimestamp: number,
    mode?: 'NX' | 'XX' | 'GT' | 'LT'
) → Any

pexpireAt(
    key: byte[],
    millisecondsTimestamp: long  // timestamp in milliseconds
) → long  // 1 if the timeout was set, 0 otherwise

pexpireAt(
    key: byte[],
    millisecondsTimestamp: long,  // timestamp in milliseconds
    expiryOption: ExpiryOption  // can be NX, XX, GT or LT
) → long  // 1 if the timeout was set, 0 otherwise

pexpireAt(
    key: String,
    millisecondsTimestamp: long  // timestamp in milliseconds
) → long  // 1 if the timeout was set, 0 otherwise

pexpireAt(
    key: String,
    millisecondsTimestamp: long,  // timestamp in milliseconds
    expiryOption: ExpiryOption  // can be NX, XX, GT or LT
) → long  // 1 if the timeout was set, 0 otherwise

pexpireat(
    key: K,  // the key.
    timestamp: long  // the milliseconds-timestamp.
) → Boolean  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp.
    expireArgs: ExpireArgs  // the expiry arguments.
) → Boolean  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireat(
    key: K,  // the key.
    timestamp: Date  // the milliseconds-timestamp.
) → Boolean  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireat(
    key: K,  // the key.
    timestamp: Date,  // the milliseconds-timestamp.
    expireArgs: ExpireArgs  // the expiry arguments.
) → Boolean  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireat(
    key: K,  // the key.
    timestamp: long  // the milliseconds-timestamp.
) → RedisFuture<Boolean>  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp.
    expireArgs: ExpireArgs  // the expiry arguments.
) → RedisFuture<Boolean>  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireat(
    key: K,  // the key.
    timestamp: long  // the milliseconds-timestamp.
) → Mono<Boolean>  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireat(
    key: K,  // the key.
    timestamp: long,  // the milliseconds-timestamp.
    expireArgs: ExpireArgs  // the expiry arguments.
) → Mono<Boolean>  // Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set.

PExpireAt(
    ctx: context.Context,
    key: string,
    tm: time.Time
) → *BoolCmd

KeyExpire(
    key: RedisKey,  // The key to set the expiration for.
    expiry: DateTime?,  // The exact date to expire at.
    when: ExpireWhen,  // In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the timeout was set. false if key does not exist or the timeout could not be set.

KeyExpireAsync(
    key: RedisKey,  // The key to set the expiration for.
    expiry: DateTime?,  // The exact date to expire at.
    when: ExpireWhen,  // In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<bool>  // true if the timeout was set. false if key does not exist or the timeout could not be set.

pexpireAt(
    $key: string,
    $timestamp: int,
    $expireOption: string
) → int

Available since:: Redis Open Source 2.6.0
Time complexity:: O(1)
ACL categories:: @keyspace, @write, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

PEXPIREAT has the same effect and semantic as EXPIREAT, but the Unix time at which the key will expire is specified in milliseconds instead of seconds.

Required arguments

key

The name of the key to set a timeout on.

unix-time-milliseconds

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

Optional arguments

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

NX

Set expiry only when the key has no expiry.

XX

Set expiry only when the key has an existing expiry.

GT

Set expiry only when the new expiry is greater than the current one. A non-volatile key is treated as an infinite TTL for the purpose of GT.

LT

Set expiry only when the new expiry is less than the current one. A non-volatile key is treated as an infinite TTL for the purpose of LT.

Examples

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: 1 if the timeout was set.
Integer reply: 0 if the timeout was not set. For example, if the key doesn't exist, or the operation was skipped due to the provided arguments.

History

Starting with Redis version 7.0.0: Added options: NX, XX, GT and LT.