A.1. Configuration settings

This section contains a complete reference of Neo4j configuration settings. They can be set in neo4j.conf.

Table A.1. Settings reference
Name Description

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.post_connect_cmd

Commands to be run when Neo4j Browser successfully connects to this server.

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.

causal_clustering.array_block_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of ARRAY_BLOCK IDs.

causal_clustering.catchup_batch_size

The maximum batch size when catching up (in unit of entries).

causal_clustering.cluster_allow_reads_on_followers

Configure if the dbms.cluster.routing.getServers() procedure should include followers as read endpoints or return only read replicas.

causal_clustering.cluster_routing_ttl

How long drivers should cache the data from the dbms.cluster.routing.getServers() procedure.

causal_clustering.cluster_topology_refresh

Time between scanning the cluster to refresh current server’s view of topology.

causal_clustering.disable_middleware_logging

Prevents the network middleware from dumping its own logs.

causal_clustering.discovery_advertised_address

Advertised cluster member discovery management communication.

causal_clustering.discovery_listen_address

Host and port to bind the cluster member discovery management communication.

causal_clustering.expected_core_cluster_size

Expected number of Core machines in the cluster.

causal_clustering.global_session_tracker_state_size

The maximum file size before the global session tracker state file is rotated (in unit of entries).

causal_clustering.id_alloc_state_size

The maximum file size before the ID allocation file is rotated (in unit of entries).

causal_clustering.initial_discovery_members

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

causal_clustering.join_catch_up_timeout

Time out for a new member to catch up.

causal_clustering.label_token_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of LABEL_TOKEN IDs.

causal_clustering.label_token_name_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of LABEL_TOKEN_NAME IDs.

causal_clustering.last_applied_state_size

The maximum file size before the storage file is rotated (in unit of entries).

causal_clustering.leader_election_timeout

The time limit within which a new leader election will occur if no messages are received.

causal_clustering.load_balancing.config

The configuration must be valid for the configured plugin and usually existsunder matching subkeys, e.g.

causal_clustering.load_balancing.plugin

The load balancing plugin to use.

causal_clustering.load_balancing.shuffle

Enables shuffling of the returned load balancing result.

causal_clustering.log_shipping_max_lag

The maximum lag allowed before log shipping pauses (in unit of entries).

causal_clustering.multi_dc_license

Enable multi-data center features.

causal_clustering.neostore_block_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of NEOSTORE_BLOCK IDs.

causal_clustering.node_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of NODE IDs.

causal_clustering.node_labels_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of NODE_LABELS IDs.

causal_clustering.outgoing_queue_size

The number of messages waiting to be sent to other servers in the cluster.

causal_clustering.property_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of PROPERTY IDs.

causal_clustering.property_key_token_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of PROPERTY_KEY_TOKEN IDs.

causal_clustering.property_key_token_name_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of PROPERTY_KEY_TOKEN_NAME IDs.

causal_clustering.pull_interval

Interval of pulling updates from cores.

causal_clustering.raft_advertised_address

Advertised hostname/IP address and port for the RAFT server.

causal_clustering.raft_listen_address

Network interface and port for the RAFT server to listen on.

causal_clustering.raft_log_implementation

RAFT log implementation.

causal_clustering.raft_log_prune_strategy

RAFT log pruning strategy.

causal_clustering.raft_log_pruning_frequency

RAFT log pruning frequency.

causal_clustering.raft_log_reader_pool_size

RAFT log reader pool size.

causal_clustering.raft_log_rotation_size

RAFT log rotation size.

causal_clustering.raft_membership_state_size

The maximum file size before the membership state file is rotated (in unit of entries).

causal_clustering.raft_messages_log_enable

Enable or disable the dump of all network messages pertaining to the RAFT protocol.

causal_clustering.raft_term_state_size

The maximum file size before the term state file is rotated (in unit of entries).

causal_clustering.raft_vote_state_size

The maximum file size before the vote state file is rotated (in unit of entries).

causal_clustering.read_replica_time_to_live

Time To Live before read replica is considered unavailable.

causal_clustering.refuse_to_be_leader

Prevents the current instance from volunteering to become Raft leader.

causal_clustering.relationship_group_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP_GROUP IDs.

causal_clustering.relationship_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP IDs.

causal_clustering.relationship_type_token_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP_TYPE_TOKEN IDs.

causal_clustering.relationship_type_token_name_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP_TYPE_TOKEN_NAME IDs.

causal_clustering.replicated_lock_token_state_size

The maximum file size before the replicated lock token state file is rotated (in unit of entries).

causal_clustering.schema_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of SCHEMA IDs.

causal_clustering.server_groups

A list of group names for the server used when configuring load balancing and replication policies.

causal_clustering.state_machine_apply_max_batch_size

The maximum number of operations to be batched during applications of operations in the state machines.

causal_clustering.state_machine_flush_window_size

The number of operations to be processed before the state machines flush to disk.

causal_clustering.string_block_id_allocation_size

The size of the ID allocation requests Core servers will make when they run out of STRING_BLOCK IDs.

causal_clustering.transaction_advertised_address

Advertised hostname/IP address and port for the transaction shipping server.

causal_clustering.transaction_listen_address

Network interface and port for the transaction shipping server to listen on.

causal_clustering.unknown_address_logging_throttle

Throttle limit for logging unknown cluster member address.

causal_clustering.upstream_selection_strategy

An ordered list in descending preference of the strategy which read replicas use to choose upstream database server from which to pull transactional updates.

causal_clustering.user_defined_upstream_strategy

If the operator specifies the user-defined upstream database selection strategy in causal_clustering.upstream_selection_strategy then the configuration of the upstream dependencies is written here.

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.config.strict_validation

A strict configuration validation will prevent the database from starting up if unknown configuration options are specified in the neo4j settings namespace (such as dbms., ha., cypher., etc).

dbms.connector.bolt.enabled

Enable this connector.

dbms.connector.bolt.type

Connector type.

dbms.connector.http.enabled

Enable this connector.

dbms.connector.http.type

Connector type.

dbms.connector.https.enabled

Enable this connector.

dbms.connector.https.type

Connector type.

dbms.connectors.default_advertised_address

Default hostname or IP address the server uses to advertise itself to its connectors.

dbms.connectors.default_listen_address

Default network interface to listen for incoming connections.

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.ids.reuse.types.override

