Skip to content

Commit 5532f0c

Browse files
Add dbms.routing.load_balancing.config.server_policies to the confi… (#2456)
…gs reference page (#2414) We state that the _Configuration settings_ page lists all config settings in Neo4j. But we miss `dbms.routing.load_balancing.config.server_policies`, which is not a setting but a setting group. Nevertheless, we need to include this setting group/plugin on the page.
1 parent 894fc31 commit 5532f0c

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

modules/ROOT/pages/clustering/clustering-advanced/multi-data-center-routing.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,10 @@ If no rule is able to produce a usable result then the driver is signalled a fai
180180
=== Policy names
181181

182182
The policies are configured under the namespace of the `server_policies` plugin and named as desired.
183+
You can find them in the _neo4j.conf_ file.
184+
183185
Policy names can contain alphanumeric characters and underscores, and they are case sensitive.
184-
Below is the property key for a policy with the name `mypolicy`.
186+
Below is the property key for a policy with the name `mypolicy`:
185187

186188
`dbms.routing.load_balancing.config.server_policies.mypolicy=`
187189

modules/ROOT/pages/configuration/configuration-settings.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Refer to xref:configuration/neo4j-conf.adoc#_configuration_settings[The neo4j.co
88

99
For lists of deprecated and removed configuration settings in 2025.x, refer to the page xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals in Neo4j 2025.x].
1010

11+
To list all available configuration settings on a Neo4j server, run the link:https://neo4j.com/docs/cypher-manual/5/clauses/listing-settings[`SHOW SETTINGS`] command.
12+
1113

1214
== Dynamic configuration settings
1315

@@ -30,6 +32,42 @@ It is recommended that the settings for a database are the same across all membe
3032
For more information on how to update dynamic configuration settings, see xref:configuration/dynamic-settings.adoc[Update dynamic settings].
3133

3234

35+
[role=label--enterprise]
36+
== Configuration setting group
37+
38+
When deploying a multi-data cluster in Neo4j, you can configure the load balancing framework.
39+
40+
In Neo4j, the load balancing system is based on a plugin architecture.
41+
The primary built-in plugin is `server_policies`, which is set up by the following property:
42+
43+
[source, shell]
44+
----
45+
dbms.routing.load_balancing.plugin=server_policies
46+
----
47+
48+
`server_policies` plugin determines which servers are eligible to serve client requests based on predefined routing policies.
49+
If a client does not specify a routing policy, the system defaults to using all available servers.
50+
51+
You can define routing policies by using the following property format:
52+
53+
[source, shell]
54+
----
55+
dbms.routing.load_balancing.config.server_policies.<policy-name>=<policy-definition>
56+
----
57+
58+
Where `<policy-name>` is the name of the routing policy, and `<policy-definition>` specifies the server selection logic.
59+
60+
For the default policy, the `default` policy name is reserved.
61+
Its default value is `all()`:
62+
63+
[source, shell]
64+
----
65+
dbms.routing.load_balancing.config.server_policies.default=all()
66+
----
67+
68+
See xref:clustering/clustering-advanced/multi-data-center-routing.adoc#mdc-load-balancing-framework[Clustering -> Multi-data center routing] for more details.
69+
70+
3371
== Checkpoint settings
3472

3573
Checkpointing is the process of flushing all pending page updates from the page cache to the store files.

0 commit comments

Comments
 (0)