`langchain_core.stores`.BaseStore¶

class langchain_core.stores.BaseStore[source]¶

Abstract interface for a key-value store.

Methods

`__init__`()
`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 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.

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

Delete the given keys and their associated values.

async amget(keys: Sequence[K]) → List[Optional[V]][source]¶

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[source]¶

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]][source]¶

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]

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