langchain_community.graphs.kuzu_graph.KuzuGraph¶

class langchain_community.graphs.kuzu_graph.KuzuGraph(db: Any, database: str = 'kuzu')[source]¶

Kùzu wrapper for graph operations.

Security note: Make sure that the database connection uses credentials

that are narrowly-scoped to only include necessary permissions. Failure to do so may result in data corruption or loss, since the calling code may attempt commands that would result in deletion, mutation of data if appropriately prompted or reading sensitive data if such data is present in the database. The best way to guard against such negative outcomes is to (as appropriate) limit the permissions granted to the credentials used with this tool.

See https://python.langchain.com/docs/security for more information.

Attributes

get_schema

Returns the schema of the Kùzu database

Methods

__init__(db[, database])

query(query[, params])

Query Kùzu database

refresh_schema()

Refreshes the Kùzu graph schema information
Parameters

  • db (Any) –

  • database (str) –

__init__(db: Any, database: str = 'kuzu') → None[source]¶
Parameters

  • db (Any) –

  • database (str) –

Return type

None

query(query: str, params: dict = {}) → List[Dict[str, Any]][source]¶

Query Kùzu database

Parameters

  • query (str) –

  • params (dict) –

Return type

List[Dict[str, Any]]

refresh_schema() → None[source]¶

Refreshes the Kùzu graph schema information

Return type

None

Examples using KuzuGraph¶