Appendix A. Reference

browser.allow_outgoing_connections

Configure the policy for outgoing Neo4j Browser connections.

browser.credential_timeout

Configure the Neo4j Browser to time out logged in users after this idle period.

browser.remote_content_hostname_whitelist

Whitelist of hosts for the Neo4j Browser to be allowed to fetch content from.

browser.retain_connection_credentials

Configure the Neo4j Browser to store or not store user credentials.

cypher.default_language_version

Set this to specify the default parser (language version).

cypher.forbid_exhaustive_shortestpath

This setting is associated with performance optimization.

cypher.forbid_shortestpath_common_nodes

This setting is associated with performance optimization.

cypher.hints_error

Set this to specify the behavior when Cypher planner or runtime hints cannot be fulfilled.

cypher.min_replan_interval

The minimum lifetime of a query plan before a query is considered for replanning.

cypher.planner

Set this to specify the default planner for the default language version.

cypher.statistics_divergence_threshold

The threshold when a plan is considered stale.

dbms.active_database

Name of the database to load.

dbms.allow_format_migration

Whether to allow a store upgrade in case the current version of the database starts against an older store version.

dbms.backup.address

Listening server for online backups.

dbms.backup.enabled

Enable support for running online backups.

dbms.checkpoint.interval.time

Configures the time interval between check-points.

dbms.checkpoint.interval.tx

Configures the transaction interval between check-points.

dbms.checkpoint.iops.limit

Limit the number of IOs the background checkpoint process will consume per second.

dbms.directories.certificates

Directory for storing certificates to be used by Neo4j for TLS connections.

dbms.directories.data

Path of the data directory.

dbms.directories.import

Sets the root directory for file URLs used with the Cypher LOAD CSV clause.

dbms.directories.lib

Path of the lib directory.

dbms.directories.logs

Path of the logs directory.

dbms.directories.metrics

The target location of the CSV files: a path to a directory wherein a CSV file per reported field will be written.

dbms.directories.plugins

Location of the database plugin directory.

dbms.directories.run

Path of the run directory.

dbms.import.csv.legacy_quote_escaping

Selects whether to conform to the standard https://tools.ietf.org/html/rfc4180 for interpreting escaped quotation characters in CSV files loaded using LOAD CSV.

dbms.index_sampling.background_enabled

Enable or disable background index sampling.

dbms.index_sampling.sample_size_limit

Index sampling chunk size limit.

dbms.index_sampling.update_percentage

Percentage of index updates of total index size required before sampling of a given index is triggered.

dbms.index_searcher_cache_size

The maximum number of open Lucene index searchers.

dbms.logs.debug.level

Debug log level threshold.

dbms.logs.debug.rotation.delay

Minimum time interval after last rotation of the debug log before it may be rotated again.

dbms.logs.debug.rotation.keep_number

Maximum number of history files for the debug log.

dbms.logs.debug.rotation.size

Threshold for rotation of the debug log.

dbms.logs.gc.enabled

Enable GC Logging.

dbms.logs.gc.options

GC Logging Options.

dbms.logs.gc.rotation.keep_number

Number of GC logs to keep.

dbms.logs.gc.rotation.size

Size of each GC log that is kept.

dbms.logs.http.enabled

Enable HTTP request logging.

dbms.logs.http.rotation.keep_number

Number of HTTP logs to keep.

dbms.logs.http.rotation.size

Size of each HTTP log that is kept.

dbms.logs.query.enabled

Log executed queries that take longer than the configured threshold, dbms.logs.query.threshold.

dbms.logs.query.parameter_logging_enabled

Log parameters for executed queries that took longer than the configured threshold.

dbms.logs.query.rotation.keep_number

Maximum number of history files for the query log.

dbms.logs.query.rotation.size

The file size in bytes at which the query log will auto-rotate.

dbms.logs.query.threshold

If the execution of query takes more time than this threshold, the query is logged - provided query logging is enabled.

dbms.memory.pagecache.size

The amount of memory to use for mapping the store files, in bytes (or kilobytes with the 'k' suffix, megabytes with 'm' and gigabytes with 'g').

dbms.memory.pagecache.swapper

Specify which page swapper to use for doing paged IO.

dbms.mode

Configure the operating mode of the database — 'SINGLE' for stand-alone operation, 'HA' for operating as a member in a cluster or 'ARBITER' for an HA-only cluster member with no database.

dbms.query_cache_size

The number of Cypher query execution plans that are cached.

dbms.read_only

Only allow read operations from this Neo4j instance.

dbms.record_format

Database record format.

dbms.relationship_grouping_threshold

