MongoDB字节存储#

class langchain_community.storage.mongodb.MongoDBByteStore(connection_string: str, db_name: str, collection_name: str, *, client_kwargs: dict | None = None)[来源]#

使用MongoDB作为底层存储的BaseStore实现。

示例

创建一个MongoDBByteStore实例并对其执行操作:

# Instantiate the MongoDBByteStore with a MongoDB connection
from langchain.storage import MongoDBByteStore

mongo_conn_str = "mongodb://localhost:27017/"
mongodb_store = MongoDBBytesStore(mongo_conn_str, db_name="test-db",
                             collection_name="test-collection")

# Set values for keys
mongodb_store.mset([("key1", "hello"), ("key2", "workd")])

# Get values for keys
values = mongodb_store.mget(["key1", "key2"])
# [bytes1, bytes1]

# Iterate over keys
for key in mongodb_store.yield_keys():
    print(key)

# Delete keys
mongodb_store.mdelete(["key1", "key2"])

使用MongoDB连接字符串初始化MongoDBStore。

Parameters:
  • connection_string (str) – MongoDB 连接字符串

  • db_name (str) – 使用的名称

  • collection_name (str) – 要使用的集合名称

  • client_kwargs (dict) – 传递给Mongo客户端的关键字参数

方法

__init__(connection_string, db_name, ...[, ...])

使用MongoDB连接字符串初始化MongoDBStore。

amdelete(keys)

异步删除给定的键及其关联的值。

amget(keys)

异步获取与给定键关联的值。

amset(key_value_pairs)

异步设置给定键的值。

ayield_keys(*[, prefix])

异步获取一个迭代器,用于遍历与给定前缀匹配的键。

mdelete(keys)

删除给定的ID。

mget(keys)

获取与给定键关联的文档列表。

mset(key_value_pairs)

设置给定的键值对。

yield_keys([prefix])

在存储中生成键。

__init__(connection_string: str, db_name: str, collection_name: str, *, client_kwargs: dict | None = None) None[源代码]#

使用MongoDB连接字符串初始化MongoDBStore。

Parameters:
  • connection_string (str) – MongoDB 连接字符串

  • db_name (str) – 使用的名称

  • collection_name (str) – 要使用的集合名称

  • client_kwargs (dict) – 传递给Mongo客户端的关键字参数

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

删除给定的ID。

Parameters:

keys (list[str]) – 表示文档ID的键列表。

Return type:

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

获取与给定键关联的文档列表。

Parameters:

keys (list[str]) – 表示文档ID的键列表。

Returns:

与提供的键对应的文档列表

其中每个文档要么成功检索,要么如果未找到则表示为None。

Return type:

列表[Document]

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

设置给定的键值对。

Parameters:

key_value_pairs (list[tuple[str, Document]]) – 一个包含id-文档对的列表。

Return type:

yield_keys(prefix: str | None = None) Iterator[str][source]#

在存储中生成键。

Parameters:

prefix (str) – 要检索的键的前缀。

Return type:

迭代器[str]