langchain_community.utilities.cassandra_database.CassandraDatabase

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

Apache Cassandra® 数据库包装器。

方法

__init__([会话, 排除的表, ...])

fetch_all(查询, **kwargs)

fetch_one(查询, **kwargs)

format_keyspace_to_markdown(命名空间[, 表])

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

format_schema_to_markdown()

生成CassandraDatabase实例中所有命名空间和表的模式的markdown表示。

get_context()

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

get_keyspace_tables(命名空间)

获取指定命名空间的表对象。

get_table_data(命名空间, 表, 条件, 限制)

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

run(查询[, fetch])

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

  • session (可选[Session]) –

  • exclude_tables (可选[列表[str]]) –

  • include_tables (可选[列表[str]]) –

  • cassio_init_kwargs (可选[字典[str, Any]]) –

__init__(session: 可选[Session], exclude_tables: 可选[列表[str]], include_tables: 可选[列表[str]], cassio_init_kwargs: 可选[字典[str, Any]])[source]
参数

  • session (可选[Session]) –

  • exclude_tables (可选[列表[str]]) –

  • include_tables (可选[列表[str]]) –

  • cassio_init_kwargs (可选[字典[str, Any]]) –

fetch_all(query: str, **kwargs: Any) → list[source]
参数

  • query (str) –

  • kwargs (Any) –

返回类型

列表

fetch_one(query: str, **kwargs: Any) → Dict[str, Any][source]
参数

  • query (str) –

  • kwargs (Any) –

返回类型

Dict[str, Any]

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

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

参数

  • keyspace (str) – 要生成markdown文档的空间名称。

  • tables (Optional[List[Table]]) – 空间中的表列表；如果没有提供，将进行解析。

返回

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

返回类型

str

format_schema_to_markdown() → str[source]

生成CassandraDatabase实例中所有空间和表的模式markdown表示。此方法使用format_keyspace_to_markdown方法为每个空间创建markdown部分，将它们组装成一个综合的模式文档。

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

返回

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

返回类型

str

get_context() → Dict[str, Any][源代码]

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

返回类型

Dict[str, Any]

get_keyspace_tables(keyspace: str) → List[Table][源代码]

获取指定命名空间的表对象。

参数

keyspace (str) –

返回类型

List[Table]

get_table_data(keyspace: str, table: str, predicate: str, limit: int) → str[源代码]

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

参数

  • keyspace (str) –

  • table (str) –

  • predicate (str) –

  • limit (int) –

返回类型

str

run(query: str, fetch: str = 'all', **kwargs: Any) → Union[list, Dict[str, Any], ResultSet][源代码]

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

参数

  • query (str) –

  • fetch (str) –

  • kwargs (Any) –

返回类型

数据类型：列表（list）、字典（Dict[str, Any]）、结果集（ResultSet）

使用Cassandra数据库的例子