langchain_community.graphs.arangodb_graph.ArangoGraph

class langchain_community.graphs.arangodb_graph.ArangoGraph(db: Any)[source]

ArangoDB图操作的包装器。

安全提示: 确保数据库连接使用的凭据范围狭窄,仅包括必要的权限。

如果未能这样做,可能会导致数据损坏或丢失,因为调用代码可能尝试执行会导致删除、变异数据(如果适当提示)或读取敏感数据(如果数据库中存在此类数据)的命令。 防止出现这种负面结果的最佳方法是(视情况)限制授予此工具使用的凭据的权限。

有关更多信息,请参见 https://python.langchain.com/docs/security

创建一个新的ArangoDB图形包装器实例。

Attributes

db

schema

Methods

__init__(db)

创建一个新的ArangoDB图形包装器实例。

from_db_credentials([url, dbname, username, ...])

方便的构造函数,用于从凭据构建Arango DB。

generate_schema([sample_ratio])

生成ArangoDB数据库的模式并返回 用户可以指定一个 sample_ratio (0到1)来确定 用于呈现每个Collection模式的文档/边的比例(相对于Collection大小)。

query(query[, top_k])

查询ArangoDB数据库。

set_db(db)

set_schema([schema])

设置ArangoDB数据库的模式。 如果 schema 为None,则自动生成模式。

Parameters

db (Any) –

Return type

None

__init__(db: Any) None[source]

创建一个新的ArangoDB图形包装器实例。

Parameters

db (Any) –

Return type

None

classmethod from_db_credentials(url: Optional[str] = None, dbname: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None) Any[source]

方便的构造函数,用于从凭据构建Arango DB。

参数:

url: Arango DB的URL。可以作为命名参数传递,也可以设置为环境变量``ARANGODB_URL``。默认为”http://localhost:8529”。 dbname: Arango DB的名称。可以作为命名参数传递,也可以设置为环境变量``ARANGODB_DBNAME``。默认为”_system”。 username: 可以作为命名参数传递,也可以设置为环境变量``ARANGODB_USERNAME``。默认为”root”。 password: 可以作为命名参数传递,也可以设置为环境变量``ARANGODB_PASSWORD``。默认为””。

返回:

一个arango.database.StandardDatabase。

Parameters
  • url (Optional[str]) –

  • dbname (Optional[str]) –

  • username (Optional[str]) –

  • password (Optional[str]) –

Return type

Any

generate_schema(sample_ratio: float = 0) Dict[str, List[Dict[str, Any]]][source]

生成ArangoDB数据库的模式并返回 用户可以指定一个 sample_ratio (0到1)来确定 用于呈现每个Collection模式的文档/边的比例(相对于Collection大小)。

Parameters

sample_ratio (float) –

Return type

Dict[str, List[Dict[str, Any]]]

query(query: str, top_k: Optional[int] = None, **kwargs: Any) List[Dict[str, Any]][source]

查询ArangoDB数据库。

Parameters
  • query (str) –

  • top_k (Optional[int]) –

  • kwargs (Any) –

Return type

List[Dict[str, Any]]

set_db(db: Any) None[source]
Parameters

db (Any) –

Return type

None

set_schema(schema: Optional[Dict[str, Any]] = None) None[source]

设置ArangoDB数据库的模式。 如果 schema 为None,则自动生成模式。

Parameters

schema (Optional[Dict[str, Any]]) –

Return type

None

Examples using ArangoGraph