EXPIRETIME

Syntax text Syntax diagram API methods

EXPIRETIME key

Client:

expiretime(
    key: KeyT
) → int

EXPIRETIME(
    key: RedisArgument
) → Any

expireTime(
    key: byte[]
) → long  // Expiration Unix timestamp in seconds, or a negative value in order to signal an error

expireTime(
    key: String
) → long  // Expiration Unix timestamp in seconds, or a negative value in order to signal an error

expiretime(
    key: K  // the key.
) → Long  // Long integer-reply expiration Unix timestamp in seconds, or a negative value in order to signal an error.

expiretime(
    key: K  // the key.
) → RedisFuture<Long>  // Long integer-reply expiration Unix timestamp in seconds, or a negative value in order to signal an error.

expiretime(
    key: K  // the key.
) → Mono<Long>  // Long integer-reply expiration Unix timestamp in seconds, or a negative value in order to signal an error.

ExpireTime(
    ctx: context.Context,
    key: string
) → *DurationCmd

KeyExpireTime(
    key: RedisKey,  // The key to check.
    flags: CommandFlags  // The flags to use for this operation.
) → DateTime?  // The expiration time, or null if the key does not exist or has no associated expiration.

KeyExpireTimeAsync(
    key: RedisKey,  // The key to check.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<DateTime?>  // The expiration time, or null if the key does not exist or has no associated expiration.

expireTime(
    $key: string
) → int

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

Returns the absolute Unix timestamp (since January 1, 1970) in seconds at which the given key will expire.

See also the PEXPIRETIME command which returns the same information with milliseconds resolution.

Required arguments

key

The name of the key.

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: the expiration Unix timestamp in seconds.
Integer reply: -1 if the key exists but has no associated expiration time.
Integer reply: -2 if the key does not exist.