Configuration Options
Location of config options
APOC for 4.0 introduces new configuration management. All config options from Reference of config options can be provided either in:
environment variables |
set them either via |
system properties |
best to use via |
|
located side-by-side with |
The order of this table matches their config option precedence. E.g. any env setting will orverride options set in apoc.conf.
|
APOC internally relies on Apache commons-config for resolving config settings.
The meta-configuration is located in |
Reference of config options
Set these config options in $NEO4J_HOME/conf/apoc.conf, via system properties or environment variables.
All boolean options have the default value set to false. This means that they are disabled, unless mentioned otherwise.
| Property | Description |
|---|---|
|
store couchbase-urls under a key to be used by couchbase procedures |
|
store es-urls under a key to be used by elasticsearch procedures |
|
Enable writing local files to disk |
|
Sets a specified timeout value, in milliseconds, to be used when communicating with a URI. If the timeout expires before the connection can be established, a Neo.ClientError.Procedure.ProcedureCallFailed exception is raised. A timeout of zero is interpreted as an infinite timeout. |
|
Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from a connection established to a resource. If the timeout expires before there is data available for read, a Neo.ClientError.Procedure.ProcedureCallFailed exception is raised. A timeout of zero is interpreted as an infinite timeout. |
|
Enable reading local files from disk |
|
the procedures check whether file system access is allowed and possibly constrained to a specific directory by reading the two configuration parameters |
|
a cypher statment to be executed once the database is started |
|
multiple cypher statements to be executed once the database is started |
|
store jdbc-urls under a key to be used by apoc.load.jdbc |
|
Many periodic procedures rely on a scheduled executor that has a pool of threads with a default fixed size. You can configure the pool size using this configuration property |
|
Number of threads in the default APOC thread pool used for background executions. |
|
Size of the queue ThreadPoolExecutor working queue |
|
store mongodb-urls under a key to be used by mongodb procedures |
|
configuration for geocoding providers, keys and values are provider specific, see [spatial] |
|
Enable triggers |
|
Enable time to live background task |
|
Enable time to live background task for a specific db. Please note that this key has to be set necessarily in |
|
Set frequency in seconds to run ttl background task |
|
Set frequency in seconds to run ttl background task for a specific db. It has priority over apoc.ttl.schedule. Please note that this key has to be set necessarily in |
|
Maximum number of nodes being deleted in one background transaction, that is the batchSize applied to apoc.periodic.iterate() during removing nodes |
|
Maximum number of nodes being deleted in one background transaction for a specific db, that is the batchSize applied to apoc.periodic.iterate() during removing nodes for a specific db. It has priority over apoc.ttl.limit. Please note that this key has to be set necessarily in |
|
global switch to enable uuid handlers |
|
Enable/disable uuid handlers for a specific db. Please note that this key has to be set necessarily in |