Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document lib-name suffix format used by official clients #2537
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.
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
base: master
Are you sure you want to change the base?
Uh oh!
There was an error while loading. Please reload this page.
Document lib-name suffix format used by official clients #2537
Changes from all commits
7fa7180
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
The
CLIENT SETINFO
command assigns various info attributes to the current connection which are displayed in the output ofCLIENT LIST
andCLIENT INFO
.Client libraries are expected to pipeline this command after authentication on all connections and ignore failures since they could be connected to an older version that doesn't support them.
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.Official client libraries allow extending
lib-name
with a custom suffix to expose additional information about the client. For example, high-level libraries like redis-om-spring can report their version. The resultinglib-name
would bejedis(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.
@return
@simple-string-reply:
OK
if the attribute name was successfully set.