langchain_community.utilities.redis.get_client

langchain_community.utilities.redis.get_client(redis_url: str, **kwargs: Any) → RedisType[source]

从给定的连接URL获取一个redis客户端。这个辅助函数接受Redis服务器的URL（TCP，带/不带TLS或UnixSocket）以及Redis Sentinel连接。

不支持Redis集群。

在创建连接之前，会检查数据库驱动程序的存在，否则会引发ValueError。

要使用，应该已安装``redis`` python包。

示例：
from langchain_community.utilities.redis import get_client
redis_client = get_client(
    redis_url="redis://username:password@localhost:6379"
    index_name="my-index",
    embedding_function=embeddings.embed_query,
)

要使用具有多个Redis服务器和Redis Sentinel的Redis复制设置，请将”redis_url”设置为”redis+sentinel://”方案。使用此URL格式需要一个路径，其中包含在Sentinels中获取正确的Redis服务器连接的Redis服务的名称。默认服务名称为”mymaster”。路径的可选第二部分是要连接的Redis数据库编号。

用于连接到rediserver和sentinel的可选用户名或密码，不支持为服务器和sentinel使用不同的密码。另一个约束是只能给出一个sentinel实例：

示例：
from langchain_community.utilities.redis import get_client
redis_client = get_client(
    redis_url="redis+sentinel://username:password@sentinelhost:26379/mymaster/0"
    index_name="my-index",
    embedding_function=embeddings.embed_query,
)
Parameters

  • redis_url (str) –

  • kwargs (Any) –

Return type

RedisType