GDS Configuration Settings

This page describes the available configuration settings in GDS. Refer to The neo4j.conf file for details on how to use configuration settings.

GDS Enterprise Edition

gds.enterprise.license_file
Description	Sets the location of the file that contains the Neo4j Graph Data Science library license key.
Default Value	`No Value`
Valid Values	An absolute path.
Dynamic	`false`

GDS and Arrow

gds.arrow.abortion_timeout
Description	The maximum time to wait for the next command before aborting the import process.
Default Value	`10m`
Valid Values	A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d` default unit is `s`).
Dynamic	`false`

gds.arrow.advertised_listen_address
Description	Address that clients should use to connect to the GDS Arrow Flight Server.
Default Value	`:8491`
Valid Values	A socket address in the format `hostname:port`, `hostname` or `:port`. If missing port or hostname it is acquired from `gds.arrow.listen_address`.
Dynamic	`false`

gds.arrow.batch_size
Description	The batch size used for arrow property export.
Default Value	`10000`
Valid Values	An integer.
Dynamic	`true`

gds.arrow.enabled
Description	Enable the GDS Arrow Flight Server.
Default Value	`false`
Valid Values	A boolean.
Dynamic	`false`

gds.arrow.encryption.never
Description	Never activate server-side encryption for the GDS Arrow Flight Server.
Default Value	`false`
Valid Values	A boolean.
Dynamic	`false`

gds.arrow.listen_address
Description	Address the GDS Arrow Flight Server should bind to.
Default Value	`localhost:8491`
Valid Values	A socket address in the format `hostname:port`, `hostname` or `:port`.
Dynamic	`false`

gds.memory.arrow.max_size
Description	The maximum amount of memory in bytes the GDS Arrow Flight Server can allocate.
Default Value	`Long.MAX_VALUE`
Valid Values	A long.
Dynamic	`false`

Neo4j Cluster

gds.cluster.tx.max.size
Description	Set the maximum transaction size for GDS write back when running in Neo4j Cluster.
Default Value	`100000`
Valid Values	An integer, must be set greater than or equal to the value of `gds.cluster.tx.min.size`.
Dynamic	`false`

gds.cluster.tx.min.size
Description	Set the minimum transaction size for GDS write back when running in Neo4j Cluster.
Default Value	`10000`
Valid Values	An integer.
Dynamic	`false`

GDS Export

gds.export.location
Description	Sets the export location for file based exports.
Default Value	`No Value`
Valid Values	An absolute path.
Dynamic	`false`

gds.model.store_location Enterprise Edition
Description	Sets the location where persisted models are stored.
Default Value	`No Value`
Valid Values	An absolute path.
Dynamic	`false`

Miscellaneous

gds.progress_tracking_enabled
Description	Enable progress logging tracking.
Default Value	`true`
Valid Values	A boolean.
Dynamic	`false`

gds.validate_using_max_memory_estimation
Description	Use maximum memory estimation in procedure memory guard.
Default Value	`false`
Valid Values	A boolean.
Dynamic	`false`