Toggle Menu
Prev Up Next

# `langchain_community.storage.upstash_redis`.UpstashRedisByteStore

class langchain_community.storage.upstash_redis.UpstashRedisByteStore(*, client: Optional[Any] = None, url: Optional[str] = None, token: Optional[str] = None, ttl: Optional[int] = None, namespace: Optional[str] = None)

  BaseStore implementation using Upstash Redis as the underlying store to store raw bytes.

  Methods

  `__init__`(*[, client, url, token, ttl, namespace]) |
  `amdelete`(keys) | Delete the given keys and their associated values.
  `amget`(keys) | Get the values associated with the given keys.
  `amset`(key_value_pairs) | Set the values for the given keys.
  `ayield_keys`(*[, prefix]) | 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.

  Parameters

    - client (Any) –

    - url (Optional[str]) –

    - token (Optional[str]) –

    - ttl (Optional[int]) –

    - namespace (Optional[str]) –

  __init__(*, client: Optional[Any] = None, url: Optional[str] = None, token: Optional[str] = None, ttl: Optional[int] = None, namespace: Optional[str] = None) → None
    Parameters

      - client (Optional[Any]) –

      - url (Optional[str]) –

      - token (Optional[str]) –

      - ttl (Optional[int]) –

      - namespace (Optional[str]) –

    Return type

      None

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

    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[Optional[V]]

    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[Optional[V]]

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

    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: Optional[str] = None) → Union[AsyncIterator[K], AsyncIterator[str]]

    Get an iterator over keys that match the given prefix.

    Parameters

      prefix (str) – The prefix to match.

    Returns

      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

      Iterator[K | str]

  mdelete(keys: Sequence[str]) → None

    Delete the given keys.

    Parameters

      keys (Sequence[str]) –

    Return type

      None

  mget(keys: Sequence[str]) → List[Optional[bytes]]

    Get the values associated with the given keys.

    Parameters

      keys (Sequence[str]) –

    Return type

      List[Optional[bytes]]

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

    Set the given key-value pairs.

    Parameters

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

    Return type

      None

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

    Yield keys in the store.

    Parameters

      prefix (Optional[str]) –

    Return type

      Iterator[str]

# Examples using UpstashRedisByteStore

- upstash_redis.md