langchain_core.stores.BaseStore

class langchain_core.stores.BaseStore

Abstract interface for a key-value store.

Methods

__init__()
mdelete(keys)	Delete the given keys and their associated values.
mget(keys)	Get the values associated with the given keys.
mset(key_value_pairs)	Set the values for the given keys.
yield_keys(*[, prefix])	Get an iterator over keys that match the given prefix.

__init__()

abstract mdelete(keys: Sequence[K]) → None

Delete the given keys and their associated values.

Parameters

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

abstract mget(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.

abstract mset(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.

abstract yield_keys(*, prefix: Optional[str] = None) → Union[Iterator[K], Iterator[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]