Relationship count threshold for considering a node to be dense.

dbms.security.allow_csv_import_from_file_urls

Determines if Cypher will allow using file URLs when loading data using LOAD CSV.

dbms.security.auth_enabled

Enable auth requirement to access Neo4j.

dbms.security.ha_status_auth_enabled

Require authorization for access to the HA status endpoints.

dbms.security.http_authorization_classes

Comma-seperated list of custom security rules for Neo4j to use.

dbms.shell.enabled

Enable a remote shell server which Neo4j Shell clients can log in to.

dbms.shell.host

Remote host for shell.

dbms.shell.port

The port the shell will listen on.

dbms.shell.read_only

Read only mode.

dbms.shell.rmi_name

The name of the shell.

dbms.threads.worker_count

Number of Neo4j worker threads, your OS might enforce a lower limit than the maximum value specified here.

dbms.transaction.timeout

The maximum time interval of a transaction within which it should be completed.

dbms.transaction_timeout

Timeout for idle transactions in the REST endpoint.

dbms.tx_log.rotation.retention_policy

Make Neo4j keep the logical transaction logs for being able to backup the database.

dbms.tx_log.rotation.size

Specifies at which file size the logical log will auto-rotate.

dbms.udc.enabled

Enable the UDC extension.

dbms.unmanaged_extension_classes

Comma-separated list of <classname>=<mount point> for unmanaged extensions.

ha.allow_init_cluster

Whether to allow this instance to create a cluster if unable to join.

ha.branched_data_copying_strategy

Strategy for how to order handling of branched data on slaves and copying of the store from the master.

ha.branched_data_policy

Policy for how to handle branched data.

ha.broadcast_timeout

Timeout for broadcasting values in cluster.

ha.configuration_timeout

Timeout for waiting for configuration from an existing cluster member during cluster join.

ha.data_chunk_size

Max size of the data chunks that flows between master and slaves in HA.

ha.default_timeout

Default timeout used for clustering timeouts.

ha.election_timeout

Timeout for waiting for other members to finish a role election.

ha.heartbeat_interval

How often heartbeat messages should be sent.

ha.heartbeat_timeout

How long to wait for heartbeats from other instances before marking them as suspects for failure.

ha.host.coordination

Host and port to bind the cluster management communication.

ha.host.data

Hostname and port to bind the HA server.

ha.initial_hosts

A comma-separated list of other members of the cluster to join.

ha.internal_role_switch_timeout

Timeout for waiting for internal conditions during state switch, like for transactions to complete, before switching to master or slave.

ha.join_timeout

Timeout for joining a cluster.

ha.learn_timeout

Timeout for learning values.

ha.leave_timeout

Timeout for waiting for cluster leave to finish.

ha.max_acceptors

Maximum number of servers to involve when agreeing to membership changes.

ha.max_channels_per_slave

Maximum number of connections a slave can have to the master.

ha.paxos_timeout

Default value for all Paxos timeouts.

ha.phase1_timeout

Timeout for Paxos phase 1.

ha.phase2_timeout

Timeout for Paxos phase 2.

ha.pull_batch_size

Size of batches of transactions applied on slaves when pulling from master.

ha.pull_interval

Interval of pulling updates from master.

ha.role_switch_timeout

Timeout for request threads waiting for instance to become master or slave.

ha.server_id

Id for a cluster instance.

ha.slave_lock_timeout

Timeout for taking remote (write) locks on slaves.

ha.slave_only

Whether this instance should only participate as slave in cluster.

ha.slave_read_timeout

How long a slave will wait for response from master before giving up.

ha.tx_push_factor

The amount of slaves the master will ask to replicate a committed transaction.

ha.tx_push_strategy

Push strategy of a transaction to a slave during commit.

metrics.bolt.messages.enabled

Enable reporting metrics about Bolt Protocol message processing.

metrics.csv.enabled

Set to true to enable exporting metrics to CSV files.

metrics.csv.interval

The reporting interval for the CSV files.

metrics.cypher.replanning.enabled

Enable reporting metrics about number of occurred replanning events.

metrics.enabled

The default enablement value for all the supported metrics.

metrics.graphite.enabled

Set to true to enable exporting metrics to Graphite.

metrics.graphite.interval

The reporting interval for Graphite.

metrics.graphite.server

The hostname or IP address of the Graphite server.

metrics.jvm.buffers.enabled

Enable reporting metrics about the buffer pools.

metrics.jvm.gc.enabled

Enable reporting metrics about the duration of garbage collections.

metrics.jvm.memory.enabled

Enable reporting metrics about the memory usage.

