配置选项

配置选项的位置

来自 配置选项参考 的所有配置选项都可以通过以下方式提供

选项 描述

环境变量

通过 export key=val 或 --env 设置在使用 docker 时设置。

conf/apoc.conf

位于与 neo4j.conf 相同的文件夹中

此表的顺序与其配置选项优先级匹配。例如，任何环境设置都将覆盖在 apoc.conf 中设置的选项。

APOC Extended 在内部依赖于 Apache commons-config 来解析配置设置。元配置位于 src/main/resources/apoc-config.xml 中。

配置选项参考

  • apoc.export.file.enabled: 启用将本地文件写入磁盘。

  • apoc.import.file.enabled: 启用从磁盘读取本地文件。

  • apoc.import.file.use_neo4j_config: 从磁盘读取本地文件时使用 Neo4j 配置设置。

  • apoc.http.timeout.connect: 设置出站 HTTP 连接建立的超时时间。

  • apoc.http.timeout.read: 设置出站 HTTP 读取的超时时间。

  • apoc.jobs.scheduled.num_threads: 计划执行线程池大小。

  • apoc.jobs.pool.num_threads: 后台执行线程池大小。

  • apoc.jobs.queue.size: 后台执行作业队列大小。

  • apoc.couchbase.<key>.uri: 在一个键下存储 couchbase-url，供 couchbase 过程使用

  • apoc.es.<key>.uri: 在一个键下存储 es-url，供 elasticsearch 过程使用

  • apoc.jdbc.<key>.uri: 在一个键下存储 JDBC URL，供 apoc.load.jdbc 使用

  • apoc.mongodb.<key>.uri: 在一个键下存储 MongoDB URL，供 MongoDB 过程使用

  • apoc.ttl.enabled: 启用生存时间 (TTL) 后台任务

  • apoc.ttl.enabled.<name_db>: 为特定数据库启用生存时间 (TTL) 后台任务。请注意，此键必须在 apoc.conf 中设置。如果为 true，则即使 apoc.ttl.enabled 为 false，也会为数据库启用 TTL；如果为 false，则即使 apoc.ttl.enabled 为 true，也会为数据库禁用 TTL

  • apoc.ttl.schedule: 设置运行 TTL 后台任务的频率（以秒为单位）

  • apoc.ttl.schedule.<name_db>: 设置为特定数据库运行 TTL 后台任务的频率（以秒为单位）。它优先于 apoc.ttl.schedule。请注意，此键必须在 apoc.conf 中设置。

  • apoc.ttl.limit: 在一个后台事务中删除节点的最大数量，即在删除节点期间应用于 apoc.periodic.iterate() 的 batchSize

  • apoc.ttl.limit.<name_db>: 在一个后台事务中为特定数据库删除节点的最大数量，即在为特定数据库删除节点期间应用于 apoc.periodic.iterate() 的 batchSize。它优先于 apoc.ttl.limit。请注意，此键必须在 apoc.conf 中设置。

  • apoc.uuid.enabled: 启用 UUID 处理程序的全局开关

  • apoc.uuid.enabled.<name_db>: 为特定数据库启用/禁用 UUID 处理程序。请注意，此键必须在 apoc.conf 中设置。如果为 true，则即使 apoc.uuid.enabled 为 false，也会为数据库启用 UUID；如果为 false，则即使 apoc.uuid.enabled 为 true，也会为数据库禁用 UUID

表 1. apoc.export.file.enabled

描述

启用将本地文件写入磁盘。

有效值

布尔值

默认值

false
表 2. apoc.import.file.enabled

描述

启用从磁盘读取本地文件。

有效值

布尔值

默认值

false
表 3. apoc.import.file.use_neo4j_config

描述

如果启用，此设置将控制是否允许文件系统访问，并可能通过读取两个配置参数 dbms.security.allow_csv_import_from_file_urls 和 server.directories.import 分别将其限制在特定目录。

有效值

布尔值

默认值

true
表 4. apoc.http.timeout.connect

描述

设置一个指定的超时值（以毫秒为单位），用于与 URI 通信。如果在建立连接之前超时过期，则会引发异常。超时值为零表示无限超时。

