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.

All settings
gds.arrow.abortion_timeout	The maximum time to wait for the next command before aborting the import process.	Enterprise Edition
gds.arrow.advertised_listen_address	Address that clients should use to connect to the GDS Arrow Flight Server.	Enterprise Edition
gds.arrow.batch_size	The batch size used for arrow property export.	Enterprise Edition
gds.arrow.enabled	Enable the GDS Arrow Flight Server.	Enterprise Edition
gds.arrow.encryption.never	Never activate server-side encryption for the GDS Arrow Flight Server.	Enterprise Edition
gds.arrow.listen_address	Address the GDS Arrow Flight Server should bind to.	Enterprise Edition
gds.memory.arrow.max_size	The maximum amount of memory in bytes the GDS Arrow Flight Server can allocate.	Enterprise Edition
gds.cluster.tx.max.size	Set the maximum transaction size for GDS write back when running in Neo4j Cluster.	Enterprise Edition
gds.cluster.tx.min.size	Set the minimum transaction size for GDS write back when running in Neo4j Cluster.	Enterprise Edition
gds.enterprise.license_file	Sets the location of the file that contains the Neo4j Graph Data Science library license key.
gds.export.location	Sets the export location for file based exports.	Enterprise Edition
gds.model.store_location	Sets the location where persisted models are stored.	Enterprise Edition
gds.progress_tracking_enabled	Enable progress logging tracking.
gds.validate_using_max_memory_estimation	Use maximum memory estimation in procedure memory guard.

gds.arrow.abortion_timeout Enterprise Edition
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 Enterprise Edition
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 Enterprise Edition
Description	The batch size used for arrow property export.
Default Value	`10000`
Valid Values	An integer.
Dynamic	`true`

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

gds.arrow.encryption.never Enterprise Edition
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 Enterprise Edition
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 Enterprise Edition
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`

gds.cluster.tx.max.size Enterprise Edition
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 Enterprise Edition
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.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.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`

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`