metrics.jvm.threads.enabled

Enable reporting metrics about the current number of threads running.

metrics.neo4j.checkpointing.enabled

Enable reporting metrics about Neo4j check pointing.

metrics.neo4j.cluster.enabled

Enable reporting metrics about HA cluster info.

metrics.neo4j.counts.enabled

Enable reporting metrics about approximately how many entities are in the database.

metrics.neo4j.enabled

The default enablement value for all Neo4j specific support metrics.

metrics.neo4j.logrotation.enabled

Enable reporting metrics about the Neo4j log rotation.

metrics.neo4j.network.enabled

Enable reporting metrics about the network usage.

metrics.neo4j.pagecache.enabled

Enable reporting metrics about the Neo4j page cache.

metrics.neo4j.server.enabled

Enable reporting metrics about Server threading info.

metrics.neo4j.tx.enabled

Enable reporting metrics about transactions.

metrics.prefix

A common prefix for the reported metrics field names.

tools.consistency_checker.check_graph

Perform checks between nodes, relationships, properties, types and tokens.

tools.consistency_checker.check_indexes

Perform checks on indexes.

tools.consistency_checker.check_label_scan_store

Perform checks on the label scan store.

tools.consistency_checker.check_property_owners

Perform optional additional checking on property ownership.

dbms.index_sampling.buffer_size

Size of buffer used by index sampling.

Description

Configure the policy for outgoing Neo4j Browser connections.

Valid values

browser.allow_outgoing_connections is a boolean

Default value

true

Description

Configure the Neo4j Browser to time out logged in users after this idle period. Setting this to 0 indicates no limit.

Valid values

browser.credential_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

0

Description

Whitelist of hosts for the Neo4j Browser to be allowed to fetch content from.

Valid values

browser.remote_content_hostname_whitelist is a string

Default value

http://guides.neo4j.com,https://guides.neo4j.com,http://localhost,https://localhost

Description

Configure the Neo4j Browser to store or not store user credentials.

Valid values

browser.retain_connection_credentials is a boolean

Default value

true

Description

Set this to specify the default parser (language version).

Valid values

cypher.default_language_version is one of 2.3, 3.0, default

Default value

default

Description

This setting is associated with performance optimization. Set this to true in situations where it is preferable to have any queries using the 'shortestPath' function terminate as soon as possible with no answer, rather than potentially running for a long time attempting to find an answer (even if there is no path to be found). For most queries, the 'shortestPath' algorithm will return the correct answer very quickly. However there are some cases where it is possible that the fast bidirectional breadth-first search algorithm will find no results even if they exist. This can happen when the predicates in the WHERE clause applied to 'shortestPath' cannot be applied to each step of the traversal, and can only be applied to the entire path. When the query planner detects these special cases, it will plan to perform an exhaustive depth-first search if the fast algorithm finds no paths. However, the exhaustive search may be orders of magnitude slower than the fast algorithm. If it is critical that queries terminate as soon as possible, it is recommended that this option be set to true, which means that Neo4j will never consider using the exhaustive search for shortestPath queries. However, please note that if no paths are found, an error will be thrown at run time, which will need to be handled by the application.

Valid values

cypher.forbid_exhaustive_shortestpath is a boolean

Default value

false

Description

This setting is associated with performance optimization. The shortest path algorithm does not work when the start and end nodes are the same. With this setting set to false no path will be returned when that happens. The default value of true will instead throw an exception. This can happen if you perform a shortestPath search after a cartesian product that might have the same start and end nodes for some of the rows passed to shortestPath. If it is preferable to not experience this exception, and acceptable for results to be missing for those rows, then set this to false. If you cannot accept missing results, and really want the shortestPath between two common nodes, then re-write the query using a standard Cypher variable length pattern expression followed by ordering by path length and limiting to one result.

Valid values

cypher.forbid_shortestpath_common_nodes is a boolean

Default value

true

Description

Set this to specify the behavior when Cypher planner or runtime hints cannot be fulfilled. If true, then non-conformance will result in an error, otherwise only a warning is generated.

Valid values

cypher.hints_error is a boolean

Default value

false

Description

The minimum lifetime of a query plan before a query is considered for replanning.

Valid values

cypher.min_replan_interval is a duration (valid units are ms, s, m; default unit is s)

Default value

10

Description

Set this to specify the default planner for the default language version.

Valid values

cypher.planner is one of COST, RULE, default

Default value

default

Description

The threshold when a plan is considered stale. If any of the underlying statistics used to create the plan has changed more than this value, the plan is considered stale and will be replanned. A value of 0 means always replan, and 1 means never replan.

