Configuration 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 override 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
-
apoc.export.file.enabled: Enables writing local files to disk.
-
apoc.import.file.enabled: Enables reading local files from disk.
-
apoc.import.file.use_neo4j_config: Uses Neo4j settings when reading local files from disk.
-
apoc.http.timeout.connect: Sets a timeout for outbound HTTP connection establishment.
-
apoc.http.timeout.read: Set a timeout for outbound HTTP reads.
-
.apoc.initializer.cypher: Cypher statement to be executed once the database starts.
-
.apoc.initializer.cypher.<key>: Cypher statements to be executed once the database starts.
-
apoc.jobs.scheduled.num_threads: Scheduled execution thread pool size.
-
apoc.jobs.pool.num_threads: Background execution thread pool size.
-
apoc.jobs.queue.size: Background execution job queue size.
-
apoc.trigger.enabled: Enables triggers.
-
apoc.uuid.enabled: Enables UUID handlers.
-
apoc.uuid.enabled.<db>: Enables UUID handlers for a specific db.
-
apoc.ttl.enabled: Enable TTL background tasks.
-
apoc.ttl.enabled.<db>: Enables TTL background task for a specific db.
-
apoc.ttl.schedule: Sets frequency of TTL background tasks.
-
apoc.ttl.schedule.<db>: Sets frequency of TTL background tasks for a specific db.
-
apoc.ttl.limit: Maximum TTL limit.
-
apoc.ttl.limit.<db>: Maximum TTL limit for a specific db
-
apoc.spatial.geocode.provider: Configuration for geocode providers.
-
apoc.spatial.geocode.<providerName>.<key>: Configuration for a given geocode provider.
-
apoc.jdbc.<key>.uri: Stores JDBC URLs to be used.
-
apoc.couchbase.<key>.uri: Stores CouchBase URLs to be used.
-
apoc.es.<key>.uri: Store ElasticSearch URLs to be used.
-
apoc.mongodb.<key>.uri: Store MongoDB URLs to be used.
-
apoc.max.decompression.ratio: Limits the relative size a decompressed file can reach with respect to the compressed file in the loading procedures.
Description |
Enable writing local files to disk. |
Valid values |
Booleans |
Default value |
|
Description |
Enable reading local files from disk |
Valid values |
Booleans |
Default value |
|
Description |
The procedures check whether file system access is allowed and possibly constrained to a specific directory by reading the two configuration parameters dbms.security.allow_csv_import_from_file_urls and dbms.directories.import respectively. |
Valid values |
Booleans |
Default value |
|
Description |
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, an exception is raised. A timeout of zero is interpreted as an infinite timeout. |
Valid values |
Integers |
Default value |
|
Description |
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, an exception is raised. A timeout of zero is interpreted as an infinite timeout. |
Valid values |
Integers |
Default value |
|
Description |
Cypher statement to be executed once the database is started. |
Valid values |
String |
Default value |
|
Description |
Multiple Cypher statements to be executed once the database is started. |
Valid values |
String |
Default value |
|
Description |
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. |
Valid values |
Integers |
Default value |
|
Description |
Number of threads in the default APOC thread pool used for background executions. |
Valid values |
Integers |
Default value |
|
Description |
Size of the queue ThreadPoolExecutor working queue |
Valid values |
Integers |
Default value |
|
Description |
Enables triggers. |
Valid values |
Booleans |
Default value |
|
Description |
Global switch to enable uuid handlers. |
Valid values |
Booleans |
Default value |
|
Description |
Enable/disable uuid handlers for a specific db.
Please note that this key has to be set necessarily in |
Valid values |
Booleans |
Default value |
|
Description |
Enable time to live background task |
Valid values |
Booleans |
Default value |
|
Description |
Enables time to live background task for a specific db. Please note that this key has to be set necessarily in
|
Valid values |
Booleans |
Default value |
|
Description |
Set frequency in seconds to run ttl background task |
Valid values |
Integers |
Default value |
|
Description |
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 |
Valid values |
Integers |
Default value |
|
Description |
Maximum number of nodes being deleted in one background transaction, that is the batchSize applied to apoc.periodic.iterate() during removing nodes. |
Valid values |
Integers |
Default value |
|
Description |
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 |
Valid values |
Integers |
Default value |
|
Description |
Configuration for geocoding providers, keys and values are provider specific, see Configuring Geocode Provider. |
Valid values |
String |
Default value |
|
Description |
Configuration for geocoding providers, keys and values are provider specific, see Configuring Geocode Provider. |
Valid values |
String |
Default value |
|
Description |
Store JDBC URLs under a key to be used by apoc.load.jdbc. The URLs must contain credentials. |
Valid values |
URL |
Default value |
|
Description |
Store CouchBase URLs under a key to be used by couchbase procedures. The URLs must contain credentials. |
Valid values |
URLs |
Default value |
|
Description |
Store ElasticSearch URLs under a key to be used by elasticsearch procedures. The URLs must contain credentials. |
Valid values |
URLs |
Default value |
|
Description |
Store MongoDB URLs under a key to be used by MongoDB procedures. The URLs must contain credentials. |
Valid values |
URL |
Default value |
|
Description |
Limits the relative size a decompressed file can reach with respect to the compressed file in the loading procedures. If negative, no limit to the decompressed size is imposed. |
Valid values |
Integers different from 0 |
Default value |
|