DOC-5718: add new string commands

dwdougherty · dwdougherty · commit 6b32e08d179f · 2025-10-28T07:33:54.000-07:00
diff --git a/content/commands/delex.md b/content/commands/delex.md
@@ -74,14 +74,15 @@ Conditionally removes the specified key based on value or digest comparison.
 
 ## Options
 
-The DELEX command supports a set of options that modify its behavior:
+The DELEX command supports a set of options that modify its behavior.
+Only one of the options can be specified.
 
-* `IFEQ value` -- Remove the key if the value is equal to the specified value.
-* `IFNE value` -- Remove the key if the value is not equal to the specified value.
-* `IFDEQ digest` -- Remove the key if the digest is equal to the specified digest.
-* `IFDNE digest` -- Remove the key if the digest is not equal to the specified digest.
+* `IFEQ ifeq-value` -- Remove the key if the value is equal to the specified value.
+* `IFNE ifne-value` -- Remove the key if the value is not equal to the specified value.
+* `IFDEQ ifeq-digest` -- Remove the key if the digest is equal to the specified digest.
+* `IFDNE ifne-digest` -- Remove the key if the digest is not equal to the specified digest.
 
-In 8.4, keys must be of type string.
+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.
 
 ## Return information
 
@@ -90,12 +91,13 @@ In 8.4, keys must be of type string.
     tab2="RESP3" >}}
 
 One of the following:
-- [Error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if key exists but holds a value that is not a string and `IFEQ/IFNE/IFDEQ/IFDNE` is specified.
 - [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): 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]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the key exists but holds a value that is not a string and one of `IFEQ, IFNE, IFDEQ,` or `IFDNE` is specified.
 
 -tab-sep-
 
-TODO: Add RESP3 return information
+One of the following:
+- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): 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]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the key exists but holds a value that is not a string and one of `IFEQ, IFNE, IFDEQ,` or `IFDNE` is specified.
 
 {{< /multitabs >}}
-
diff --git a/content/commands/digest.md b/content/commands/digest.md
@@ -41,32 +41,32 @@ key_specs:
     type: range
 linkTitle: DIGEST
 since: 8.4.0
-summary: Returns the XXH3 hash of a string value.
+summary: Returns the XXH3 hash of a string value as a hexadecimal string.
 syntax_fmt: DIGEST key
 syntax_str: ''
 title: DIGEST
 ---
-Returns the XXH3 hash of a string value.
 
-## Required arguments
-
-<details open><summary><code>key</code></summary>
-
-TODO: Add description for key (key)
-
-</details>
+Get the XXH3 hash digest for the value stored in the specified key as a hexadecimal string. Keys must be of type string.
 
 ## Return information
 
 {{< multitabs id="return-info"
     tab1="RESP2"
     tab2="RESP3" >}}
 
-TODO: Add RESP2 return information
+One of the following:
+
+- [Null bulk string reply]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) if the key does not exist.
+- [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the key exists but holds a value which is not a string.
+- [Bulk string reply]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) the XXH3 digest of the value stored in the key as a hexadecimal string.
 
 -tab-sep-
 
-TODO: Add RESP3 return information
+One of the following:
 
-{{< /multitabs >}}
+- [Null bulk string reply]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) if the key does not exist.
+- [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the key exists but holds a value which is not a string.
+- [Bulk string reply]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) the XXH3 digest of the value stored in the key as a hexadecimal string.
 
+{{< /multitabs >}}
diff --git a/content/commands/set.md b/content/commands/set.md
@@ -20,6 +20,26 @@ arguments:
     name: xx
     token: XX
     type: pure-token
+  - display_text: ifeq-value
+    name: ifeq-value
+    since: 8.4.0
+    token: IFEQ
+    type: string
+  - display_text: ifne-value
+    name: ifne-value
+    since: 8.4.0
+    token: IFNE
+    type: string
+  - display_text: ifdeq-digest
+    name: ifdeq-digest
+    since: 8.4.0
+    token: IFDEQ
+    type: integer
+  - display_text: ifdne-digest
+    name: ifdne-digest
+    since: 8.4.0
+    token: IFDNE
+    type: integer
   name: condition
   optional: true
   since: 2.6.12
@@ -87,6 +107,8 @@ history:
   - Added the `GET`, `EXAT` and `PXAT` option.
 - - 7.0.0
   - Allowed the `NX` and `GET` options to be used together.
+- - 8.4.0
+  - Added 'IFEQ', 'IFNE', 'IFDEQ', 'IFDNE' options.
 key_specs:
 - RW: true
   access: true
@@ -107,12 +129,15 @@ linkTitle: SET
 since: 1.0.0
 summary: Sets the string value of a key, ignoring its type. The key is created if
   it doesn't exist.
