Skip to content

Update descriptions of the initial. settings #2587

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 5 commits into from
Oct 3, 2025
+13 −13
Merged

Update descriptions of the initial. settings #2587

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4999f6b
Update descriptions of the `initial.` settings
NataliaIvakina Sep 11, 2025
b97889b
Apply suggestions from code review
NataliaIvakina Sep 22, 2025
cf9f925
Update modules/ROOT/pages/configuration/configuration-settings.adoc
NataliaIvakina Sep 26, 2025
5f78577
Apply suggestions from code review
NataliaIvakina Oct 1, 2025
1066b92
Update modules/ROOT/pages/configuration/configuration-settings.adoc
NataliaIvakina Oct 2, 2025
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
26 changes: 13 additions & 13 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 @@ -775,7 +775,7 @@ m|+++20m+++
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Automatically enable free servers.
a|Automatically enables servers that are in the `FREE` state - not only during the initial DBMS startup but also whenever a new server joins the cluster.
|Valid values
a|A boolean.
|Default value
Expand All @@ -791,7 +791,7 @@ m|+++false+++
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|The initial default number of primary servers for the standard databases. If the user does not specify the number of primaries in `CREATE DATABASE`, this value will be used unless overwritten by the `dbms.setDefaultAllocationNumbers` procedure.
a|The initial default number of primaries for the standard databases. Initialized at the first DBMS startup. If the user does not specify the number of primaries in `CREATE DATABASE`, this value will be used unless overwritten by the `dbms.setDefaultAllocationNumbers` procedure.
|Valid values
a|An integer that is minimum `1` and is maximum `11`.
|Default value
Expand All @@ -807,7 +807,7 @@ m|+++1+++
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|The initial default number of secondary servers for standard databases. If the user does not specify the number of secondaries in `CREATE DATABASE`, this value will be used unless overwritten by the `dbms.setDefaultAllocationNumbers` procedure.
a|The initial default number of secondaries for the standard databases. Initialized at the first DBMS startup. If the user does not specify the number of secondaries in `CREATE DATABASE`, this value will be used unless overwritten by the `dbms.setDefaultAllocationNumbers` procedure.
|Valid values
a|An integer that is minimum `0` and is maximum `20`.
|Default value
Expand All @@ -823,7 +823,7 @@ m|+++0+++
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Names of the databases allowed on this server; all others are denied. Empty means all are allowed. This configuration can be overridden when enabling the server or altered at runtime without changing this setting. Exclusive with `server.initial_denied_databases`.
a|List of database names allowed on this server; all others are denied. Empty means all are allowed. This configuration is initialized at the first DBMS startup and/or when a newly added server is enabled. The setting is used as the default input for the `ENABLE SERVER` command; can be overriden when the command is executed. Exclusive with `server.initial_denied_databases`.
|Valid values
a|A comma-separated set where each element is a valid database name containing only alphabetic characters, numbers, dots, and dashes with a length between 3 and 63 characters, starting with an alphabetic character or number but not with the name `system`.
|Default value
Expand All @@ -839,7 +839,7 @@ m|++++++
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Names of the databases not allowed on this server. Empty means nothing is denied. This configuration can be overridden when enabling the server or altered at runtime without changing this setting. Exclusive with `server.initial_allowed_databases`.
a|List of database names not allowed on this server. Empty means nothing is denied. This configuration is initialized at the first DBMS startup and/or when a newly added server is enabled. The setting is used as the default input for the `ENABLE SERVER` command; can be overriden when the command is executed. Exclusive with `server.initial_allowed_databases`.
|Valid values
a|A comma-separated set where each element is a valid database name containing only alphabetic characters, numbers, dots, and dashes with a length between 3 and 63 characters, starting with an alphabetic character or number but not with the name `system`.
|Default value
Expand All @@ -855,7 +855,9 @@ m|++++++
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|An server can restrict itself to allow databases to be hosted only as primaries or secondaries. This setting is the default input for the `ENABLE SERVER` command - the user can overwrite it when executing the command.
a|Determines whether the server is configured to host primary databases only, secondary databases only, or both.
Initialized at the first DBMS startup and/or when a newly added server is enabled.
The setting is used as the default input for the `ENABLE SERVER` command; can be overriden when the command is executed.
|Valid values
a|One of [PRIMARY, SECONDARY, NONE].
|Default value
Expand All @@ -871,7 +873,7 @@ m|+++NONE+++
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|A list of tag names for the server used by the database allocation and when configuring load balancing and replication policies. This setting is the default input for the `ENABLE SERVER` command - the user can overwrite it when executing the command.
a|A list of server tag names used by the database allocation and when configuring load balancing and replication policies. Initialized at the first DBMS startup and/or when a newly added server is enabled. The setting is used as the default input for the `ENABLE SERVER` command; can be overriden when the command is executed.
|Valid values
a|A comma-separated list where each element is a string identifying a server tag, which contains no duplicate items.
|Default value
Expand Down Expand Up @@ -2297,13 +2299,11 @@ The DBMS settings must be consistent across all configuration files in a cluster
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Name of the default database. +
NOTE: This setting is not the same as `dbms.default_database`, which was used to set the default database in Neo4j 4.x and earlier versions.

The `initial.dbms.default_database` setting is meant to set the default database *before* the creation of the DBMS.
Once it is created, the setting is not valid anymore.
a|Specifies the default database name *before* the first DBMS startup.
After the initial default database is created, changing this setting has no effect.
To change the default database, use the xref:/clustering/databases.adoc#cluster-default-database[`dbms.setDefaultDatabase()`] procedure instead.

To set the default database, use the xref:/clustering/databases.adoc#cluster-default-database[`dbms.setDefaultDatabase()`] procedure instead.
NOTE: This setting is not the same as `dbms.default_database`, which was used to set the default database in Neo4j 4.x and earlier versions.
|Valid values
a|A valid database name containing only alphabetic characters, numbers, dots, and dashes with a length between 3 and 63 characters, starting with an alphabetic character or number but not with the name system.
|Default value
Expand Down