Valid values

cypher.statistics_divergence_threshold is a double which is minimum 0.0, and is maximum 1.0

Default value

0.75

Description

Name of the database to load.

Valid values

dbms.active_database is a string

Default value

graph.db

Description

Whether to allow a store upgrade in case the current version of the database starts against an older store version. Setting this to true does not guarantee successful upgrade, it just allows an upgrade to be performed.

Valid values

dbms.allow_format_migration is a boolean

Default value

false

Description

Listening server for online backups.

Valid values

dbms.backup.address is a hostname and port

Default value

127.0.0.1:6362-6372

Description

Enable support for running online backups.

Valid values

dbms.backup.enabled is a boolean

Default value

true

Description

Configures the time interval between check-points. The database will not check-point more often than this (unless check pointing is triggered by a different event), but might check-point less often than this interval, if performing a check-point takes longer time than the configured interval. A check-point is a point in the transaction logs, from which recovery would start from. Longer check-point intervals typically means that recovery will take longer to complete in case of a crash. On the other hand, a longer check-point interval can also reduce the I/O load that the database places on the system, as each check-point implies a flushing and forcing of all the store files.

Valid values

dbms.checkpoint.interval.time is a duration (valid units are ms, s, m; default unit is s)

Default value

300

Description

Configures the transaction interval between check-points. The database will not check-point more often than this (unless check pointing is triggered by a different event), but might check-point less often than this interval, if performing a check-point takes longer time than the configured interval. A check-point is a point in the transaction logs, from which recovery would start from. Longer check-point intervals typically means that recovery will take longer to complete in case of a crash. On the other hand, a longer check-point interval can also reduce the I/O load that the database places on the system, as each check-point implies a flushing and forcing of all the store files. The default is '100000' for a check-point every 100000 transactions.

Valid values

dbms.checkpoint.interval.tx is an integer which is minimum 1

Default value

100000

Description

Limit the number of IOs the background checkpoint process will consume per second. This setting is advisory, is ignored in Neo4j Community Edition, and is followed to best effort in Enterprise Edition. An IO is in this case a 8 KiB (mostly sequential) write. Limiting the write IO in this way will leave more bandwidth in the IO subsystem to service random-read IOs, which is important for the response time of queries when the database cannot fit entirely in memory. The only drawback of this setting is that longer checkpoint times may lead to slightly longer recovery times in case of a database or system crash. A lower number means lower IO pressure, and consequently longer checkpoint times. The configuration can also be commented out to remove the limitation entirely, and let the checkpointer flush data as fast as the hardware will go. Set this to -1 to disable the IOPS limit.

Valid values

dbms.checkpoint.iops.limit is an integer

Default value

1000

Description

Directory for storing certificates to be used by Neo4j for TLS connections.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Default value

certificates

Description

Path of the data directory. You must not configure more than one Neo4j installation to use the same data directory.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Default value

data

Description

Sets the root directory for file URLs used with the Cypher LOAD CSV clause. This must be set to a single directory, restricting access to only those files within that directory and its subdirectories.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Description

Path of the lib directory.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Default value

lib

Description

Path of the logs directory.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Default value

logs

Description

The target location of the CSV files: a path to a directory wherein a CSV file per reported field will be written.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Default value

metrics

Description

Location of the database plugin directory. Compiled Java JAR files that contain database procedures will be loaded if they are placed in this directory.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Default value

plugins

Description

Path of the run directory. This directory holds Neo4j’s runtime state, such as a pidfile when it is running in the background. The pidfile is created when starting neo4j and removed when stopping it. It may be placed on an in-memory filesystem such as tmpfs.

Valid values

A filesystem path; relative paths are resolved against the installation root, <neo4j-home>

Default value

run

Description

Selects whether to conform to the standard https://tools.ietf.org/html/rfc4180 for interpreting escaped quotation characters in CSV files loaded using LOAD CSV. Setting this to false will use the standard, interpreting repeated quotes '""' as a single in-lined quote, while true will use the legacy convention originally supported in Neo4j 3.0 and 3.1, allowing a backslash to include quotes in-lined in fields.

Valid values

dbms.import.csv.legacy_quote_escaping is a boolean

Default value

true

Description

Enable or disable background index sampling.

Valid values

dbms.index_sampling.background_enabled is a boolean

Default value

true

Description

Size of buffer used by index sampling. This configuration setting is no longer applicable as from Neo4j 3.0.3. Please use dbms.index_sampling.sample_size_limit instead.

Valid values

dbms.index_sampling.buffer_size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 1048576, and is maximum 2147483647

Default value

67108864

