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®数据库包装器。

Methods

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

fetch_all(query, **kwargs)

fetch_one(query, **kwargs)

format_keyspace_to_markdown(keyspace[, tables])

生成特定keyspace的模式的markdown表示形式，通过迭代该keyspace中的所有表，并调用它们的as_markdown方法。

format_schema_to_markdown()

生成CassandraDatabase实例中所有keyspaces和tables的模式的markdown表示。此方法利用format_keyspace_to_markdown方法为每个keyspace创建markdown部分，将它们组装成一个全面的模式文档。

get_context()

返回可能在代理提示中需要的数据库上下文。

get_keyspace_tables(keyspace)

获取指定keyspace的Table对象。

get_table_data(keyspace, table, predicate, limit)

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

run(query[, fetch])

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

  • session (Optional[Session]) –

  • exclude_tables (Optional[List[str]]) –

  • include_tables (Optional[List[str]]) –

  • cassio_init_kwargs (Optional[Dict[str, Any]]) –

__init__(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]
Parameters

  • session (Optional[Session]) –

  • exclude_tables (Optional[List[str]]) –

  • include_tables (Optional[List[str]]) –

  • cassio_init_kwargs (Optional[Dict[str, Any]]) –

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

  • query (str) –

  • kwargs (Any) –

Return type

list

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

  • query (str) –

  • kwargs (Any) –

Return type

Dict[str, Any]

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

生成特定keyspace的模式的markdown表示形式，通过迭代该keyspace中的所有表，并调用它们的as_markdown方法。

参数：

keyspace：要为其生成markdown文档的keyspace的名称。 tables：keyspace中的表列表；如果未提供，将被解析。

返回：

包含指定keyspace模式的markdown表示形式的字符串。

Parameters

  • keyspace (str) –

  • tables (Optional[List[Table]]) –

Return type

str

format_schema_to_markdown() → str[source]

生成CassandraDatabase实例中所有keyspaces和tables的模式的markdown表示。此方法利用format_keyspace_to_markdown方法为每个keyspace创建markdown部分，将它们组装成一个全面的模式文档。

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

返回：

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

Return type

str

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

返回可能在代理提示中需要的数据库上下文。

Return type

Dict[str, Any]

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

获取指定keyspace的Table对象。

Parameters

keyspace (str) –

Return type

List[Table]

get_table_data(keyspace: str, table: str, predicate: str, limit: int) → str[source]

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

Parameters

  • keyspace (str) –

  • table (str) –

  • predicate (str) –

  • limit (int) –

Return type

str

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

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

Parameters

  • query (str) –

  • fetch (str) –

  • kwargs (Any) –

Return type

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