Specified names of id types (comma separated) that should be reused.

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.buffer_size

Size of buffer used by 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.jvm.additional

Additional JVM arguments.

dbms.lock.acquisition.timeout

The maximum time interval within which lock should be acquired.

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.allocation_logging_enabled

Log allocated bytes for the executed queries being logged.

dbms.logs.query.enabled

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

dbms.logs.query.page_logging_enabled

Log page hits and page faults for the executed queries being logged.

dbms.logs.query.parameter_logging_enabled

Log parameters for the executed queries being logged.

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.logs.query.time_logging_enabled

Log detailed time information for the executed queries being logged.

dbms.logs.security.level

Security log level threshold.

dbms.logs.security.rotation.delay

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

dbms.logs.security.rotation.keep_number

Maximum number of history files for the security log.

dbms.logs.security.rotation.size

Threshold for rotation of the security log.

dbms.memory.heap.initial_size

Initial heap size.

dbms.memory.heap.max_size

Maximum heap size.

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 an HA cluster, 'ARBITER' for a cluster member with no database in an HA cluster, 'CORE' for operating as a core member of a Causal Cluster, or 'READ_REPLICA' for operating as a read replica member of a Causal Cluster.

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.rest.transaction.idle_timeout

Timeout for idle transactions in the REST endpoint.

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_cache_max_capacity

The maximum capacity for authentication and authorization caches (respectively).

dbms.security.auth_cache_ttl

The time to live (TTL) for cached authentication and authorization info when using external auth providers (LDAP or plugin).

dbms.security.auth_enabled

Enable auth requirement to access Neo4j.

dbms.security.auth_provider

The authentication and authorization provider that contains both the users and roles.

dbms.security.causal_clustering_status_auth_enabled

Require authorization for access to the Causal Clustering status endpoints.

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.security.ldap.authentication.cache_enabled

Determines if the result of authentication via the LDAP server should be cached or not.

dbms.security.ldap.authentication.mechanism

LDAP authentication mechanism.

dbms.security.ldap.authentication.user_dn_template

LDAP user DN template.

dbms.security.ldap.authorization.group_membership_attributes

A list of attribute names on a user object that contains groups to be used for mapping to roles when LDAP authorization is enabled.

dbms.security.ldap.authorization.group_to_role_mapping

An authorization mapping from LDAP group names to Neo4j role names.

dbms.security.ldap.authorization.system_password

An LDAP system account password to use for authorization searches when dbms.security.ldap.authorization.use_system_account is true.

dbms.security.ldap.authorization.system_username

An LDAP system account username to use for authorization searches when dbms.security.ldap.authorization.use_system_account is true.

dbms.security.ldap.authorization.use_system_account

Perform LDAP search for authorization info using a system account instead of the user’s own account.

If this is set to false (default), the search for group membership will be performed directly after authentication using the LDAP context bound with the user’s own account.

dbms.security.ldap.authorization.user_search_base

The name of the base object or named context to search for user objects when LDAP authorization is enabled.

dbms.security.ldap.authorization.user_search_filter

The LDAP search filter to search for a user principal when LDAP authorization is enabled.

dbms.security.ldap.connection_timeout

The timeout for establishing an LDAP connection.

dbms.security.ldap.host

URL of LDAP server to use for authentication and authorization.

dbms.security.ldap.read_timeout