Deprecated

The dbms.index_sampling.buffer_size configuration setting has been deprecated.

Description

Index sampling chunk size limit.

Valid values

dbms.index_sampling.sample_size_limit is an integer which is minimum 1048576, and is maximum 2147483647

Default value

8388608

Description

Percentage of index updates of total index size required before sampling of a given index is triggered.

Valid values

dbms.index_sampling.update_percentage is an integer which is minimum 0

Default value

5

Description

The maximum number of open Lucene index searchers.

Valid values

dbms.index_searcher_cache_size is an integer which is minimum 1

Default value

2147483647

Description

Debug log level threshold.

Valid values

dbms.logs.debug.level is one of DEBUG, INFO, WARN, ERROR, NONE

Default value

INFO

Description

Minimum time interval after last rotation of the debug log before it may be rotated again.

Valid values

dbms.logs.debug.rotation.delay is a duration (valid units are ms, s, m; default unit is s)

Default value

300

Description

Maximum number of history files for the debug log.

Valid values

dbms.logs.debug.rotation.keep_number is an integer which is minimum 1

Default value

7

Description

Threshold for rotation of the debug log.

Valid values

dbms.logs.debug.rotation.size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 0, and is maximum 9223372036854775807

Default value

20971520

Description

Enable GC Logging.

Valid values

dbms.logs.gc.enabled is a boolean

Default value

false

Description

GC Logging Options.

Valid values

dbms.logs.gc.options is a string

Default value

-XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintGCApplicationStoppedTime -XX:+PrintPromotionFailure -XX:+PrintTenuringDistribution

Description

Number of GC logs to keep.

Valid values

dbms.logs.gc.rotation.keep_number is an integer

Default value

5

Description

Size of each GC log that is kept.

Valid values

dbms.logs.gc.rotation.size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 0, and is maximum 9223372036854775807

Default value

20971520

Description

Enable HTTP request logging.

Valid values

dbms.logs.http.enabled is a boolean

Default value

false

Description

Number of HTTP logs to keep.

Valid values

dbms.logs.http.rotation.keep_number is an integer

Default value

5

Description

Size of each HTTP log that is kept.

Valid values

dbms.logs.http.rotation.size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 0, and is maximum 9223372036854775807

Default value

20971520

Description

Log executed queries that take longer than the configured threshold, dbms.logs.query.threshold. Log entries are written to the file query.log located in the Logs directory. For location of the Logs directory, see Section 2.2, “File locations”. This feature is available in the Neo4j Enterprise Edition.

Valid values

dbms.logs.query.enabled is a boolean

Default value

false

Description

Log parameters for executed queries that took longer than the configured threshold.

Valid values

dbms.logs.query.parameter_logging_enabled is a boolean

Default value

true

Description

Maximum number of history files for the query log.

Valid values

dbms.logs.query.rotation.keep_number is an integer which is minimum 1

Default value

7

Description

The file size in bytes at which the query log will auto-rotate. If set to zero then no rotation will occur. Accepts a binary suffix k, m or g.

Valid values

dbms.logs.query.rotation.size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 0, and is maximum 9223372036854775807

Default value

20971520

Description

If the execution of query takes more time than this threshold, the query is logged - provided query logging is enabled. Defaults to 0 seconds, that is all queries are logged.

Valid values

dbms.logs.query.threshold is a duration (valid units are ms, s, m; default unit is s)

Default value

0

Description

The amount of memory to use for mapping the store files, in bytes (or kilobytes with the 'k' suffix, megabytes with 'm' and gigabytes with 'g'). If Neo4j is running on a dedicated server, then it is generally recommended to leave about 2-4 gigabytes for the operating system, give the JVM enough heap to hold all your transaction state and query context, and then leave the rest for the page cache. The default page cache memory assumes the machine is dedicated to running Neo4j, and is heuristically set to 50% of RAM minus the max Java heap size.

Valid values

dbms.memory.pagecache.size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 245760

Default value

3134945280

Description

Specify which page swapper to use for doing paged IO. This is only used when integrating with proprietary storage technology.

Valid values

dbms.memory.pagecache.swapper is a string

Description

Configure the operating mode of the database — 'SINGLE' for stand-alone operation, 'HA' for operating as a member in a cluster or 'ARBITER' for an HA-only cluster member with no database.

Valid values

dbms.mode is a string

Default value

SINGLE

Description

The number of Cypher query execution plans that are cached.

Valid values

dbms.query_cache_size is an integer which is minimum 0

Default value

1000

Description

Only allow read operations from this Neo4j instance. This mode still requires write access to the directory for lock purposes.

