DELEX

Syntax text Syntax diagram API methods

DELEX key [IFEQ ifeq-value | IFNE ifne-value | IFDEQ ifdeq-digest |
  IFDNE ifdne-digest]

Client:

delex(
    name: KeyT,
    ifeq: Optional[Union[bytes, str]] = None,
    ifne: Optional[Union[bytes, str]] = None,
    ifdeq: Optional[str] = None,
    ifdne: Optional[str] = None
) → int

delex(
    key: byte[],
    condition: CompareCondition
) → long  // The value of key

delex(
    key: String,
    condition: CompareCondition
) → long  // The value of key

delex(
    key: K,  // the key.
    compareCondition: CompareCondition<V>  // the compare condition, must not be null.
) → Long  // Long integer-reply the number of keys that were removed. @since 7.1

delex(
    key: K,  // the key.
    compareCondition: CompareCondition<V>  // the compare condition, must not be null.
) → RedisFuture<Long>  // Long integer-reply the number of keys that were removed. @since 7.1

delex(
    key: K,  // the key.
    compareCondition: CompareCondition<V>  // the compare condition, must not be null.
) → Mono<Long>  // Long integer-reply the number of keys that were removed. @since 7.1

DelExArgs(
    ctx: context.Context,
    key: string,
    a: DelExArgs
) → *IntCmd

StringDelete(
    key: RedisKey,  // The key of the string.
    when: ValueCondition,  // The condition to enforce.
    flags: CommandFlags  // The flags to use for this operation.
) → bool

StringDelete(
    key: RedisKey,  // The key of the string.
    when: ValueCondition,  // The condition to enforce.
    flags: CommandFlags  // The flags to use for this operation.
) → bool

delex(
    $key: string,
    $flag: string,
    $flagValue: Any
) → int

Available since:: Redis Open Source 8.4.0
Time complexity:: O(1) for IFEQ/IFNE, O(N) for IFDEQ/IFDNE where N is the length of the string value.
ACL categories:: @write, @string, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Conditionally removes the specified key based on value or hash digest comparison.

Required arguments

key

The name of the key to delete.

Optional arguments

The following options condition the deletion on the key's current value or hash digest. Only one may be specified.

IFEQ ifeq-value

Delete the key only if its value is equal to ifeq-value.

IFNE ifne-value

Delete the key only if its value is not equal to ifne-value.

IFDEQ ifdeq-digest

Delete the key only if its hash digest is equal to ifdeq-digest.

IFDNE ifdne-digest

Delete the key only if its hash digest is not equal to ifdne-digest.

In 8.4, keys must be of type string when using one of the options above. If no options are specified, the key is removed regardless of its type.

Details

Hash Digest

A hash digest is a fixed-size numerical representation of a string value, computed using the XXH3 hash algorithm. Redis uses this hash digest for efficient comparison operations without needing to compare the full string content. You can retrieve a key's hash digest using the DIGEST command, which returns it as a hexadecimal string that you can use with the IFDEQ and IFDNE options, and also the SET command's IFDEQ and IFDNE options.

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: 0 if not deleted (the key does not exist or a specified IFEQ/IFNE/IFDEQ/IFDNE condition is false), or 1 if deleted.
Simple error reply if the key exists but holds a value that is not a string and one of IFEQ, IFNE, IFDEQ, or IFDNE is specified.