Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SET: Be more explicit about replies when using GET in conjunction with XX/NX/IFEQ #206

Merged
merged 1 commit into from
Jan 8, 2025
Merged

SET: Be more explicit about replies when using GET in conjunction with XX/NX/IFEQ #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion commands/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ The `SET` command supports a set of options that modify its behavior:
* `IFEQ` *comparison-value* -- Set the key if the comparison value matches the existing value. An error is returned and `SET` aborted if the value stored at key is not a string.
* `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.
* Note: When `GET` is used together with `NX`/`XX`/`IFEQ`, it is impossible to determine whether the `SET` command executed successfully based on the reply alone.

Note: Since the `SET` command options can replace `SETNX`, `SETEX`, `PSETEX`, `GETSET`, it is possible that in future versions of Valkey these commands will be deprecated and finally removed.

Expand Down
15 changes: 10 additions & 5 deletions resp2_replies.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -974,11 +974,16 @@
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
],
"SET": [
"Any of the following:",
"* [Nil reply](../topics/protocol.md#bulk-strings): `GET` not given: Operation was aborted (conflict with one of the `XX`/`NX` options).",
"* [Simple string reply](../topics/protocol.md#simple-strings): `OK`. `GET` not given: The key was set.",
"* [Nil reply](../topics/protocol.md#bulk-strings): `GET` given: The key didn't exist before the `SET`.",
"* [Bulk string reply](../topics/protocol.md#bulk-strings): `GET` given: The previous value of the key."
"If `GET` not given, any of the following:",
"* [Nil reply](../topics/protocol.md#bulk-strings): Operation was aborted (conflict with one of the `XX`/`NX` options).",
"* [Simple string reply](../topics/protocol.md#simple-strings): `OK`: The key was set.",
"If `GET` given, any of the following:",
"* [Nil reply](../topics/protocol.md#bulk-strings): The key didn't exist before the `SET`.",
"* [Bulk string reply](../topics/protocol.md#bulk-strings): The previous value of the key.",
"Note that when using `GET` together with `XX`/`NX`/`IFEQ`, the reply indirectly indicates whether the key was set:",
"* `GET` and `XX` given: Non-[Nil reply](../topics/protocol.md#bulk-strings) indicates the key was set.",
"* `GET` and `NX` given: [Nil reply](../topics/protocol.md#bulk-strings) indicates the key was set.",
"* `GET` and `IFEQ` given: The key was set if the reply is equal to `comparison-value`."
],
"SETBIT": [
"[Integer reply](../topics/protocol.md#integers): the original bit value stored at _offset_."
Expand Down
15 changes: 10 additions & 5 deletions resp3_replies.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1039,11 +1039,16 @@
"[Array reply](../topics/protocol.md#arrays): List of monitored replicas, and their state."
],
"SET": [
"Any of the following:",
"* [Null reply](../topics/protocol.md#nulls): `GET` not given: Operation was aborted (conflict with one of the `XX`/`NX` options).",
"* [Simple string reply](../topics/protocol.md#simple-strings): `OK`. `GET` not given: The key was set.",
"* [Null reply](../topics/protocol.md#nulls): `GET` given: The key didn't exist before the `SET`.",
"* [Bulk string reply](../topics/protocol.md#bulk-strings): `GET` given: The previous value of the key."
"If `GET` not given, any of the following:",
"* [Null reply](../topics/protocol.md#nulls): Operation was aborted (conflict with one of the `XX`/`NX` options).",
"* [Simple string reply](../topics/protocol.md#simple-strings): `OK`: The key was set.",
"If `GET` given, any of the following:",
"* [Null reply](../topics/protocol.md#nulls): The key didn't exist before the `SET`.",
"* [Bulk string reply](../topics/protocol.md#bulk-strings): The previous value of the key.",
"Note that when using `GET` together with `XX`/`NX`/`IFEQ`, the reply indirectly indicates whether the key was set:",
"* `GET` and `XX` given: Non-[Null reply](../topics/protocol.md#nulls) indicates the key was set.",
"* `GET` and `NX` given: [Null reply](../topics/protocol.md#nulls) indicates the key was set.",
"* `GET` and `IFEQ` given: The key was set if the reply is equal to `comparison-value`."
],
"SETBIT": [
"[Integer reply](../topics/protocol.md#integers): the original bit value stored at _offset_."
Expand Down
Loading