Skip to content

Commit eb01e1b

Browse files
Add dbms.routing.load_balancing.config.server_policies to the configs 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 c9a08ea commit eb01e1b

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
@@ -181,8 +181,10 @@ If no rule is able to produce a usable result then the driver is signalled a fai
181181
=== Policy names
182182

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

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

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
The Neo4j configuration settings are set in xref::/configuration/file-locations.adoc[_neo4j.conf_].
77
Refer to xref:configuration/neo4j-conf.adoc#_configuration_settings[The neo4j.conf file] for details on how to use configuration settings.
88

9+
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.
10+
911

1012
== Dynamic configuration settings
1113

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

3032

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

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

0 commit comments

Comments
 (0)