HPERSIST

Syntax text Syntax diagram API methods

HPERSIST key FIELDS numfields field [field ...]

Client:

hpersist(
    name: KeyT,  // The name of the hash key.
    *fields: str
) → ResponseT  // Returns a list which contains for each field in the request: - `-2` if the field does not exist, or if the key does not exist. - `-1` if the field exists but has no associated expiration time. - `1` if the expiration time was successfully removed from the field.

HPERSIST(
    key: RedisArgument,
    fields: RedisVariadicArgument
) → Any

hpersist(
    key: byte[],
    fields: byte[]...
) → List<Long>

hpersist(
    key: String,
    fields: String...
) → List<Long>

hpersist(
    key: K,  // the key.
    fields: K...  // one or more fields to remove the TTL for.
) → List<Long>  // a list of Long values for each of the fields provided: 1 indicating expiration time is removed; -1 field has no expiration time to be removed; -2 indicating there is no such field @since 6.4

hpersist(
    key: K,  // the key.
    fields: K...  // one or more fields to remove the TTL for.
) → RedisFuture<List<Long>>  // a list of Long values for each of the fields provided: 1 indicating expiration time is removed; -1 field has no expiration time to be removed; -2 indicating there is no such field @since 6.4

hpersist(
    key: K,  // the key.
    fields: K...  // one or more fields to remove the TTL for.
) → Flux<Long>  // a list of Long values for each of the fields provided: 1 indicating expiration time is removed; -1 field has no expiration time to be removed; -2 indicating there is no such field @since 6.4

HPersist(
    ctx: context.Context,
    key: string,
    fields: ...string
) → *IntSliceCmd

HashFieldPersist(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to remove expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → PersistResult[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>1</term> <description>Expiration time was removed.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

HashFieldPersist(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to remove expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → PersistResult[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>1</term> <description>Expiration time was removed.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

HashFieldPersist(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to remove expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → PersistResult[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>1</term> <description>Expiration time was removed.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

HashFieldPersist(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to remove expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → PersistResult[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>1</term> <description>Expiration time was removed.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

hpersist(
    $key: string,
    $fields: array
) → array|null

hpersist(
    key: K,
    fields: F
) → (Vec<IntegerReplyOrNoOp>)

hpersist(
    key: K,
    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

Remove the existing expiration on a hash key's field(s), turning the field(s) from volatile (a field with expiration set) to persistent (a field that will never expire as no TTL (time to live) is associated).

Required arguments

key

The name of the key that holds the hash.

FIELDS numfields field [field ...]

The hash fields to remove the expiration from. numfields is the number of fields, followed by that many field names.

Examples

redis> HSET mykey field1 "hello" field2 "world"
(integer) 2
redis> HEXPIRE mykey 300 FIELDS 2 field1 field2
1) (integer) 1
2) (integer) 1
redis> HTTL mykey FIELDS 2 field1 field2
1) (integer) 283
2) (integer) 283
redis> HPERSIST mykey FIELDS 1 field2
1) (integer) 1
redis> HTTL mykey FIELDS 2 field1 field2
1) (integer) 268
2) (integer) -1

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

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: -1 if the field exists but has no associated expiration set.
- Integer reply: 1 the expiration was removed.