有效值

整数

默认值

10000
表 5. apoc.http.timeout.read

描述

设置一个指定的超时值（以毫秒为单位），用于与 URI 通信。如果在数据可供读取之前超时过期，则会引发异常。超时值为零表示无限超时。

有效值

整数

默认值

60000
表 6. apoc.jobs.scheduled.num_threads

描述

apoc.periodic.* 过程依赖于一个计划的执行程序，该执行程序具有一个默认固定大小的线程池。可以使用此配置属性配置池大小。

有效值

整数

默认值

CPU 核心数 / 4
表 7. apoc.jobs.pool.num_threads

描述

用于后台执行的默认 APOC 线程池中的线程数。

有效值

整数

默认值

CPU 核心数 * 2
表 8. apoc.jobs.queue.size

描述

ThreadPoolExecutor 工作队列的大小。

有效值

整数

默认值

apoc.jobs.pool.num_threads * 5
表 9. apoc.couchbase.<key>.uri

描述

在一个键下存储 Couchbase URL，供 Couchbase 过程的第一个参数使用

有效值

字符串

默认值

null，即从 Couchbase 过程的第一个参数中获取 URL
表 10. apoc.es.<key>.uri=es-url-with-credentials

描述

在一个键下存储 ES URL，供 Elasticsearch 过程的第一个参数使用

有效值

字符串

默认值

null，即从 Elasticsearch 过程的第一个参数中获取 URL
表 11. apoc.jdbc.<key>.uri

描述

在一个键下存储 JDBC URL，供 apoc.load.jdbc 过程的第一个参数使用

有效值

字符串

默认值

null，即从 apoc.load.jdbc 过程的第一个参数中获取 URL
表 12. apoc.mongodb.<key>.uri

描述

在一个键下存储 JDBC URL，供 MongoDB 过程的第一个参数使用

有效值

字符串

默认值

null，即从 MongoDB 过程的第一个参数中获取 URL
表 13. apoc.ttl.enabled

描述

启用生存时间 (TTL) 后台任务

有效值

布尔值

默认值

false
表 14. apoc.ttl.enabled.<name_db>

描述

为特定数据库启用生存时间 (TTL) 后台任务。请注意，此键必须在 apoc.conf 中设置。如果为 true，则即使 apoc.ttl.enabled 为 false，也会为数据库启用 TTL；如果为 false，则即使 apoc.ttl.enabled 为 true，也会为数据库禁用 TTL

有效值

布尔值

默认值

apoc.ttl.enabled 配置值
表 15. apoc.ttl.schedule

描述

设置运行 TTL 后台任务的频率（以秒为单位）

有效值

整数

默认值

60
表 16. apoc.ttl.schedule.<name_db>

描述

设置为特定数据库运行 TTL 后台任务的频率（以秒为单位）。它优先于 apoc.ttl.schedule。请注意，此键必须在 apoc.conf 中设置。

有效值

整数

默认值

apoc.ttl.schedule 配置值
表 17. apoc.ttl.limit

描述

在一个后台事务中删除节点的最大数量，即在删除节点期间应用于 apoc.periodic.iterate() 的 batchSize

有效值

整数

默认值

1000
表 18. apoc.ttl.limit.<name_db>

描述

在一个后台事务中为特定数据库删除节点的最大数量，即在为特定数据库删除节点期间应用于 apoc.periodic.iterate() 的 batchSize。它优先于 apoc.ttl.limit。请注意，此键必须在 apoc.conf 中设置。

有效值

整数

默认值

1000
表 19. apoc.uuid.enabled

描述

启用 UUID 处理程序的全局开关

有效值

布尔值

默认值

false
表 20. apoc.jobs.queue.size

描述

为特定数据库启用/禁用 UUID 处理程序。请注意，此键必须在 apoc.conf 中设置。如果为 true，则即使 apoc.uuid.enabled 为 false，也会为数据库启用 UUID；如果为 false，则即使 apoc.uuid.enabled 为 true，也会为数据库禁用 UUID

有效值

布尔值

默认值

apoc.uuid.enabled 配置值