CLIENT SETNAME

设置连接名称。

语法

CLIENT SETNAME connection-name

引入版本:2.6.9

复杂度摘要:O(1)

CLIENT SETNAME 命令为当前连接分配一个名称。

必需参数

connection-name

分配给当前连接的名称。

详细说明

分配的名称显示在 CLIENT LIST 的输出中,以便可以识别执行给定连接的客户端。

例如,当使用 Redis 来实现队列时,消息的生产者和消费者可能希望根据其角色设置连接的名称。

如果不是 Redis 字符串类型的通常限制 (512 MB),则可以分配的名称长度没有限制。但是,无法在连接名称中使用空格,因为这会违反 CLIENT LIST 回复的格式。

可以完全删除连接名称,将其设置为空字符串,这不是有效的连接名称,因为它用于此特定目的。

可以使用CLIENT GETNAME 检查连接名称。

每个新连接启动时都没有指定名称。

[!TIP] 设置连接名称是调试由于使用 Redis 的应用程序中的错误而导致的连接泄漏的好方法。

Redis Software 与 Redis Cloud 兼容性

Redis
软件
Redis
Cloud
说明
✅ 标准
✅ 主动-主动
✅ 标准
✅ 主动-主动

返回值

RESP2

简单字符串回复:如果连接名称设置成功,则为 OK。

RESP3

简单字符串回复:如果连接名称设置成功,则为 OK。

资料来源:Redis 官方 CLIENT SETNAME 文档;中文内容参考 Redis 文档许可。