GraphDataScience¶

class graphdatascience.GraphDataScience¶

Neo4j 图数据科学 Python 客户端的主要 API 类。始终将此对象绑定到名为 gds 的变量。

构造一个新的 GraphDataScience 对象。

参数:

endpoint (Union[str, Driver, QueryRunner]) – 要连接到的 Neo4j 端点。通常，这是一个 Bolt 连接 URI。
auth (Optional[Tuple[str, str]], 默认 None) – 用于数据库认证的用户名、密码对。
aura_ds (bool, 默认 False) – 一个标志，指示客户端是否用于连接到 Neo4j AuraDS 实例。
database (Optional[str], 默认 None) – 要查询的 Neo4j 数据库。
arrow (Union[str, bool], 默认 True) –
Arrow 连接信息。这可以是一个字符串或一个布尔值。
- 如果是字符串，它将被解释为 GDS Arrow 服务器的连接 URL。
- 如果是布尔值
  - True 将使客户端通过 Neo4j 端点发现到 GDS Arrow 服务器的连接 URI。
  - False 将使客户端对所有操作使用 Bolt。
arrow_disable_server_verification (bool, 默认 True) – 一个标志，它覆盖其他 TLS 设置并禁用 TLS 连接的服务器验证。
arrow_tls_root_certs (Optional[bytes], 默认 None) – 用于连接到 GDS Arrow Flight 服务器的 PEM 编码证书。
bookmarks (Optional[Any], 默认 None) – Neo4j 书签，用于在执行下一个查询之前要求特定状态。
show_progress (bool, 默认 True) – 一个标志，指示是否显示运行中过程的进度条。

bookmarks() → Any | None¶

获取定义当前查询执行所需状态的 Neo4j 书签

返回类型:: 定义当前所需状态的（可能为 None 的）Neo4j 书签

close() → None¶: 关闭 GraphDataScience 对象并释放其占用的所有资源。

database() → str | None¶

获取查询所针对的数据库。

返回值:: 数据库的名称。

driver_config() → dict[str, Any]¶

获取用于创建底层驱动程序以向 Neo4j 发送查询的配置。

返回值:: 配置以字典形式表示。

find_node_id(labels: list[str] = [], properties: dict[str, Any] = {}) → int¶

查找具有给定标签和属性的节点的节点 ID。

参数:

labels – 要查找节点的标签。
properties – 要查找节点的属性。

返回值:

具有给定标签和属性的节点的节点 ID。

last_bookmarks() → Any | None¶

获取定义最近调用查询之后状态的 Neo4j 书签

返回类型:: 定义最近调用查询之后状态的（可能为 None 的）Neo4j 书签

list() → DataFrame¶

列出所有可用的 GDS 过程。

返回值:: 一个包含所有可用 GDS 过程的 DataFrame。

lp_pipe(name: str) → LPTrainingPipeline¶

创建一个链接预测训练管道，使用所有默认设置。

参数:: name (str) – 给管道的名称。在管道目录中必须是唯一的。
返回值:: 链接预测管道对象的新实例。

nc_pipe(name: str) → NCTrainingPipeline¶

创建一个节点分类训练管道，使用所有默认设置。

参数:: name (str) – 给管道的名称。在管道目录中必须是唯一的。
返回值:: 节点分类管道对象的新实例。

nr_pipe(name: str) → NRTrainingPipeline¶

创建一个节点回归训练管道，使用所有默认设置。

参数:: name (str) – 给管道的名称。在管道目录中必须是唯一的。
返回值:: 节点回归管道对象的新实例。

run_cypher(query: str, params: dict[str, Any] | None = None, database: str | None = None) → DataFrame¶

运行 Cypher 查询

参数:

query (str) – Cypher 查询
params (Dict[str, Any]) – 查询参数
database (str) – 运行查询的数据库
返回值 – 查询结果以 DataFrame 形式返回

server_version() → ServerVersion¶

获取 GDS 库的版本。

返回值:: GDS 库的版本。

set_bookmarks(bookmarks: Any) → None¶

设置 Neo4j 书签，以便在执行下一个查询之前要求特定状态

参数:: bookmarks (Bookmark(s)) – 定义所需状态的 Neo4j 书签

set_database(database: str) → None¶

设置查询所针对的数据库。

参数:: database (str) – 运行查询的数据库名称。

set_show_progress(show_progress: bool) → None¶

设置是否显示运行中过程的进度。

参数:: show_progress (bool) – 是否显示过程的进度。

version() → str¶

获取 GDS 库的版本。

返回值:: GDS 库的版本。