菜单
开源
Redis 选项
您可以使用 Redis 连接 URL 配置 Redis Client，如客户端文档中所示，或者使用 Options 对象访问更高级的配置。
选项
Redis 客户端的整体配置，包括身份验证和连接设置。
| 选项名称 | 类型 | 描述 |
|---|---|---|
| socket | SocketOptions | 用于连接 Redis 服务器的连接 socket 配置。 |
| username | String (可选) | 客户端身份验证的用户名。 |
| password | String (可选) | 客户端身份验证的密码。 |
| clientName | String (可选) | 客户端连接的名称。 |
| database | Number (可选) | 连接后要选择的数据库 ID。 |
| masterName | String (可选) | Sentinel 的主实例名称。 |
| sentinelUsername | String (可选) | Sentinel 身份验证的用户名。 |
| sentinelPassword | String (可选) | Sentinel 身份验证的密码。 |
| cluster | ClusterOptions (可选) | Redis 集群连接的配置。 |
Socket 连接选项
连接到 Redis 服务器的 Socket 级别设置。
| 选项名称 | 类型 | 描述 |
|---|---|---|
| host | String | Redis 服务器的 IP 地址或主机名。 |
| port | Number (可选) | Redis 服务器的端口号。 |
| tls | TLSOptions (可选) | TLS/SSL 的配置。 |
| dialTimeout | Number (可选，默认为 5 秒) | 建立连接的超时时间，单位为秒。 |
| readTimeout | Number (可选，默认为 3 秒) | Socket 读取超时时间，单位为秒。值为 -1 则禁用超时。 |
| writeTimeout | Number (可选，默认为 readTimeout) | Socket 写入超时时间，单位为秒。值为 -1 则禁用超时。 |
| poolSize | Number (可选，默认为每个 CPU 10 个) | 每个 CPU 连接池中的 Socket 连接数。 |
| minIdleConns | Number (可选，默认为 0（空闲连接默认不关闭）) | 连接池中的最小空闲连接数。 |
| maxConnAge | Number (可选，默认为 0（无最大空闲时间）) | 连接关闭前的最大时间。 |
| poolTimeout | Number (可选，readTimeout + 1) | 从连接池获取连接的超时时间。 |
| idleTimeout | Number (可选，readTimeout + 1) | 连接池中空闲连接的超时时间。 |
| idleCheckFrequency | Number (可选，默认为 1 分钟) | 空闲连接检查频率，单位为分钟。值为 -1 则禁用检查。 |
TLS 配置选项
建立安全 TLS 连接的选项。
| 选项名称 | 类型 | 描述 |
|---|---|---|
| ca | ArrayBuffer[] | CA 证书数组。 |
| cert | ArrayBuffer (可选) | 相互 TLS 的客户端证书。 |
| key | ArrayBuffer (可选) | 与客户端证书关联的私钥。 |
Redis 集群选项
Redis 集群设置中的行为选项。
| 选项名称 | 类型 | 描述 |
|---|---|---|
| maxRedirects | Number (可选，默认为 3 次重定向/重试) | 命令重定向的最大次数。 |
| readOnly | Boolean (可选) | 启用副本的只读模式。 |
| routeByLatency | Boolean (可选) | 按延迟路由读取命令。 |
| routeRandomly | Boolean (可选) | 读取命令的随机路由。 |
| nodes | String[] 或 SocketOptions[] | 集群节点列表，以 URL 或 SocketOptions 形式。 |