Valid values

dbms.read_only is a boolean

Default value

false

Description

Database record format. Enterprise edition only. Valid values: standard, high_limit. Default value: standard.

Valid values

dbms.record_format is a string

Default value

Description

Relationship count threshold for considering a node to be dense.

Valid values

dbms.relationship_grouping_threshold is an integer which is minimum 1

Default value

50

Description

Determines if Cypher will allow using file URLs when loading data using LOAD CSV. Setting this value to false will cause Neo4j to fail LOAD CSV clauses that load data from the file system.

Valid values

dbms.security.allow_csv_import_from_file_urls is a boolean

Default value

true

Description

Enable auth requirement to access Neo4j.

Valid values

dbms.security.auth_enabled is a boolean

Default value

false

Description

Require authorization for access to the HA status endpoints.

Valid values

dbms.security.ha_status_auth_enabled is a boolean

Default value

true

Description

Comma-seperated list of custom security rules for Neo4j to use.

Valid values

dbms.security.http_authorization_classes is a list separated by "," where items are a string

Default value

[]

Description

Enable a remote shell server which Neo4j Shell clients can log in to.

Valid values

dbms.shell.enabled is a boolean

Default value

false

Description

Remote host for shell. By default, the shell server listens only on the loopback interface, but you can specify the IP address of any network interface or use 0.0.0.0 for all interfaces.

Valid values

dbms.shell.host is a string which must be a valid name

Default value

127.0.0.1

Description

The port the shell will listen on.

Valid values

dbms.shell.port is an integer which must be a valid port number (is in the range 0 to 65535)

Default value

1337

Description

Read only mode. Will only allow read operations.

Valid values

dbms.shell.read_only is a boolean

Default value

false

Description

The name of the shell.

Valid values

dbms.shell.rmi_name is a string which must be a valid name

Default value

shell

Description

Number of Neo4j worker threads, your OS might enforce a lower limit than the maximum value specified here.

Valid values

dbms.threads.worker_count is an integer which is in the range 1 to 44738

Default value

The minimum between "number of processors" and 500

Description

The maximum time interval of a transaction within which it should be completed.

Valid values

dbms.transaction.timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

60

Description

Timeout for idle transactions in the REST endpoint.

Valid values

dbms.transaction_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

60

Description

Make Neo4j keep the logical transaction logs for being able to backup the database. Can be used for specifying the threshold to prune logical logs after. For example "10 days" will prune logical logs that only contains transactions older than 10 days from the current time, or "100k txs" will keep the 100k latest transactions and prune any older transactions.

Valid values

dbms.tx_log.rotation.retention_policy is a string which must be true/false or of format '<number><optional unit> <type>' for example 100M size for limiting logical log space on disk to 100Mb, or 200k txs for limiting the number of transactions to keep to 200 000

Default value

7 days

Description

Specifies at which file size the logical log will auto-rotate. 0 means that no rotation will automatically occur based on file size.

Valid values

dbms.tx_log.rotation.size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 1048576

Default value

262144000

Description

Enable the UDC extension.

Valid values

dbms.udc.enabled is a boolean

Default value

true

Description

Comma-separated list of <classname>=<mount point> for unmanaged extensions.

Valid values

dbms.unmanaged_extension_classes is a comma-seperated list of <classname>=<mount point> strings

Default value

[]

Description

Whether to allow this instance to create a cluster if unable to join.

Valid values

ha.allow_init_cluster is a boolean

Default value

true

Description

Strategy for how to order handling of branched data on slaves and copying of the store from the master. The default is branch_then_copy, which, when combined with the keep_last or keep_none branch handling strategies results in less space used during the store copy.

Valid values

ha.branched_data_copying_strategy is one of branch_then_copy, copy_then_branch

Default value

branch_then_copy

Description

Policy for how to handle branched data.

Valid values

ha.branched_data_policy is one of keep_all, keep_last, keep_none

Default value

keep_all

Description

Timeout for broadcasting values in cluster. Must consider end-to-end duration of Paxos algorithm. This value is the default value for the ha.join_timeout and ha.leave_timeout settings.

Valid values

ha.broadcast_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

30

Description

Timeout for waiting for configuration from an existing cluster member during cluster join.

Valid values

ha.configuration_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

1

Description

Max size of the data chunks that flows between master and slaves in HA. Bigger size may increase throughput, but may also be more sensitive to variations in bandwidth, whereas lower size increases tolerance for bandwidth variations.

Valid values

ha.data_chunk_size is a byte size (valid multipliers are k, m, g, K, M, G) which is minimum 1024

Default value

2097152

