Skip to content

Commit

Permalink
Document lib-name suffix format used by official clients
Browse files Browse the repository at this point in the history
  • Loading branch information
uglide committed Sep 12, 2023
1 parent b91cd8b commit 7fa7180
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion commands/client-setinfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ Currently the supported attributes are:
* `lib-name` - meant to hold the name of the client library that's in use.
* `lib-ver` - meant to hold the client library's version.

There is no limit to the length of these attributes. However it is not possible to use spaces, newlines, or other non-printable characters that would violate the format of the `CLIENT LIST` reply.
There is no limit to the length of these attributes. However, it is not possible to use spaces, newlines, or other non-printable characters that would violate the format of the `CLIENT LIST` reply.

[Official client libraries](https://redis.io/docs/clients/) allow extending `lib-name` with a custom suffix to expose additional information about the client.
For example, high-level libraries like [redis-om-spring](https://github.com/redis/redis-om-spring) can report their version.
The resulting `lib-name` would be `jedis(redis-om-spring_v1.0.0)`.
Brace characters are used to delimit the custom suffix and should be avoided in the suffix itself.
We recommend using the following format for the custom suffixes for third-party libraries `(?<custom-name>[ -~]+)[ -~]v(?<custom-version>[\d\.]+)` and use `;` to delimit multiple suffixes.

Note that these attributes are **not** cleared by the RESET command.

Expand Down

0 comments on commit 7fa7180

Please sign in to comment.