From 4999f6b694615b33f053247e8e32d8355f432b12 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Thu, 11 Sep 2025 11:52:52 +0200 Subject: [PATCH 1/5] Update descriptions of the `initial.` settings --- .../configuration/configuration-settings.adoc | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index edecb288b..9a28a8137 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -775,7 +775,7 @@ m|+++20m+++ [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|Automatically enable free servers. +a|Automatically enables all `Free` servers when the DBMS starts for the first time. |Valid values a|A boolean. |Default value @@ -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 primary servers 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 @@ -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 secondary servers for 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 @@ -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 @@ -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 @@ -855,7 +855,7 @@ 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|Specifies whether the server can host databases as primaries, secondaries, or neither. 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 @@ -871,7 +871,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 @@ -2297,13 +2297,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. +Once the initial default database is created, the setting is not valid anymore. +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 From b97889b50b377360aab7599f0ba9b3b52739d900 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Mon, 22 Sep 2025 11:16:07 +0200 Subject: [PATCH 2/5] Apply suggestions from code review --- modules/ROOT/pages/configuration/configuration-settings.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index 9a28a8137..943a85703 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -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. 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. +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 @@ -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. 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. +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 From cf9f9252dc9729ad8648ac640aeb1e06198483e8 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Fri, 26 Sep 2025 09:31:22 +0200 Subject: [PATCH 3/5] Update modules/ROOT/pages/configuration/configuration-settings.adoc --- modules/ROOT/pages/configuration/configuration-settings.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index 943a85703..6d7074b11 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -855,7 +855,7 @@ m|++++++ [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|Specifies whether the server can host databases as primaries, secondaries, or neither. 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. +a|Specifies whether the server can host databases as primaries, secondaries, or either. 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 From 5f78577a6b5f7735890ba09fcbbc292bfaf44891 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Wed, 1 Oct 2025 15:55:56 +0200 Subject: [PATCH 4/5] Apply suggestions from code review --- .../ROOT/pages/configuration/configuration-settings.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index 6d7074b11..f12a38e96 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -775,7 +775,7 @@ m|+++20m+++ [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|Automatically enables all `Free` servers when the DBMS starts for the first time. +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 @@ -855,7 +855,9 @@ m|++++++ [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|Specifies whether the server can host databases as primaries, secondaries, or either. 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. +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 From 1066b921f852e6ea11661f7c2757588e37229b61 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Thu, 2 Oct 2025 13:05:45 +0200 Subject: [PATCH 5/5] Update modules/ROOT/pages/configuration/configuration-settings.adoc --- modules/ROOT/pages/configuration/configuration-settings.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index f12a38e96..42753ed89 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -2300,7 +2300,7 @@ The DBMS settings must be consistent across all configuration files in a cluster |=== |Description a|Specifies the default database name *before* the first DBMS startup. -Once the initial default database is created, the setting is not valid anymore. +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. 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.