UpstashRedisStore#
- class langchain_community.storage.upstash_redis.UpstashRedisStore(*, client: Any = None, url: str | None = None, token: str | None = None, ttl: int | None = None, namespace: str | None = None)[来源]#
自版本 0.0.1 起已弃用:请改用
UpstashRedisByteStore
。使用Upstash Redis作为底层存储来存储字符串的BaseStore实现。
已弃用,推荐使用更通用的UpstashRedisByteStore。
使用HTTP API初始化UpstashRedisStore。
必须提供Upstash Redis客户端或URL。
- Parameters:
client (Any) – 一个 Upstash Redis 实例
url (str | None) – UPSTASH_REDIS_REST_URL
token (str | None) – UPSTASH_REDIS_REST_TOKEN
ttl (int | None) – 如果提供了,则以秒为单位设置键的过期时间, 如果为 None,则键永不过期
namespace (str | None) – 如果提供,所有键将以此命名空间为前缀
方法
__init__
(*[, client, url, token, ttl, namespace])使用HTTP API初始化UpstashRedisStore。
amdelete
(keys)异步删除给定的键及其关联的值。
amget
(keys)异步获取与给定键关联的值。
amset
(key_value_pairs)异步设置给定键的值。
ayield_keys
(*[, prefix])异步获取与给定前缀匹配的键的迭代器。
mdelete
(keys)删除给定的键。
mget
(keys)获取与给定键关联的值。
mset
(key_value_pairs)设置给定的键值对。
yield_keys
(*[, prefix])生成存储中的键。
- __init__(*, client: Any = None, url: str | None = None, token: str | None = None, ttl: int | None = None, namespace: str | None = None) None #
使用HTTP API初始化UpstashRedisStore。
必须提供Upstash Redis客户端或URL。
- Parameters:
client (Any) – 一个 Upstash Redis 实例
url (str | None) – UPSTASH_REDIS_REST_URL
token (str | None) – UPSTASH_REDIS_REST_TOKEN
ttl (int | None) – 如果提供了,则以秒为单位设置键的过期时间, 如果为 None,则键永不过期
namespace (str | None) – 如果提供,所有键将以此命名空间为前缀
- Return type:
无
- async amdelete(keys: Sequence[K]) None #
异步删除给定的键及其关联的值。
- Parameters:
keys (Sequence[K]) – 要删除的键序列。
- Return type:
无
- async amget(keys: Sequence[K]) list[V | None] #
异步获取与给定键关联的值。
- Parameters:
keys (Sequence[K]) – 一个键的序列。
- Returns:
与键相关联的一系列可选值。 如果未找到键,则对应的值将为None。
- Return type:
列表[V | 无]
- async amset(key_value_pairs: Sequence[tuple[K, V]]) None #
异步设置给定键的值。
- Parameters:
key_value_pairs (Sequence[Tuple[K, V]]) – 一个键值对的序列。
- Return type:
无
- async ayield_keys(*, prefix: str | None = None) AsyncIterator[K] | AsyncIterator[str] #
异步获取一个迭代器,用于遍历与给定前缀匹配的键。
- Parameters:
prefix (str) – 要匹配的前缀。
- Yields:
Iterator[K | str] – 一个遍历与给定前缀匹配的键的迭代器。 此方法允许返回一个遍历 K 或 str 的迭代器,具体取决于给定存储的更有意义的方式。
- Return type:
AsyncIterator[K] | AsyncIterator[str]
- mdelete(keys: Sequence[str]) None #
删除给定的键。
- Parameters:
keys (序列[字符串])
- Return type:
无
- mget(keys: Sequence[str]) List[str | None] #
获取与给定键关联的值。
- Parameters:
keys (序列[字符串])
- Return type:
列表[str | None]
- mset(key_value_pairs: Sequence[Tuple[str, str]]) None #
设置给定的键值对。
- Parameters:
key_value_pairs (Sequence[Tuple[str, str]])
- Return type:
无
- yield_keys(*, prefix: str | None = None) Iterator[str] #
在存储中生成键。
- Parameters:
prefix (str | None)
- Return type:
迭代器[str]