AstraDBByteStore#
- class langchain_community.storage.astradb.AstraDBByteStore(collection_name: str, token: str | None = None, api_endpoint: str | None = None, astra_db_client: AstraDB | None = None, namespace: str | None = None, *, async_astra_db_client: AsyncAstraDB | None = None, pre_delete_collection: bool = False, setup_mode: SetupMode = SetupMode.SYNC)[来源]#
自版本0.0.22起已弃用:请改用
:class:`~langchain_astradb.AstraDBByteStore`
。在langchain-community==1.0之前不会移除。使用DataStax AstraDB作为底层存储的ByteStore实现。
字节值被转换为base64编码的字符串 AstraDB集合中的文档将具有以下格式
{ "_id": "<key>", "value": "<byte64 string value>" }
- Parameters:
collection_name (str) – 要创建/使用的Astra DB集合的名称。
token (可选[str]) – 用于Astra DB的API令牌。
api_endpoint (可选[str]) – API端点的完整URL, 例如 https://
-us-east1.apps.astra.datastax.com 。astra_db_client (可选[AstraDB]) – 替代 token+api_endpoint, 你可以传递一个已经创建的 'astrapy.db.AstraDB' 实例。
async_astra_db_client (Optional[AsyncAstraDB]) – 替代token+api_endpoint, 你可以传递一个已经创建的‘astrapy.db.AsyncAstraDB’实例。
namespace (可选[str]) – 创建集合的命名空间(也称为keyspace)。默认为数据库的“默认命名空间”。
setup_mode (SetupMode) – 用于创建Astra DB集合的模式(SYNC、ASYNC或OFF)。
pre_delete_collection (bool) – 是否在创建集合之前删除它。如果为False且集合已存在,则直接使用该集合。
方法
__init__
(collection_name[, token, ...])使用DataStax AstraDB作为底层存储的ByteStore实现。
amdelete
(keys)异步删除给定的键及其关联的值。
amget
(keys)异步获取与给定键关联的值。
amset
(key_value_pairs)异步设置给定键的值。
ayield_keys
(*[, prefix])异步获取一个迭代器,用于遍历与给定前缀匹配的键。
decode_value
(value)从Astra DB解码值
encode_value
(value)为Astra DB编码值
mdelete
(keys)删除给定的键及其关联的值。
mget
(keys)获取与给定键关联的值。
mset
(key_value_pairs)设置给定键的值。
yield_keys
(*[, prefix])获取一个迭代器,用于遍历与给定前缀匹配的键。
- __init__(collection_name: str, token: str | None = None, api_endpoint: str | None = None, astra_db_client: AstraDB | None = None, namespace: str | None = None, *, async_astra_db_client: AsyncAstraDB | None = None, pre_delete_collection: bool = False, setup_mode: SetupMode = SetupMode.SYNC) None [来源]#
使用DataStax AstraDB作为底层存储的ByteStore实现。
字节值被转换为base64编码的字符串 AstraDB集合中的文档将具有以下格式
{ "_id": "<key>", "value": "<byte64 string value>" }
- Parameters:
collection_name (str) – 要创建/使用的Astra DB集合的名称。
token (可选[str]) – 用于Astra DB的API令牌。
api_endpoint (可选[str]) – API端点的完整URL, 例如 https://
-us-east1.apps.astra.datastax.com 。astra_db_client (可选[AstraDB]) – 替代 token+api_endpoint, 你可以传递一个已经创建的 'astrapy.db.AstraDB' 实例。
async_astra_db_client (Optional[AsyncAstraDB]) – 替代token+api_endpoint, 你可以传递一个已经创建的‘astrapy.db.AsyncAstraDB’实例。
namespace (可选[str]) – 创建集合的命名空间(也称为keyspace)。默认为数据库的“默认命名空间”。
setup_mode (SetupMode) – 用于创建Astra DB集合的模式(SYNC、ASYNC或OFF)。
pre_delete_collection (bool) – 是否在创建集合之前删除它。如果为False且集合已存在,则直接使用该集合。
- Return type:
无
- async amdelete(keys: Sequence[str]) None #
异步删除给定的键及其关联的值。
- Parameters:
keys (Sequence[K]) – 要删除的键序列。
- Return type:
无
- async amget(keys: Sequence[str]) List[V | None] #
异步获取与给定键关联的值。
- Parameters:
keys (Sequence[K]) – 一个键的序列。
- Returns:
与键相关联的一系列可选值。 如果未找到键,则对应的值将为None。
- Return type:
列表[V | 无]
- async amset(key_value_pairs: Sequence[Tuple[str, V]]) None #
异步设置给定键的值。
- Parameters:
key_value_pairs (Sequence[Tuple[K, V]]) – 一个键值对的序列。
- Return type:
无
- async ayield_keys(*, prefix: str | None = None) AsyncIterator[str] #
异步获取一个迭代器,用于遍历与给定前缀匹配的键。
- Parameters:
prefix (str) – 要匹配的前缀。
- Yields:
Iterator[K | str] – 一个遍历与给定前缀匹配的键的迭代器。 此方法允许返回一个遍历 K 或 str 的迭代器,具体取决于给定存储的更有意义的方式。
- Return type:
AsyncIterator[str]
- decode_value(value: Any) bytes | None [source]#
从Astra DB解码值
- Parameters:
值 (任意类型)
- Return type:
字节 | 无
- mdelete(keys: Sequence[str]) None #
删除给定的键及其关联的值。
- Parameters:
keys (Sequence[K]) – 要删除的键序列。
- Return type:
无
- mget(keys: Sequence[str]) List[V | None] #
获取与给定键关联的值。
- Parameters:
keys (Sequence[K]) – 一个键的序列。
- Returns:
与键相关联的一系列可选值。 如果未找到键,则对应的值将为None。
- Return type:
列表[V | 无]
- mset(key_value_pairs: Sequence[Tuple[str, V]]) None #
为给定的键设置值。
- Parameters:
key_value_pairs (Sequence[Tuple[K, V]]) – 一个键值对的序列。
- Return type:
无
- yield_keys(*, prefix: str | None = None) Iterator[str] #
获取一个迭代器,用于遍历与给定前缀匹配的键。
- Parameters:
prefix (str) – 要匹配的前缀。
- Yields:
Iterator[K | str] – 一个遍历与给定前缀匹配的键的迭代器。 此方法允许返回一个遍历 K 或 str 的迭代器,具体取决于给定存储的更有意义的方式。
- Return type:
迭代器[str]