Settings reference
Common server settings
|
In the current version of Neo4j, the clustering-related parameters use the |
| Parameter | Instance type | Explanation |
|---|---|---|
Single |
This setting allows a |
|
All |
This setting configures the operating mode of the database. In version 4.4, there are three possible modes:
Example: |
|
- |
This setting is not supported. |
|
Core |
Minimum number of Core instances as Primary servers required to form a Core cluster. Example: |
|
Core |
The minimum size of the dynamically adjusted voting set (which only Core members may be a part of). Adjustments to the voting set happen automatically as the availability of Core instances changes, due to explicit operations such as starting or stopping a member, or unintended issues such as network partitions. Please note that this dynamic scaling of the voting set is generally desirable, as under some circumstances it can increase the number of instance failures which may be tolerated. A majority of the voting set must be available before members are voted in or out. Example: |
|
Core and Read Replica |
This setting specifies the strategy that the instance uses to determine the addresses for other instances in the cluster to contact for bootstrapping.
Possible values are:
The value of this setting determines how Example: |
|
Core and Read Replica |
The network addresses of an initial set of Core instance members that are available to bootstrap this Core or Read Replica instance.
In the default case, the initial discovery members are given as a comma-separated list of address/port pairs, and the default port for the discovery service is It is good practice to set this parameter to the same value on all Core instances. The behavior of this setting can be modified by configuring the setting Example: |
|
All |
The address/port setting that specifies where the instance advertises that it listens for discovery protocol messages from other members of the cluster.
If this instance is included in the Example: |
|
Core |
The address/port setting that specifies where the Neo4j instance advertises to other members of the cluster that it listens for Raft messages within the Core cluster. Example: |
|
All |
The address/port setting that specifies where the instance advertises where it listens for requests for transactions in the transaction-shipping catchup protocol. Example: |
|
All |
The address/port setting that specifies which network interface and port the Neo4j instance binds to for the cluster discovery protocol. Example: |
|
Core |
The address/port setting that specifies which network interface and port the Neo4j instance binds to for cluster communication.
This setting must be set in coordination with the address this instance advertises it listens at in the setting Example: |
|
All |
The address/port setting that specifies which network interface and port the Neo4j instance binds to for cluster communication.
This setting must be set in coordination with the address this instance advertises it listens at in the setting Example: |
|
Core and Read Replica |
Condition for when store copy should eventually fail. A request is allowed to retry for any amount of attempts as long as the configured time has not been met. For very large stores or other reason that might make transferring of files slow this could be increased. Example: |
Multi-data center settings
| Parameter | Explanation |
|---|---|
Enables multi-data center features. Requires appropriate licensing. Example: |
|
A list of group names for the server used when configuring load balancing and replication policies. Example: |
|
The group of servers which should be preferred when selecting leaders for the specified database.
If the instance currently acting as leader for this database is not a member of the configured server group, then the cluster will attempt to transfer leadership to an instance which is a member.
It is not guaranteed that leadership will always be held by a server in the desired group.
For example, if no member of the desired group is available or has up-to-date store contents.
The cluster will seek to preserve availability, over respecting the To set a default Example: |
|
An ordered list in descending preference of the strategy which Read Replicas use to choose upstream database server from which to pull transactional updates. Example: |
|
Defines the configuration of upstream dependencies.
Can only be used if Example: |
|
The load balancing plugin to use.
One pre-defined plugin named Example: |
|
|
Defines a custom policy under the name Example: By default, the load balancer sends read requests only to replicas/followers, which means these two servers must be of that kind.
To allow reads on the leader, set to |