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)[source]#

Deprecated since version 0.0.1: Use UpstashRedisByteStore instead.

BaseStore implementation using Upstash Redis as the underlying store to store strings.

Deprecated in favor of the more generic UpstashRedisByteStore.

Initialize the UpstashRedisStore with HTTP API.

Must provide either an Upstash Redis client or a url.

Parameters:

  • client (Any) – An Upstash Redis instance

  • url (str | None) – UPSTASH_REDIS_REST_URL

  • token (str | None) – UPSTASH_REDIS_REST_TOKEN

  • ttl (int | None) – time to expire keys in seconds if provided, if None keys will never expire

  • namespace (str | None) – if provided, all keys will be prefixed with this namespace

Methods

__init__(*[, client, url, token, ttl, namespace])

Initialize the UpstashRedisStore with HTTP API.

amdelete(keys)

Async delete the given keys and their associated values.

amget(keys)

Async get the values associated with the given keys.

amset(key_value_pairs)

Async set the values for the given keys.

ayield_keys(*[, prefix])

Async get an iterator over keys that match the given prefix.

mdelete(keys)

Delete the given keys.

mget(keys)

Get the values associated with the given keys.

mset(key_value_pairs)

Set the given key-value pairs.

yield_keys(*[, prefix])

Yield keys in the store.
__init__(*, client: Any = None, url: str | None = None, token: str | None = None, ttl: int | None = None, namespace: str | None = None) → None#

Initialize the UpstashRedisStore with HTTP API.

Must provide either an Upstash Redis client or a url.

Parameters:

  • client (Any) – An Upstash Redis instance

  • url (str | None) – UPSTASH_REDIS_REST_URL

  • token (str | None) – UPSTASH_REDIS_REST_TOKEN

  • ttl (int | None) – time to expire keys in seconds if provided, if None keys will never expire

  • namespace (str | None) – if provided, all keys will be prefixed with this namespace

Return type:

None

async amdelete(keys: Sequence[K]) → None#

Async delete the given keys and their associated values.

Parameters:

keys (Sequence[K]) – A sequence of keys to delete.

Return type:

None

async amget(keys: Sequence[K]) → list[V | None]#

Async get the values associated with the given keys.

Parameters:

keys (Sequence[K]) – A sequence of keys.

Returns:

A sequence of optional values associated with the keys. If a key is not found, the corresponding value will be None.

Return type:

list[V | None]

async amset(key_value_pairs: Sequence[tuple[K, V]]) → None#

Async set the values for the given keys.

Parameters:

key_value_pairs (Sequence[Tuple[K, V]]) – A sequence of key-value pairs.

Return type:

None

async ayield_keys(*, prefix: str | None = None) → AsyncIterator[K] | AsyncIterator[str]#

Async get an iterator over keys that match the given prefix.

Parameters:

prefix (str) – The prefix to match.

Yields:

Iterator[K | str] – An iterator over keys that match the given prefix. This method is allowed to return an iterator over either K or str depending on what makes more sense for the given store.

Return type:

AsyncIterator[K] | AsyncIterator[str]

mdelete(keys: Sequence[str]) → None#

Delete the given keys.

Parameters:

keys (Sequence[str])

Return type:

None

mget(keys: Sequence[str]) → List[str | None]#

Get the values associated with the given keys.

Parameters:

keys (Sequence[str])

Return type:

List[str | None]

mset(key_value_pairs: Sequence[Tuple[str, str]]) → None#

Set the given key-value pairs.

Parameters:

key_value_pairs (Sequence[Tuple[str, str]])

Return type:

None

yield_keys(*, prefix: str | None = None) → Iterator[str]#

Yield keys in the store.

Parameters:

prefix (str | None)

Return type:

Iterator[str]