配置插件

概述

插件是 Java 归档(.jar)文件,通过添加图算法、数据集成、可视化和监控工具等新功能和特性来扩展 Neo4j 的功能。

Neo4j 社区版 (CE) 和企业版 (EE) 都附带了一系列预安装产品,例如 products 目录下的 Gen AI、Bloom 和 Graph Data Science,以及 labs 目录下的 APOC Core jar 文件。

在 Neo4j 4.4.45+、5.26.12+ 以及 2025.08.0 到 2026.02.2(含)之间的版本中,products 目录中也包含了集群管理(Fleet management)。然而,从 Neo4j 2026.03 开始,Fleet Manager 已内置并默认启用,因此该插件不再受支持。有关如何在 Neo4j 4.4.45+、5.26.12+ 以及 2025.08.0 至 2026.02.2(含)版本中启用集群管理插件的详细信息,请参阅 安装和配置插件

由于功能有限(例如没有可用指标),在 Neo4j CE 部署中使用集群管理插件会受到一些限制。此外,该插件以“尽力而为”的方式提供。Neo4j 不为其提供任何技术支持。

如果您的 Neo4j CE 安装未包含捆绑的 GDS 插件,请查看 Neo4j Graph Data Science 库手册 → 支持的 Neo4j 版本 以找到匹配的 GDS 库版本并单独下载。有关详细安装步骤,请参阅相应的 Neo4j GDS 手册。

其中一些插件(如 Bloom 和 GDS Enterprise)需要许可证激活密钥。请联系您的 Neo4j 客户代表,或请求代表与您联系

如果您想使用自己的插件或任何其他受支持的插件(如 APOC Extended 和 Neo4jsemantics),请确保将它们下载并添加到 plugins 目录中。有关更多信息,请参阅它们各自的文档。

受支持的插件及文档

支持以下插件

表 1. 受支持的 Neo4j 插件及文档
名称 需要许可证激活密钥 文档

APOC Core

apoc

APOC Extended

apoc-extended

Bloom

bloom

[1]

集群管理 (Fleet management) [2]

fleet-management

生成式 AI (GenAI)

genai

图数据科学 (Graph Data Science)

graph-data-science

[3]

Neosemantics

n10s

1. 您也可以在 Neo4j Desktop 或 Neo4j Aura 控制台中通过 Graph Apps 使用 Bloom 获取基本访问权限,无需许可证密钥。
2. 从 Neo4j 2026.03 开始,Fleet Manager 已内置并默认启用。集群管理插件在 2026.03 及更高版本中不受支持。
3. Graph Data Science 同时适用于 Neo4j CE 和 EE 版本。企业版包含额外功能,需要许可证密钥。

有关在不同 Neo4j 设置中使用插件的更多信息,请参阅

安装和配置插件

要在 Neo4j 部署中安装和配置插件,请按照以下步骤操作。如果您使用的是集群,则必须**在每台服务器上**安装该插件。

  1. 将插件(.jar 文件)从 <NEO4J_HOME>/products<NEO4J_HOME>/labs 移动或复制到 <NEO4J_HOME>/plugins 目录中。有关更多信息,请参阅 默认文件位置

    有些插件未随 Neo4j 捆绑,需要单独下载,例如 APOC Extended 和 Neosemantics。有关更多信息和相关文档链接,请参阅 受支持的插件及文档

  2. 所有插件都提供了一系列过程供您使用其功能。要运行这些过程,请将相应的插件添加到 neo4j.conf 文件中的以下设置中:

    • dbms.security.procedures.unrestricted

    • 如果插件需要许可证密钥,请同时添加许可证密钥文件的路径。

    • 如果您的配置中设置了 dbms.security.procedures.allowlist,也请将该插件添加到此设置中,否则无需更改。默认情况下,加载所有过程。有关更多信息,请参阅 保护扩展

      # to enable APOC core:
      # * dbms.security.procedures.unrestricted=apoc.*
      # * dbms.security.procedures.allowlist=apoc.*
      
      # to enable APOC Extended:
      # * dbms.security.procedures.unrestricted=apoc.*,apoc.extended.*
      # * dbms.security.procedures.allowlist=apoc.*,apoc.extended.*
      
      #  to enable Bloom:
      # * dbms.security.procedures.unrestricted=bloom.*
      # * dbms.security.procedures.allowlist=bloom.*
      # * dbms.bloom.license_file=/path/to/my/license/keyfile
      
      # to enable Fleet management:
      # * dbms.security.procedures.unrestricted=fleetManagement.*
      # * dbms.security.procedures.allowlist=fleetManagement.*
      
      # to enable GDS:
      # * dbms.security.procedures.unrestricted=gds.*
      # * dbms.security.procedures.allowlist=gds.*
      # * gds.enterprise.license_file=/path/to/my/license/keyfile
      
      #  to enable both GDS and Bloom:
      # * dbms.security.procedures.unrestricted=gds.*,bloom.*
      # * dbms.security.procedures.allowlist=gds.*,bloom.*
      # * gds.enterprise.license_file=/path/to/my/license/keyfile
      # * dbms.bloom.license_file=/path/to/my/license/keyfile
      
      # to enable GenAI:
      # * dbms.security.procedures.unrestricted=genai.*
      # * dbms.security.procedures.allowlist=genai.*
      
      # to enable Neosemantics:
      # * dbms.security.procedures.unrestricted=n10s.*
      # * dbms.security.procedures.allowlist=n10s.*
  3. 重启 Neo4j 以加载插件并使其可供使用。

    所有已安装的插件将在每次启动 Neo4j 时自动加载。因此,插件的数量可能会影响启动时间。仅安装必要的插件以避免性能问题。

有关如何使用插件的更多信息,请参阅其各自的文档(链接见 受支持的插件及文档)。