summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/client-id.md
blob: d242d6f488a457af752c2774e8ca6c781d81c7cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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.