The timeout for an LDAP read request (i.e.

dbms.security.ldap.referral

The LDAP referral behavior when creating a connection.

dbms.security.ldap.use_starttls

Use secure communication with the LDAP server using opportunistic TLS.

dbms.security.log_successful_authentication

Set to log successful authentication events to the security log.

dbms.security.procedures.default_allowed

The default role that can execute all procedures and user-defined functions that are not covered by the dbms.security.procedures.roles setting.

dbms.security.procedures.roles

This provides a finer level of control over which roles can execute procedures than the dbms.security.procedures.default_allowed setting.

dbms.security.procedures.unrestricted

A list of procedures and user defined functions (comma separated) that are allowed full access to the database.

dbms.security.procedures.whitelist

A list of procedures (comma separated) that are to be loaded.

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.shutdown_transaction_end_timeout

The maximum amount of time to wait for running transactions to complete before allowing initiated database shutdown to continue.

dbms.threads.worker_count

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

dbms.transaction.bookmark_ready_timeout

The maximum amount of time to wait for the database state represented by the bookmark.

dbms.transaction.timeout

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

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.

dbms.windows_service_name

Name of the Windows Service.

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.causal_clustering.enabled

Enable reporting metrics about Causal Clustering mode.

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

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead.

tools.consistency_checker.check_indexes

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead.

tools.consistency_checker.check_label_scan_store

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead.

tools.consistency_checker.check_property_owners

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead.

Table A.2. browser.allow_outgoing_connections

Description

Configure the policy for outgoing Neo4j Browser connections.

Valid values

browser.allow_outgoing_connections is a boolean

Default value

true

Table A.3. browser.credential_timeout

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

PT0S

Table A.4. browser.post_connect_cmd

Description

Commands to be run when Neo4j Browser successfully connects to this server. Separate multiple commands with semi-colon.

Valid values

browser.post_connect_cmd is a string

Default value

 
Table A.5. browser.remote_content_hostname_whitelist

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

Table A.6. browser.retain_connection_credentials

Description

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

Valid values

browser.retain_connection_credentials is a boolean

Default value

true

Table A.7. causal_clustering.array_block_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of ARRAY_BLOCK IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.array_block_id_allocation_size is an integer

Default value

1024

Table A.8. causal_clustering.catchup_batch_size

Description

The maximum batch size when catching up (in unit of entries).

Valid values

causal_clustering.catchup_batch_size is an integer

Default value

64

Table A.9. causal_clustering.cluster_allow_reads_on_followers

Description

Configure if the dbms.cluster.routing.getServers() procedure should include followers as read endpoints or return only read replicas. Note: if there are no read replicas in the cluster, followers are returned as read end points regardless the value of this setting. Defaults to true so that followersare available for read-only queries in a typical heterogeneous setup.

Valid values

causal_clustering.cluster_allow_reads_on_followers is a boolean

Default value

true

Table A.10. causal_clustering.cluster_routing_ttl

Description

How long drivers should cache the data from the dbms.cluster.routing.getServers() procedure.

Valid values

causal_clustering.cluster_routing_ttl is a duration (valid units are ms, s, m; default unit is s) which is minimum PT1S

Default value

PT5M

Table A.11. causal_clustering.cluster_topology_refresh

Description

Time between scanning the cluster to refresh current server’s view of topology.

Valid values

causal_clustering.cluster_topology_refresh is a duration (valid units are ms, s, m; default unit is s) which is minimum PT1S

Default value

PT5S

Table A.12. causal_clustering.disable_middleware_logging

Description

Prevents the network middleware from dumping its own logs. Defaults to true.

Valid values

causal_clustering.disable_middleware_logging is a boolean

Default value

true

Table A.13. causal_clustering.discovery_advertised_address

Description

Advertised cluster member discovery management communication.

Valid values

an advertised socket address

Default value

localhost:5000

Table A.14. causal_clustering.discovery_listen_address

Description

Host and port to bind the cluster member discovery management communication.

Valid values

a listen socket address

Default value

127.0.0.1:5000

Table A.15. causal_clustering.expected_core_cluster_size

Description

Expected number of Core machines in the cluster.

Valid values

causal_clustering.expected_core_cluster_size is an integer

Default value

3

Table A.16. causal_clustering.global_session_tracker_state_size

Description

The maximum file size before the global session tracker state file is rotated (in unit of entries).

Valid values

causal_clustering.global_session_tracker_state_size is an integer

Default value

1000

Table A.17. causal_clustering.id_alloc_state_size

Description

The maximum file size before the ID allocation file is rotated (in unit of entries).

Valid values

causal_clustering.id_alloc_state_size is an integer

Default value

1000

Table A.18. causal_clustering.initial_discovery_members

Description

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

Valid values

causal_clustering.initial_discovery_members is a list separated by "," where items are an advertised socket address

Table A.19. causal_clustering.join_catch_up_timeout

Description

Time out for a new member to catch up.

Valid values

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

Default value

PT10M

Table A.20. causal_clustering.label_token_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of LABEL_TOKEN IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.label_token_id_allocation_size is an integer

Default value

32

Table A.21. causal_clustering.label_token_name_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of LABEL_TOKEN_NAME IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.label_token_name_id_allocation_size is an integer

Default value

1024

Table A.22. causal_clustering.last_applied_state_size

Description

The maximum file size before the storage file is rotated (in unit of entries).

Valid values

causal_clustering.last_applied_state_size is an integer

Default value

1000

Table A.23. causal_clustering.leader_election_timeout

Description

The time limit within which a new leader election will occur if no messages are received.

Valid values

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

Default value

PT7S

Table A.24. causal_clustering.load_balancing.config

Description

The configuration must be valid for the configured plugin and usually existsunder matching subkeys, e.g. ..config.server_policies.*This is just a top-level placeholder for the plugin-specific configuration.

Valid values

causal_clustering.load_balancing.config is a string

Default value

 
Table A.25. causal_clustering.load_balancing.plugin

Description

The load balancing plugin to use.

Valid values

causal_clustering.load_balancing.plugin is a string

Default value

server_policies

Table A.26. causal_clustering.load_balancing.shuffle

Description

Enables shuffling of the returned load balancing result.

Valid values

causal_clustering.load_balancing.shuffle is a boolean

Default value

true

Table A.27. causal_clustering.log_shipping_max_lag

Description

The maximum lag allowed before log shipping pauses (in unit of entries).

Valid values

causal_clustering.log_shipping_max_lag is an integer

Default value

256

Table A.28. causal_clustering.multi_dc_license

Description

Enable multi-data center features. Requires appropriate licensing.

Valid values

causal_clustering.multi_dc_license is a boolean

Default value

false

Table A.29. causal_clustering.neostore_block_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of NEOSTORE_BLOCK IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.neostore_block_id_allocation_size is an integer

Default value

1024

Table A.30. causal_clustering.node_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of NODE IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.node_id_allocation_size is an integer

Default value

1024

Table A.31. causal_clustering.node_labels_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of NODE_LABELS IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.node_labels_id_allocation_size is an integer

Default value

1024

Table A.32. causal_clustering.outgoing_queue_size

Description

The number of messages waiting to be sent to other servers in the cluster.

Valid values

causal_clustering.outgoing_queue_size is an integer

Default value

64

Table A.33. causal_clustering.property_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of PROPERTY IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.property_id_allocation_size is an integer

Default value

1024

Table A.34. causal_clustering.property_key_token_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of PROPERTY_KEY_TOKEN IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.property_key_token_id_allocation_size is an integer

Default value

32

Table A.35. causal_clustering.property_key_token_name_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of PROPERTY_KEY_TOKEN_NAME IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.property_key_token_name_id_allocation_size is an integer

Default value

1024

Table A.36. causal_clustering.pull_interval

Description

Interval of pulling updates from cores.

Valid values

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

Default value

PT1S

Table A.37. causal_clustering.raft_advertised_address

Description

Advertised hostname/IP address and port for the RAFT server.

Valid values

an advertised socket address

Default value

localhost:7000

Table A.38. causal_clustering.raft_listen_address

Description

Network interface and port for the RAFT server to listen on.

Valid values

a listen socket address

Default value

127.0.0.1:7000

Table A.39. causal_clustering.raft_log_implementation

Description

RAFT log implementation.

Valid values

causal_clustering.raft_log_implementation is a string

Default value

SEGMENTED

Table A.40. causal_clustering.raft_log_prune_strategy

Description

RAFT log pruning strategy.

Valid values

causal_clustering.raft_log_prune_strategy is a string

Default value

1g size

Table A.41. causal_clustering.raft_log_pruning_frequency

Description

RAFT log pruning frequency.

Valid values

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

Default value

PT10M

Table A.42. causal_clustering.raft_log_reader_pool_size

Description

RAFT log reader pool size.

Valid values

causal_clustering.raft_log_reader_pool_size is an integer

Default value

8

Table A.43. causal_clustering.raft_log_rotation_size

Description

RAFT log rotation size.

Valid values

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

Default value

262144000

Table A.44. causal_clustering.raft_membership_state_size

Description

The maximum file size before the membership state file is rotated (in unit of entries).

Valid values

causal_clustering.raft_membership_state_size is an integer

Default value

1000

Table A.45. causal_clustering.raft_messages_log_enable

Description

Enable or disable the dump of all network messages pertaining to the RAFT protocol.

Valid values

causal_clustering.raft_messages_log_enable is a boolean

Default value

false

Table A.46. causal_clustering.raft_term_state_size

Description

The maximum file size before the term state file is rotated (in unit of entries).

Valid values

causal_clustering.raft_term_state_size is an integer

Default value

1000

Table A.47. causal_clustering.raft_vote_state_size

Description

The maximum file size before the vote state file is rotated (in unit of entries).

Valid values

causal_clustering.raft_vote_state_size is an integer

Default value

1000

Table A.48. causal_clustering.read_replica_time_to_live

Description

Time To Live before read replica is considered unavailable.

Valid values

causal_clustering.read_replica_time_to_live is a duration (valid units are ms, s, m; default unit is s) which is minimum PT1M

Default value

PT1M

Table A.49. causal_clustering.refuse_to_be_leader

Description

Prevents the current instance from volunteering to become Raft leader. Defaults to false, and should only be used in exceptional circumstances by expert users. Using this can result in reduced availability for the cluster.

Valid values

causal_clustering.refuse_to_be_leader is a boolean

Default value

false

Table A.50. causal_clustering.relationship_group_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP_GROUP IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.relationship_group_id_allocation_size is an integer

Default value

1024

Table A.51. causal_clustering.relationship_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.relationship_id_allocation_size is an integer

Default value

1024

Table A.52. causal_clustering.relationship_type_token_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP_TYPE_TOKEN IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.relationship_type_token_id_allocation_size is an integer

Default value

32

Table A.53. causal_clustering.relationship_type_token_name_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of RELATIONSHIP_TYPE_TOKEN_NAME IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.relationship_type_token_name_id_allocation_size is an integer

Default value

1024

Table A.54. causal_clustering.replicated_lock_token_state_size

Description

The maximum file size before the replicated lock token state file is rotated (in unit of entries).

Valid values

causal_clustering.replicated_lock_token_state_size is an integer

Default value

1000

Table A.55. causal_clustering.schema_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of SCHEMA IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.schema_id_allocation_size is an integer

Default value

1024

Table A.56. causal_clustering.server_groups

Description

A list of group names for the server used when configuring load balancing and replication policies.

Valid values

causal_clustering.server_groups is a list separated by "," where items are a string

Default value

[]

Table A.57. causal_clustering.state_machine_apply_max_batch_size

Description

The maximum number of operations to be batched during applications of operations in the state machines.

Valid values

causal_clustering.state_machine_apply_max_batch_size is an integer

Default value

16

Table A.58. causal_clustering.state_machine_flush_window_size

Description

The number of operations to be processed before the state machines flush to disk.

Valid values

causal_clustering.state_machine_flush_window_size is an integer

Default value

4096

Table A.59. causal_clustering.string_block_id_allocation_size

Description

The size of the ID allocation requests Core servers will make when they run out of STRING_BLOCK IDs. Larger values mean less frequent requests but also result in more unused IDs (and unused disk space) in the event of a crash.

Valid values

causal_clustering.string_block_id_allocation_size is an integer

Default value

1024

Table A.60. causal_clustering.transaction_advertised_address

Description

Advertised hostname/IP address and port for the transaction shipping server.

Valid values

an advertised socket address

Default value

localhost:6000

Table A.61. causal_clustering.transaction_listen_address

Description

Network interface and port for the transaction shipping server to listen on.

Valid values

a listen socket address

Default value

127.0.0.1:6000

Table A.62. causal_clustering.unknown_address_logging_throttle

Description

Throttle limit for logging unknown cluster member address.

Valid values

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

Default value

PT10S

Table A.63. causal_clustering.upstream_selection_strategy

Description

An ordered list in descending preference of the strategy which read replicas use to choose upstream database server from which to pull transactional updates.

Valid values

causal_clustering.upstream_selection_strategy is a list separated by "," where items are a string

Default value

[default]

Table A.64. causal_clustering.user_defined_upstream_strategy

Description

If the operator specifies the user-defined upstream database selection strategy in causal_clustering.upstream_selection_strategy then the configuration of the upstream dependencies is written here.

Valid values

causal_clustering.user_defined_upstream_strategy is a string

Default value

 
Table A.65. cypher.default_language_version

Description

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

Valid values

cypher.default_language_version is one of 2.3, 3.1, 3.2, default

Default value

default

Table A.66. cypher.forbid_exhaustive_shortestpath

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

Table A.67. cypher.forbid_shortestpath_common_nodes

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

Table A.68. cypher.hints_error

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

Table A.69. cypher.min_replan_interval

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

PT10S

Table A.70. cypher.planner

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

Table A.71. cypher.statistics_divergence_threshold

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

Table A.72. dbms.active_database

Description

Name of the database to load.

Valid values

dbms.active_database is a string

Default value

graph.db

Table A.73. dbms.allow_format_migration

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

Table A.74. dbms.backup.address

Description

Listening server for online backups.

Valid values

dbms.backup.address is a hostname and port

Default value

127.0.0.1:6362-6372

Table A.75. dbms.backup.enabled

Description

Enable support for running online backups.

Valid values

dbms.backup.enabled is a boolean

Default value

true

Table A.76. dbms.checkpoint.interval.time

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

PT15M

Table A.77. dbms.checkpoint.interval.tx

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

Table A.78. dbms.checkpoint.iops.limit

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

300

Table A.79. dbms.config.strict_validation

Description

A strict configuration validation will prevent the database from starting up if unknown configuration options are specified in the neo4j settings namespace (such as dbms., ha., cypher., etc). This is currently false by default but will be true by default in 4.0.

Valid values

dbms.config.strict_validation is a boolean

Default value

false

Table A.80. dbms.connector.bolt.enabled

Description

Enable this connector.

Valid values

dbms.connector.bolt.enabled is a boolean

Default value

true

Table A.81. dbms.connector.bolt.type

Description

Connector type. This setting is deprecated and its value will instead be inferred from the name of the connector.

Valid values

dbms.connector.bolt.type is one of BOLT, HTTP

Default value

BOLT

Deprecated

The dbms.connector.bolt.type configuration setting has been deprecated.

Table A.82. dbms.connector.http.enabled

Description

Enable this connector.

Valid values

dbms.connector.http.enabled is a boolean

Default value

true

Table A.83. dbms.connector.http.type

Description

Connector type. This setting is deprecated and its value will instead be inferred from the name of the connector.

Valid values

dbms.connector.http.type is one of BOLT, HTTP

Default value

HTTP

Deprecated

The dbms.connector.http.type configuration setting has been deprecated.

Table A.84. dbms.connector.https.enabled

Description

Enable this connector.

Valid values

dbms.connector.https.enabled is a boolean

Default value

true

Table A.85. dbms.connector.https.type

Description

Connector type. This setting is deprecated and its value will instead be inferred from the name of the connector.

Valid values

dbms.connector.https.type is one of BOLT, HTTP

Default value

HTTP

Deprecated

The dbms.connector.https.type configuration setting has been deprecated.

Table A.86. dbms.connectors.default_advertised_address

Description

Default hostname or IP address the server uses to advertise itself to its connectors. To advertise a specific hostname or IP address for a specific connector, specify the advertised_address property for the specific connector.

Valid values

dbms.connectors.default_advertised_address is a string

Default value

localhost

Table A.87. dbms.connectors.default_listen_address

Description

Default network interface to listen for incoming connections. To listen for connections on all interfaces, use "0.0.0.0". To bind specific connectors to a specific network interfaces, specify the listen_address properties for the specific connector.

Valid values

dbms.connectors.default_listen_address is a string

Default value

127.0.0.1

Table A.88. dbms.directories.certificates

Description

Directory for storing certificates to be used by Neo4j for TLS connections. Certificate files must be named neo4j.cert and neo4j.key.

Valid values

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

Default value

certificates

Table A.89. dbms.directories.data

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

Table A.90. dbms.directories.import

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>

Table A.91. dbms.directories.lib

Description

Path of the lib directory.

Valid values

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

Default value

lib

Table A.92. dbms.directories.logs

Description

Path of the logs directory.

Valid values

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

Default value

logs

Table A.93. dbms.directories.metrics

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

Table A.94. dbms.directories.plugins

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

Table A.95. dbms.directories.run

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

Table A.96. dbms.ids.reuse.types.override

Description

Specified names of id types (comma separated) that should be reused. Currently only 'node' and 'relationship' types are supported.

Valid values

dbms.ids.reuse.types.override is a list separated by "," where items are one of NODE, RELATIONSHIP

Default value

[RELATIONSHIP, NODE]

Table A.97. dbms.import.csv.legacy_quote_escaping

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

Table A.98. dbms.index_sampling.background_enabled

Description

Enable or disable background index sampling.

Valid values

dbms.index_sampling.background_enabled is a boolean

Default value

true

Table A.99. dbms.index_sampling.buffer_size

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.

Replaced by

dbms.index_sampling.sample_size_limit

Table A.100. dbms.index_sampling.sample_size_limit

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

Table A.101. dbms.index_sampling.update_percentage

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

Table A.102. dbms.index_searcher_cache_size

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

Table A.103. dbms.jvm.additional

Description

Additional JVM arguments.

Valid values

a string

Table A.104. dbms.lock.acquisition.timeout

Description

The maximum time interval within which lock should be acquired.

Valid values

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

Default value

PT0S

Table A.105. dbms.logs.debug.level

Description

Debug log level threshold.

Valid values

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

Default value

INFO

Table A.106. dbms.logs.debug.rotation.delay

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

PT5M

Table A.107. dbms.logs.debug.rotation.keep_number

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

Table A.108. dbms.logs.debug.rotation.size

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

Table A.109. dbms.logs.gc.enabled

Description

Enable GC Logging.

Valid values

dbms.logs.gc.enabled is a boolean

Default value

false

Table A.110. dbms.logs.gc.options

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

Table A.111. dbms.logs.gc.rotation.keep_number

Description

Number of GC logs to keep.

Valid values

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

Default value

5

Table A.112. dbms.logs.gc.rotation.size

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

Table A.113. dbms.logs.http.enabled

Description

Enable HTTP request logging.

Valid values

dbms.logs.http.enabled is a boolean

Default value

false

Table A.114. dbms.logs.http.rotation.keep_number

Description

Number of HTTP logs to keep.

Valid values

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

Default value

5

Table A.115. dbms.logs.http.rotation.size

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

Table A.116. dbms.logs.query.allocation_logging_enabled

Description

Log allocated bytes for the executed queries being logged.

Valid values

dbms.logs.query.allocation_logging_enabled is a boolean

Default value

false

Table A.117. dbms.logs.query.enabled

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 3.1, “File locations”. This feature is available in the Neo4j Enterprise Edition.

Valid values

dbms.logs.query.enabled is a boolean

Default value

false

Table A.118. dbms.logs.query.page_logging_enabled

Description

Log page hits and page faults for the executed queries being logged.

Valid values

dbms.logs.query.page_logging_enabled is a boolean

Default value

false

Table A.119. dbms.logs.query.parameter_logging_enabled

Description

Log parameters for the executed queries being logged.

Valid values

dbms.logs.query.parameter_logging_enabled is a boolean

Default value

true

Table A.120. dbms.logs.query.rotation.keep_number

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

Table A.121. dbms.logs.query.rotation.size

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

Table A.122. dbms.logs.query.threshold

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

PT0S

Table A.123. dbms.logs.query.time_logging_enabled

Description

Log detailed time information for the executed queries being logged.

Valid values

dbms.logs.query.time_logging_enabled is a boolean

Default value

false

Table A.124. dbms.logs.security.level

Description

Security log level threshold.

Valid values

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

Default value

INFO

Table A.125. dbms.logs.security.rotation.delay

Description

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

Valid values

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

Default value

PT5M

Table A.126. dbms.logs.security.rotation.keep_number

Description

Maximum number of history files for the security log.

Valid values

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

Default value

7

Table A.127. dbms.logs.security.rotation.size

Description

Threshold for rotation of the security log.

Valid values

dbms.logs.security.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

Table A.128. dbms.memory.heap.initial_size

Description

Initial heap size. By default it is calculated based on available system resources.

Valid values

a byte size (valid units are k, K, m, M, g, G)

Table A.129. dbms.memory.heap.max_size

Description

Maximum heap size. By default it is calculated based on available system resources.

Valid values

a byte size (valid units are k, K, m, M, g, G)

Table A.130. dbms.memory.pagecache.size

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. If no page cache memory is configured, then a heuristic setting is computed based on available system resources.

Valid values

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

Table A.131. dbms.memory.pagecache.swapper

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

Table A.132. dbms.mode

Description

Configure the operating mode of the database — 'SINGLE' for stand-alone operation, 'HA' for operating as a member in an HA cluster, 'ARBITER' for a cluster member with no database in an HA cluster, 'CORE' for operating as a core member of a Causal Cluster, or 'READ_REPLICA' for operating as a read replica member of a Causal Cluster.

Valid values

dbms.mode is one of SINGLE, HA, ARBITER, CORE, READ_REPLICA

Default value

SINGLE

Table A.133. dbms.query_cache_size

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

Table A.134. dbms.read_only

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

Table A.135. dbms.record_format

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

 
Table A.136. dbms.relationship_grouping_threshold

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

Table A.137. dbms.rest.transaction.idle_timeout

Description

Timeout for idle transactions in the REST endpoint.

Valid values

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

Default value

PT1M

Table A.138. dbms.security.allow_csv_import_from_file_urls

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

Table A.139. dbms.security.auth_cache_max_capacity

Description

The maximum capacity for authentication and authorization caches (respectively).

Valid values

dbms.security.auth_cache_max_capacity is an integer

Default value

10000

Table A.140. dbms.security.auth_cache_ttl

Description

The time to live (TTL) for cached authentication and authorization info when using external auth providers (LDAP or plugin). Setting the TTL to 0 will disable auth caching. Disabling caching while using the LDAP auth provider requires the use of an LDAP system account for resolving authorization information.

Valid values

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

Default value

PT10M

Table A.141. dbms.security.auth_enabled

Description

Enable auth requirement to access Neo4j.

Valid values

dbms.security.auth_enabled is a boolean

Default value

true

Table A.142. dbms.security.auth_provider

Description

The authentication and authorization provider that contains both the users and roles. This can be one of the built-in native or ldap providers, or it can be an externally provided plugin, with a custom name prefixed by plugin-, i.e. plugin-<AUTH_PROVIDER_NAME>.

Valid values

dbms.security.auth_provider is a string

Default value

native

Table A.143. dbms.security.causal_clustering_status_auth_enabled

Description

Require authorization for access to the Causal Clustering status endpoints.

Valid values

dbms.security.causal_clustering_status_auth_enabled is a boolean

Default value

true

Table A.144. dbms.security.ha_status_auth_enabled

Description

Require authorization for access to the HA status endpoints.

Valid values

dbms.security.ha_status_auth_enabled is a boolean

Default value

true

Table A.145. dbms.security.http_authorization_classes

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

[]

Table A.146. dbms.security.ldap.authentication.cache_enabled

Description

Determines if the result of authentication via the LDAP server should be cached or not. Caching is used to limit the number of LDAP requests that have to be made over the network for users that have already been authenticated successfully. A user can be authenticated against an existing cache entry (instead of via an LDAP server) as long as it is alive (see dbms.security.auth_cache_ttl). An important consequence of setting this to true is that Neo4j then needs to cache a hashed version of the credentials in order to perform credentials matching. This hashing is done using a cryptographic hash function together with a random salt. Preferably a conscious decision should be made if this method is considered acceptable by the security standards of the organization in which this Neo4j instance is deployed.

Valid values

dbms.security.ldap.authentication.cache_enabled is a boolean

Default value

true

Table A.147. dbms.security.ldap.authentication.mechanism

Description

LDAP authentication mechanism. This is one of simple or a SASL mechanism supported by JNDI, for example DIGEST-MD5. simple is basic username and password authentication and SASL is used for more advanced mechanisms. See RFC 2251 LDAPv3 documentation for more details.

Valid values

dbms.security.ldap.authentication.mechanism is a string

Default value

simple

Table A.148. dbms.security.ldap.authentication.user_dn_template

Description

LDAP user DN template. An LDAP object is referenced by its distinguished name (DN), and a user DN is an LDAP fully-qualified unique user identifier. This setting is used to generate an LDAP DN that conforms with the LDAP directory’s schema from the user principal that is submitted with the authentication token when logging in. The special token {0} is a placeholder where the user principal will be substituted into the DN string.

Valid values

dbms.security.ldap.authentication.user_dn_template is a string

Default value

uid={0},ou=users,dc=example,dc=com

Table A.149. dbms.security.ldap.authorization.group_membership_attributes

Description

A list of attribute names on a user object that contains groups to be used for mapping to roles when LDAP authorization is enabled.

Valid values

dbms.security.ldap.authorization.group_membership_attributes is a list separated by "," where items are a string

Default value

[memberOf]

Table A.150. dbms.security.ldap.authorization.group_to_role_mapping
Description An authorization mapping from LDAP group names to Neo4j role names. The map should be formatted as a semicolon separated list of key-value pairs, where the key is the LDAP group name and the value is a comma separated list of corresponding role names. For example: group1=role1;group2=role2;group3=role3,role4,role5 You could also use whitespaces and quotes around group names to make this mapping more readable, for example: dbms.security.ldap.authorization.group_to_role_mapping=\ "cn=Neo4j Read Only,cn=users,dc=example,dc=com" = reader; \ "cn=Neo4j Read-Write,cn=users,dc=example,dc=com" = publisher; \ "cn=Neo4j Schema Manager,cn=users,dc=example,dc=com" = architect; \ "cn=Neo4j Administrator,cn=users,dc=example,dc=com" = admin.

Valid values

dbms.security.ldap.authorization.group_to_role_mapping is a string

Table A.151. dbms.security.ldap.authorization.system_password

Description

An LDAP system account password to use for authorization searches when dbms.security.ldap.authorization.use_system_account is true.

Valid values

dbms.security.ldap.authorization.system_password is a string

Table A.152. dbms.security.ldap.authorization.system_username

Description

An LDAP system account username to use for authorization searches when dbms.security.ldap.authorization.use_system_account is true. Note that the dbms.security.ldap.authentication.user_dn_template will not be applied to this username, so you may have to specify a full DN.

Valid values

dbms.security.ldap.authorization.system_username is a string

Table A.153. dbms.security.ldap.authorization.use_system_account
Description Perform LDAP search for authorization info using a system account instead of the user’s own account. If this is set to false (default), the search for group membership will be performed directly after authentication using the LDAP context bound with the user’s own account. The mapped roles will be cached for the duration of dbms.security.auth_cache_ttl, and then expire, requiring re-authentication. To avoid frequently having to re-authenticate sessions you may want to set a relatively long auth cache expiration time together with this option. NOTE: This option will only work if the users are permitted to search for their own group membership attributes in the directory. If this is set to true, the search will be performed using a special system account user with read access to all the users in the directory. You need to specify the username and password using the settings dbms.security.ldap.authorization.system_username and dbms.security.ldap.authorization.system_password with this option. Note that this account only needs read access to the relevant parts of the LDAP directory and does not need to have access rights to Neo4j, or any other systems.

Valid values

dbms.security.ldap.authorization.use_system_account is a boolean

Default value

false

Table A.154. dbms.security.ldap.authorization.user_search_base

Description

The name of the base object or named context to search for user objects when LDAP authorization is enabled. A common case is that this matches the last part of dbms.security.ldap.authentication.user_dn_template.

Valid values

dbms.security.ldap.authorization.user_search_base is a string

Default value

ou=users,dc=example,dc=com

Table A.155. dbms.security.ldap.authorization.user_search_filter

Description

The LDAP search filter to search for a user principal when LDAP authorization is enabled. The filter should contain the placeholder token {0} which will be substituted for the user principal.

Valid values

dbms.security.ldap.authorization.user_search_filter is a string

Default value

(&(objectClass=*)(uid={0}))

Table A.156. dbms.security.ldap.connection_timeout

Description

The timeout for establishing an LDAP connection. If a connection with the LDAP server cannot be established within the given time the attempt is aborted. A value of 0 means to use the network protocol’s (i.e., TCP’s) timeout value.

Valid values

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

Default value

PT30S

Table A.157. dbms.security.ldap.host
Description URL of LDAP server to use for authentication and authorization. The format of the setting is <protocol>://<hostname>:<port>, where hostname is the only required field. The supported values for protocol are ldap (default) and ldaps. The default port for ldap is 389 and for ldaps 636. For example: ldaps://ldap.example.com:10389. NOTE: You may want to consider using STARTTLS (dbms.security.ldap.use_starttls) instead of LDAPS for secure connections, in which case the correct protocol is ldap.

Valid values

dbms.security.ldap.host is a string

Default value

localhost

Table A.158. dbms.security.ldap.read_timeout

Description

The timeout for an LDAP read request (i.e. search). If the LDAP server does not respond within the given time the request will be aborted. A value of 0 means wait for a response indefinitely.

Valid values

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

Default value

PT30S

Table A.159. dbms.security.ldap.referral

Description

The LDAP referral behavior when creating a connection. This is one of follow, ignore or throw. * follow automatically follows any referrals * ignore ignores any referrals * throw throws an exception, which will lead to authentication failure.

Valid values

dbms.security.ldap.referral is a string

Default value

follow

Table A.160. dbms.security.ldap.use_starttls

Description

Use secure communication with the LDAP server using opportunistic TLS. First an initial insecure connection will be made with the LDAP server, and a STARTTLS command will be issued to negotiate an upgrade of the connection to TLS before initiating authentication.

Valid values

dbms.security.ldap.use_starttls is a boolean

Default value

false

Table A.161. dbms.security.log_successful_authentication

Description

Set to log successful authentication events to the security log. If this is set to false only failed authentication events will be logged, which could be useful if you find that the successful events spam the logs too much, and you do not require full auditing capability.

Valid values

dbms.security.log_successful_authentication is a boolean

Default value

true

Table A.162. dbms.security.procedures.default_allowed

Description

The default role that can execute all procedures and user-defined functions that are not covered by the dbms.security.procedures.roles setting. If the dbms.security.procedures.default_allowed setting is the empty string (default), procedures will be executed according to the same security rules as normal Cypher statements.

Valid values

dbms.security.procedures.default_allowed is a string

Default value

 
Table A.163. dbms.security.procedures.roles

Description

This provides a finer level of control over which roles can execute procedures than the dbms.security.procedures.default_allowed setting. For example: `dbms.security.procedures.roles=apoc.convert.:reader;apoc.load.json:writer;apoc.trigger.add:TriggerHappy` will allow the role reader to execute all procedures in the apoc.convert namespace, the role writer to execute all procedures in the apoc.load namespace that starts with json and the role TriggerHappy to execute the specific procedure apoc.trigger.add. Procedures not matching any of these patterns will be subject to the dbms.security.procedures.default_allowed setting.

Valid values

dbms.security.procedures.roles is a string

Default value

 
Table A.164. dbms.security.procedures.unrestricted

Description

A list of procedures and user defined functions (comma separated) that are allowed full access to the database. The list may contain both fully-qualified procedure names, and partial names with the wildcard '*'. Note that this enables these procedures to bypass security. Use with caution.

Valid values

dbms.security.procedures.unrestricted is a string

Default value

 
Table A.165. dbms.security.procedures.whitelist

Description

A list of procedures (comma separated) that are to be loaded. The list may contain both fully-qualified procedure names, and partial names with the wildcard '*'. If this setting is left empty no procedures will be loaded.

Valid values

dbms.security.procedures.whitelist is a string

Default value

*

Table A.166. dbms.shell.enabled

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

Table A.167. dbms.shell.host

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

Table A.168. dbms.shell.port

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

Table A.169. dbms.shell.read_only

Description

Read only mode. Will only allow read operations.

Valid values

dbms.shell.read_only is a boolean

Default value

false

Table A.170. dbms.shell.rmi_name

Description

The name of the shell.

Valid values

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

Default value

shell

Table A.171. dbms.shutdown_transaction_end_timeout

Description

The maximum amount of time to wait for running transactions to complete before allowing initiated database shutdown to continue.

Valid values

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

Default value

PT10S

Table A.172. dbms.threads.worker_count

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

Number of available processors (max 500).

Table A.173. dbms.transaction.bookmark_ready_timeout

Description

The maximum amount of time to wait for the database state represented by the bookmark.

Valid values

dbms.transaction.bookmark_ready_timeout is a duration (valid units are ms, s, m; default unit is s) which is minimum PT1S

Default value

PT30S

Table A.174. dbms.transaction.timeout

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

PT0S

Table A.175. dbms.tx_log.rotation.retention_policy

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

Table A.176. dbms.tx_log.rotation.size

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

Table A.177. dbms.udc.enabled

Description

Enable the UDC extension.

Valid values

dbms.udc.enabled is a boolean

Default value

true

Table A.178. dbms.unmanaged_extension_classes

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

[]

Table A.179. dbms.windows_service_name

Description

Name of the Windows Service.

Valid values

a string

Table A.180. ha.allow_init_cluster

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

Table A.181. ha.branched_data_copying_strategy

Description

Strategy for how to order handling of branched data on slaves and copying of the store from the master. The default is copy_then_branch, which, when combined with the keep_last or keep_none branch handling strategies results in a safer branching strategy, as there is always a store present so store failure to copy a store (for example, because of network failure) does not leave the instance without a store.

Valid values

ha.branched_data_copying_strategy is one of branch_then_copy, copy_then_branch

Default value

branch_then_copy

Table A.182. ha.branched_data_policy

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

Table A.183. ha.broadcast_timeout

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

PT30S

Table A.184. ha.configuration_timeout

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

PT1S

Table A.185. ha.data_chunk_size

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

Table A.186. ha.default_timeout

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

PT5S

Table A.187. ha.election_timeout

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

PT5S

Table A.188. ha.heartbeat_interval

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

PT5S

Table A.189. ha.heartbeat_timeout

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

PT40S

Table A.190. ha.host.coordination

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

Table A.191. ha.host.data

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

Table A.192. ha.initial_hosts

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

Table A.193. ha.internal_role_switch_timeout

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

PT10S

Table A.194. ha.join_timeout

Description

Timeout for joining a cluster. Defaults to ha.broadcast_timeout. Note that if the timeout expires during cluster formation, the operator may have to restart the instance or instances.

Valid values

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

Default value

PT30S

Table A.195. ha.learn_timeout

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

PT5S

Table A.196. ha.leave_timeout

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

PT30S

Table A.197. ha.max_acceptors

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

Table A.198. ha.max_channels_per_slave

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

Table A.199. ha.paxos_timeout

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

PT5S

Table A.200. ha.phase1_timeout

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

PT5S

Table A.201. ha.phase2_timeout

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

PT5S

Table A.202. ha.pull_batch_size

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

Table A.203. ha.pull_interval

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

PT0S

Table A.204. ha.role_switch_timeout

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

PT2M

Table A.205. ha.server_id

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

Table A.206. ha.slave_lock_timeout

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

PT20S

Table A.207. ha.slave_only

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

Table A.208. ha.slave_read_timeout

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

PT20S

Table A.209. ha.tx_push_factor

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

Table A.210. ha.tx_push_strategy

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

Table A.211. metrics.bolt.messages.enabled

Description

Enable reporting metrics about Bolt Protocol message processing.

Valid values

metrics.bolt.messages.enabled is a boolean

Default value

false

Table A.212. metrics.csv.enabled

Description

Set to true to enable exporting metrics to CSV files.

Valid values

metrics.csv.enabled is a boolean

Default value

false

Table A.213. metrics.csv.interval

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

PT3S

Table A.214. metrics.cypher.replanning.enabled

Description

Enable reporting metrics about number of occurred replanning events.

Valid values

metrics.cypher.replanning.enabled is a boolean

Default value

false

Table A.215. metrics.enabled

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

Table A.216. metrics.graphite.enabled

Description

Set to true to enable exporting metrics to Graphite.

Valid values

metrics.graphite.enabled is a boolean

Default value

false

Table A.217. metrics.graphite.interval

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

PT3S

Table A.218. metrics.graphite.server

Description

The hostname or IP address of the Graphite server.

Valid values

metrics.graphite.server is a hostname and port

Default value

:2003

Table A.219. metrics.jvm.buffers.enabled

Description

Enable reporting metrics about the buffer pools.

Valid values

metrics.jvm.buffers.enabled is a boolean

Default value

false

Table A.220. metrics.jvm.gc.enabled

Description

Enable reporting metrics about the duration of garbage collections.

Valid values

metrics.jvm.gc.enabled is a boolean

Default value

false

Table A.221. metrics.jvm.memory.enabled

Description

Enable reporting metrics about the memory usage.

Valid values

metrics.jvm.memory.enabled is a boolean

Default value

false

Table A.222. metrics.jvm.threads.enabled

Description

Enable reporting metrics about the current number of threads running.

Valid values

metrics.jvm.threads.enabled is a boolean

Default value

false

Table A.223. metrics.neo4j.causal_clustering.enabled

Description

Enable reporting metrics about Causal Clustering mode.

Valid values

metrics.neo4j.causal_clustering.enabled is a boolean

Default value

false

Table A.224. metrics.neo4j.checkpointing.enabled

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

Table A.225. metrics.neo4j.cluster.enabled

Description

Enable reporting metrics about HA cluster info.

Valid values

metrics.neo4j.cluster.enabled is a boolean

Default value

false

Table A.226. metrics.neo4j.counts.enabled

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

Table A.227. metrics.neo4j.enabled

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

Table A.228. metrics.neo4j.logrotation.enabled

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

Table A.229. metrics.neo4j.network.enabled

Description

Enable reporting metrics about the network usage.

Valid values

metrics.neo4j.network.enabled is a boolean

Default value

false

Table A.230. metrics.neo4j.pagecache.enabled

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

Table A.231. metrics.neo4j.server.enabled

Description

Enable reporting metrics about Server threading info.

Valid values

metrics.neo4j.server.enabled is a boolean

Default value

false

Table A.232. metrics.neo4j.tx.enabled

Description

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

Valid values

metrics.neo4j.tx.enabled is a boolean

Default value

false

Table A.233. metrics.prefix

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

Table A.234. tools.consistency_checker.check_graph

Description

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead. Perform checks between nodes, relationships, properties, types and tokens.

Valid values

tools.consistency_checker.check_graph is a boolean

Default value

true

Deprecated

The tools.consistency_checker.check_graph configuration setting has been deprecated.

Table A.235. tools.consistency_checker.check_indexes

Description

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead. 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

Deprecated

The tools.consistency_checker.check_indexes configuration setting has been deprecated.

Table A.236. tools.consistency_checker.check_label_scan_store

Description

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead. 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

Deprecated

The tools.consistency_checker.check_label_scan_store configuration setting has been deprecated.

Table A.237. tools.consistency_checker.check_property_owners

Description

This setting is deprecated. See commandline arguments for neoj4-admin check-consistency instead. 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

Deprecated

The tools.consistency_checker.check_property_owners configuration setting has been deprecated.