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.

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

Docs: Add a note about client_setname and client_name difference #2247

Merged
merged 1 commit into from
Jun 23, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions redis/commands/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,12 @@ def client_setname(self, name: str, **kwargs) -> ResponseT:
Sets the current connection name

For more information see https://redis.io/commands/client-setname

.. note::
This method sets client name only for **current** connection.

If you want to set a common name for all connections managed
by this client, use ``client_name`` constructor argument.
"""
return self.execute_command("CLIENT SETNAME", name, **kwargs)

Expand Down