diff options
Diffstat (limited to 'iredis/data/commands/client-id.md')
| -rw-r--r-- | iredis/data/commands/client-id.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/iredis/data/commands/client-id.md b/iredis/data/commands/client-id.md new file mode 100644 index 0000000..d242d6f --- /dev/null +++ b/iredis/data/commands/client-id.md @@ -0,0 +1,25 @@ +The command just returns the ID of the current connection. Every connection ID +has certain guarantees: + +1. It is never repeated, so if `CLIENT ID` returns the same number, the caller + can be sure that the underlying client did not disconnect and reconnect the + connection, but it is still the same connection. +2. The ID is monotonically incremental. If the ID of a connection is greater + than the ID of another connection, it is guaranteed that the second + connection was established with the server at a later time. + +This command is especially useful together with `CLIENT UNBLOCK` which was +introduced also in Redis 5 together with `CLIENT ID`. Check the `CLIENT UNBLOCK` +command page for a pattern involving the two commands. + +@examples + +```cli +CLIENT ID +``` + +@return + +@integer-reply + +The id of the client. |