GraphDataScience

class graphdatascience.GraphDataScience

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

__init__(endpoint: str | Driver | QueryRunner, auth: Tuple[str, str] | None = None, aura_ds: bool = False, database: str | None = None, arrow: str | bool = True, arrow_disable_server_verification: bool = True, arrow_tls_root_certs: bytes | None = None, bookmarks: Any | None = None, show_progress: bool = True)

构造一个新的 GraphDataScience 对象。

参数：

  • endpoint (Union[str, Driver, QueryRunner]) – 要连接到的 Neo4j 端点。通常，这是一个 Bolt 连接 URI。

  • auth (Optional[Tuple[str, str]], default None) – 用于数据库身份验证的用户名和密码对。

  • aura_ds (bool, default False) – 一个标志，指示客户端用于连接到 Neo4j AuraDS 实例。

  • database (Optional[str], default None) – 要查询的 Neo4j 数据库。

  • arrow (Union[str, bool], default True) –

    Arrow 连接信息。这可以是字符串或布尔值。

    • 如果它是字符串，则将其解释为到 GDS Arrow 服务器的连接 URL。

    • 如果是布尔值

      • True 将使客户端通过 Neo4j 端点发现到 GDS Arrow 服务器的连接 URI。

      • False 将使客户端对所有操作使用 Bolt。

  • arrow_disable_server_verification (bool, default True) – 一个标志，覆盖其他 TLS 设置并禁用 TLS 连接的服务器验证。

  • arrow_tls_root_certs (Optional[bytes], default None) – 用于连接到 GDS Arrow Flight 服务器的 PEM 编码证书。

  • bookmarks (Optional[Any], default None) – Neo4j 书签，要求在执行下一个查询之前处于特定状态。

  • show_progress (bool, default 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 库的版本。