Description

Default timeout used for clustering timeouts. Override specific timeout settings with proper values if necessary. This value is the default value for the ha.heartbeat_interval, ha.paxos_timeout and ha.learn_timeout settings.

Valid values

ha.default_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

5

Description

Timeout for waiting for other members to finish a role election. Defaults to ha.paxos_timeout.

Valid values

ha.election_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

5

Description

How often heartbeat messages should be sent. Defaults to ha.default_timeout.

Valid values

ha.heartbeat_interval is a duration (valid units are ms, s, m; default unit is s)

Default value

5

Description

How long to wait for heartbeats from other instances before marking them as suspects for failure. This value reflects considerations of network latency, expected duration of garbage collection pauses and other factors that can delay message sending and processing. Larger values will result in more stable masters but also will result in longer waits before a failover in case of master failure. This value should not be set to less than twice the ha.heartbeat_interval value otherwise there is a high risk of frequent master switches and possibly branched data occurrence.

Valid values

ha.heartbeat_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

40

Description

Host and port to bind the cluster management communication.

Valid values

ha.host.coordination is a hostname and port

Default value

0.0.0.0:5001-5099

Description

Hostname and port to bind the HA server.

Valid values

ha.host.data is a hostname and port

Default value

0.0.0.0:6001-6011

Description

A comma-separated list of other members of the cluster to join.

Valid values

ha.initial_hosts is a list separated by "," where items are a hostname and port

Mandatory

The ha.initial_hosts configuration setting is mandatory.

Description

Timeout for waiting for internal conditions during state switch, like for transactions to complete, before switching to master or slave.

Valid values

ha.internal_role_switch_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

10

Description

Timeout for joining a cluster. Defaults to ha.broadcast_timeout.

Valid values

ha.join_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

30

Description

Timeout for learning values. Defaults to ha.default_timeout.

Valid values

ha.learn_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

5

Description

Timeout for waiting for cluster leave to finish. Defaults to ha.broadcast_timeout.

Valid values

ha.leave_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

30

Description

Maximum number of servers to involve when agreeing to membership changes. In very large clusters, the probability of half the cluster failing is low, but protecting against any arbitrary half failing is expensive. Therefore you may wish to set this parameter to a value less than the cluster size.

Valid values

ha.max_acceptors is an integer which is minimum 1

Default value

21

Description

Maximum number of connections a slave can have to the master.

Valid values

ha.max_channels_per_slave is an integer which is minimum 1

Default value

20

Description

Default value for all Paxos timeouts. This setting controls the default value for the ha.phase1_timeout, ha.phase2_timeout and ha.election_timeout settings. If it is not given a value it defaults to ha.default_timeout and will implicitly change if ha.default_timeout changes. This is an advanced parameter which should only be changed if specifically advised by Neo4j Professional Services.

Valid values

ha.paxos_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

5

Description

Timeout for Paxos phase 1. If it is not given a value it defaults to ha.paxos_timeout and will implicitly change if ha.paxos_timeout changes. This is an advanced parameter which should only be changed if specifically advised by Neo4j Professional Services.

Valid values

ha.phase1_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

5

Description

Timeout for Paxos phase 2. If it is not given a value it defaults to ha.paxos_timeout and will implicitly change if ha.paxos_timeout changes. This is an advanced parameter which should only be changed if specifically advised by Neo4j Professional Services.

Valid values

ha.phase2_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

5

Description

Size of batches of transactions applied on slaves when pulling from master.

Valid values

ha.pull_batch_size is an integer

Default value

100

Description

Interval of pulling updates from master.

Valid values

ha.pull_interval is a duration (valid units are ms, s, m; default unit is s)

Default value

0

Description

Timeout for request threads waiting for instance to become master or slave.

Valid values

ha.role_switch_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

120

Description

Id for a cluster instance. Must be unique within the cluster.

Valid values

ha.server_id is an instance id, which has to be a valid integer

Mandatory

The ha.server_id configuration setting is mandatory.

Description

Timeout for taking remote (write) locks on slaves. Defaults to ha.slave_read_timeout.

Valid values

ha.slave_lock_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

20

Description

Whether this instance should only participate as slave in cluster. If set to true, it will never be elected as master.

Valid values

ha.slave_only is a boolean

Default value

false

Description

How long a slave will wait for response from master before giving up.

Valid values

ha.slave_read_timeout is a duration (valid units are ms, s, m; default unit is s)

Default value

20

Description

The amount of slaves the master will ask to replicate a committed transaction.

Valid values

ha.tx_push_factor is an integer which is minimum 0

Default value

1

Description

