Cassandra数据库#

class langchain_community.utilities.cassandra_database.CassandraDatabase(session: Session | None = None, exclude_tables: List[str] | None = None, include_tables: List[str] | None = None, cassio_init_kwargs: Dict[str, Any] | None = None)[source]#

Apache Cassandra® 数据库封装器。

方法

__init__([session, exclude_tables, ...])

fetch_all(query, **kwargs)

fetch_one(query, **kwargs)

format_keyspace_to_markdown(keyspace[, tables])

通过遍历特定键空间中的所有表并调用它们的as_markdown方法，生成该键空间模式的Markdown表示。

format_schema_to_markdown()

生成CassandraDatabase实例中所有键空间和表的模式的Markdown表示。

get_context()

返回您可能希望在代理提示中使用的数据库上下文。

get_keyspace_tables(keyspace)

获取指定键空间的表对象。

get_table_data(keyspace, table, predicate, limit)

从指定的keyspace中的指定表中获取数据。

run(query[, fetch])

执行一个CQL查询并返回结果。
Parameters:

  • session (可选[Session])

  • exclude_tables (可选[列表[字符串]])

  • include_tables (可选[列表[字符串]])

  • cassio_init_kwargs (可选[字典[字符串, 任意类型]])

__init__(session: Session | None = None, exclude_tables: List[str] | None = None, include_tables: List[str] | None = None, cassio_init_kwargs: Dict[str, Any] | None = None)[source]#
Parameters:

  • session (可选[Session])

  • exclude_tables (可选[列表[字符串]])

  • include_tables (可选[列表[字符串]])

  • cassio_init_kwargs (可选[字典[字符串, 任意类型]])

fetch_all(query: str, **kwargs: Any) → list[source]#
Parameters:

  • query (str)

  • kwargs (Any)

Return type:

列表

fetch_one(query: str, **kwargs: Any) → Dict[str, Any][来源]#
Parameters:

  • query (str)

  • kwargs (Any)

Return type:

Dict[str, Any]

format_keyspace_to_markdown(keyspace: str, tables: List[Table] | None = None) → str[source]#

通过遍历特定键空间内的所有表并调用它们的as_markdown方法，生成该键空间模式的Markdown表示。

Parameters:

  • keyspace (str) – 要为其生成Markdown文档的keyspace名称。

  • tables (List[Table] | None) – 键空间中的表列表；如果未提供，将会被解析。

Returns:

一个包含指定键空间模式的markdown表示的字符串。

Return type:

字符串

format_schema_to_markdown() → str[source]#

生成CassandraDatabase实例中所有键空间和表的模式的Markdown表示。该方法利用format_keyspace_to_markdown方法为每个键空间创建Markdown部分，并将它们组合成一个全面的模式文档。

遍历数据库中的每个keyspace，使用format_keyspace_to_markdown为每个keyspace的模式生成markdown，包括其表的详细信息。这些部分被连接起来形成一个单一的markdown文档，代表整个数据库的模式或在此实例中已解析的keyspace子集。

Returns:

一个markdown字符串，记录了此CassandraDatabase实例中所有已解析键空间及其表的模式。这包括键空间名称、表名称、注释、列、分区键、聚类键以及每个表的索引。

Return type:

字符串

get_context() → Dict[str, Any][source]#

返回您可能希望在代理提示中使用的数据库上下文。

Return type:

Dict[str, Any]

get_keyspace_tables(keyspace: str) → List[Table][source]#

获取指定键空间的表对象。

Parameters:

keyspace (str)

Return type:

列表[表]

get_table_data(keyspace: str, table: str, predicate: str, limit: int) → str[来源]#

从指定的键空间中的指定表获取数据。

Parameters:

  • keyspace (str)

  • table (str)

  • predicate (str)

  • limit (int)

Return type:

字符串

run(query: str, fetch: str = 'all', **kwargs: Any) → list | Dict[str, Any] | ResultSet[source]#

执行一个CQL查询并返回结果。

Parameters:

  • query (str)

  • fetch (str)

  • kwargs (Any)

Return type:

Union[list, Dict[str, Any], ResultSet]

使用CassandraDatabase的示例