配置选项

配置选项的位置

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

选项描述

选项	描述
环境变量	通过 `export key=val` 设置，或者在使用 Docker 时通过 `--env` 设置。
`conf/apoc.conf`	位于与 `neo4j.conf` 相同的文件夹中

环境变量

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

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 配置值`