Push strategy of a transaction to a slave during commit.

Valid values

ha.tx_push_strategy is one of round_robin, fixed_descending, fixed_ascending

Default value

fixed_ascending

Description

Enable reporting metrics about Bolt Protocol message processing.

Valid values

metrics.bolt.messages.enabled is a boolean

Default value

false

Description

Set to true to enable exporting metrics to CSV files.

Valid values

metrics.csv.enabled is a boolean

Default value

false

Description

The reporting interval for the CSV files. That is, how often new rows with numbers are appended to the CSV files.

Valid values

metrics.csv.interval is a duration (valid units are ms, s, m; default unit is s)

Default value

3

Description

Enable reporting metrics about number of occurred replanning events.

Valid values

metrics.cypher.replanning.enabled is a boolean

Default value

false

Description

The default enablement value for all the supported metrics. Set this to false to turn off all metrics by default. The individual settings can then be used to selectively re-enable specific metrics.

Valid values

metrics.enabled is a boolean

Default value

false

Description

Set to true to enable exporting metrics to Graphite.

Valid values

metrics.graphite.enabled is a boolean

Default value

false

Description

The reporting interval for Graphite. That is, how often to send updated metrics to Graphite.

Valid values

metrics.graphite.interval is a duration (valid units are ms, s, m; default unit is s)

Default value

3

Description

The hostname or IP address of the Graphite server.

Valid values

metrics.graphite.server is a hostname and port

Default value

:2003

Description

Enable reporting metrics about the buffer pools.

Valid values

metrics.jvm.buffers.enabled is a boolean

Default value

false

Description

Enable reporting metrics about the duration of garbage collections.

Valid values

metrics.jvm.gc.enabled is a boolean

Default value

false

Description

Enable reporting metrics about the memory usage.

Valid values

metrics.jvm.memory.enabled is a boolean

Default value

false

Description

Enable reporting metrics about the current number of threads running.

Valid values

metrics.jvm.threads.enabled is a boolean

Default value

false

Description

Enable reporting metrics about Neo4j check pointing; when it occurs and how much time it takes to complete.

Valid values

metrics.neo4j.checkpointing.enabled is a boolean

Default value

false

Description

Enable reporting metrics about HA cluster info.

Valid values

metrics.neo4j.cluster.enabled is a boolean

Default value

false

Description

Enable reporting metrics about approximately how many entities are in the database; nodes, relationships, properties, etc.

Valid values

metrics.neo4j.counts.enabled is a boolean

Default value

false

Description

The default enablement value for all Neo4j specific support metrics. Set this to false to turn off all Neo4j specific metrics by default. The individual metrics.neo4j.* metrics can then be turned on selectively.

Valid values

metrics.neo4j.enabled is a boolean

Default value

false

Description

Enable reporting metrics about the Neo4j log rotation; when it occurs and how much time it takes to complete.

Valid values

metrics.neo4j.logrotation.enabled is a boolean

Default value

false

Description

Enable reporting metrics about the network usage.

Valid values

metrics.neo4j.network.enabled is a boolean

Default value

false

Description

Enable reporting metrics about the Neo4j page cache; page faults, evictions, flushes, exceptions, etc.

Valid values

metrics.neo4j.pagecache.enabled is a boolean

Default value

false

Description

Enable reporting metrics about Server threading info.

Valid values

metrics.neo4j.server.enabled is a boolean

Default value

false

Description

Enable reporting metrics about transactions; number of transactions started, committed, etc.

Valid values

metrics.neo4j.tx.enabled is a boolean

Default value

false

Description

A common prefix for the reported metrics field names. By default, this is either be 'neo4j', or a computed value based on the cluster and instance names, when running in an HA configuration.

Valid values

metrics.prefix is a string

Default value

neo4j

Description

Perform checks between nodes, relationships, properties, types and tokens.

Valid values

tools.consistency_checker.check_graph is a boolean

Default value

true

Description

Perform checks on indexes. Checking indexes is more expensive than checking the native stores, so it may be useful to turn off this check for very large databases.

Valid values

tools.consistency_checker.check_indexes is a boolean

Default value

true

Description

Perform checks on the label scan store. Checking this store is more expensive than checking the native stores, so it may be useful to turn off this check for very large databases.

Valid values

tools.consistency_checker.check_label_scan_store is a boolean

Default value

true

Description

Perform optional additional checking on property ownership. This can detect a theoretical inconsistency where a property could be owned by multiple entities. However, the check is very expensive in time and memory, so it is skipped by default.

Valid values

tools.consistency_checker.check_property_owners is a boolean

Default value

false