-syntax_fmt: "SET key value [NX | XX] [GET] [EX\_seconds | PX\_milliseconds |\n  EXAT\_\
-  unix-time-seconds | PXAT\_unix-time-milliseconds | KEEPTTL]"
-syntax_str: "value [NX | XX] [GET] [EX\_seconds | PX\_milliseconds | EXAT\_unix-time-seconds\
+syntax_fmt: "SET key value [NX | XX | IFEQ\_ifeq-value | IFNE\_ifne-value |\n\
+  \  IFDEQ\_ifdeq-digest | IFDNE\_ifdne-digest] [GET] [EX\_seconds |\n  PX\_milliseconds\
+  \ | EXAT\_unix-time-seconds |\n  PXAT\_unix-time-milliseconds | KEEPTTL]"
+syntax_str: "value [NX | XX | IFEQ\_ifeq-value | IFNE\_ifne-value | IFDEQ\_ifdeq-digest\
+  \ | IFDNE\_ifdne-digest] [GET] [EX\_seconds | PX\_milliseconds | EXAT\_unix-time-seconds\
   \ | PXAT\_unix-time-milliseconds | KEEPTTL]"
 title: SET
 ---
+
 Set `key` to hold the string `value`.
 If `key` already holds a value, it is overwritten, regardless of its type.
 Any previous time to live associated with the key is discarded on successful `SET` operation.
@@ -127,6 +152,10 @@ The `SET` command supports a set of options that modify its behavior:
 * `PXAT` *timestamp-milliseconds* -- Set the specified Unix time at which the key will expire, in milliseconds (a positive integer).
 * `NX` -- Only set the key if it does not already exist.
 * `XX` -- Only set the key if it already exists.
+* `IFEQ ifeq-value` -- Set the key’s value and expiration only if its current value is equal to `ifeq-value`. If the key doesn’t exist, it won’t be created.
+* `IFNE ifne-value` -- Set the key’s value and expiration only if its current value is not equal to `ifne-value`. If the key doesn’t exist, it will be created.
+* `IFDEQ ifeq-digest` -- Set the key’s value and expiration only if the digest of its current value is equal to `ifeq-digest`. If the key doesn’t exist, it won’t be created.
+* `IFDNE ifne-digest` -- Set the key’s value and expiration only if the digest of its current value is not equal to `ifne-digest`. If the key doesn’t exist, it will be created.
 * `KEEPTTL` -- Retain the time to live associated with the key.
 * `GET` -- Return the old string stored at key, or nil if key did not exist. An error is returned and `SET` aborted if the value stored at key is not a string.
 
@@ -180,20 +209,24 @@ The script should be called with `EVAL ...script... 1 resource-name token-value`
     tab1="RESP2" 
     tab2="RESP3" >}}
 
-* If `GET` was not specified, any of the following:
-  * [Nil reply](../../develop/reference/protocol-spec#bulk-strings): Operation was aborted (conflict with one of the `XX`/`NX` options). The key was not set.
+* If `GET` was not specified, one of the following:
+  * [Null bulk string reply](../../develop/reference/protocol-spec#bulk-strings) in the following two cases.
+    * The key doesn’t exist and `XX/IFEQ/IFDEQ` was specified. The key was not created.
+    * The key exists, and `NX` was specified or a specified `IFEQ/IFNE/IFDEQ/IFDNE` condition is false. The key was not set.
   * [Simple string reply](../../develop/reference/protocol-spec#simple-strings): `OK`: The key was set.
-* If `GET` was specified, any of the following:
-  * [Nil reply](../../develop/reference/protocol-spec#bulk-strings): The key didn't exist before the `SET`. If `XX` was specified, the key was not set. Otherwise, the key was set.
-  * [Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): The previous value of the key. If `NX` was specified, the key was not set. Otherwise, the key was set.
+* If `GET` was specified, one of the following:
+  * [Null bulk string reply](../../develop/reference/protocol-spec#bulk-strings): The key didn't exist before the `SET` operation, whether the key was created of not.
+  * [Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): The previous value of the key, whether the key was set or not.
 
 -tab-sep-
 
-* If `GET` was not specified, any of the following:
-  * [Null reply](../../develop/reference/protocol-spec#nulls): Operation was aborted (conflict with one of the `XX`/`NX` options). The key was not set.
+* If `GET` was not specified, one of the following:
+  * [Null reply](../../develop/reference/protocol-spec#nulls) in the following two cases.
+    * The key doesn’t exist and `XX/IFEQ/IFDEQ` was specified. The key was not created.
+    * The key exists, and `NX` was specified or a specified `IFEQ/IFNE/IFDEQ/IFDNE` condition is false. The key was not set.
   * [Simple string reply](../../develop/reference/protocol-spec#simple-strings): `OK`: The key was set.
-* If `GET` was specified, any of the following:
-  * [Null reply](../../develop/reference/protocol-spec#nulls): The key didn't exist before the `SET`. If `XX` was specified, the key was not set. Otherwise, the key was set.
-  * [Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): The previous value of the key. If `NX` was specified, the key was not set. Otherwise, the key was set.
+* If `GET` was specified, one of the following:
+  * [Null reply](../../develop/reference/protocol-spec#nulls): The key didn't exist before the `SET` operation, whether the key was created of not.
+  * [Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): The previous value of the key, whether the key was set or not.
 
 {{< /multitabs >}}
