Skip to content

Add dbms.routing.load_balancing.config.server_policies to the configs reference page (#2414) #2454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2025
+41 −1
Merged

Add dbms.routing.load_balancing.config.server_policies to the configs reference page (#2414) #2454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion modules/ROOT/pages/clustering/clustering-advanced/multi-data-center-routing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,10 @@ If no rule is able to produce a usable result then the driver is signalled a fai
=== Policy names

The policies are configured under the namespace of the `server_policies` plugin and named as desired.
You can find them in the _neo4j.conf_ file.

Policy names can contain alphanumeric characters and underscores, and they are case sensitive.
Below is the property key for a policy with the name `mypolicy`.
Below is the property key for a policy with the name `mypolicy`:

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

Expand Down
38 changes: 38 additions & 0 deletions modules/ROOT/pages/configuration/configuration-settings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Refer to xref:configuration/neo4j-conf.adoc#_configuration_settings[The neo4j.co

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

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.


== Dynamic configuration settings

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


[role=label--enterprise]
== Configuration setting group

When deploying a multi-data cluster in Neo4j, you can configure the load balancing framework.

In Neo4j, the load balancing system is based on a plugin architecture.
The primary built-in plugin is `server_policies`, which is set up by the following property:

[source, shell]
----
dbms.routing.load_balancing.plugin=server_policies
----

`server_policies` plugin determines which servers are eligible to serve client requests based on predefined routing policies.
If a client does not specify a routing policy, the system defaults to using all available servers.

You can define routing policies by using the following property format:

[source, shell]
----
dbms.routing.load_balancing.config.server_policies.<policy-name>=<policy-definition>
----

Where `<policy-name>` is the name of the routing policy, and `<policy-definition>` specifies the server selection logic.

For the default policy, the `default` policy name is reserved.
Its default value is `all()`:

[source, shell]
----
dbms.routing.load_balancing.config.server_policies.default=all()
----

See xref:clustering/clustering-advanced/multi-data-center-routing.adoc#mdc-load-balancing-framework[Clustering -> Multi-data center routing] for more details.


== Checkpoint settings

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