Skip to content

Commit c4518a5

Browse files
Update descriptions of the initial. settings (#2587) (#2634)
Improve the descriptions of the `initial..` settings to emphasize that they occur only in two cases: - When a DBMS is created (at the first DBMS startup) - When a server is enabled (when you add a new server to the existing cluster)
1 parent 0e12936 commit c4518a5

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ m|+++20m+++
775775
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
776776
|===
777777
|Description
778-
a|Automatically enable free servers.
778+
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.
779779
|Valid values
780780
a|A boolean.
781781
|Default value
@@ -791,7 +791,7 @@ m|+++false+++
791791
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
792792
|===
793793
|Description
794-
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.
794+
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.
795795
|Valid values
796796
a|An integer that is minimum `1` and is maximum `11`.
797797
|Default value
@@ -807,7 +807,7 @@ m|+++1+++
807807
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
808808
|===
809809
|Description
810-
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.
810+
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.
811811
|Valid values
812812
a|An integer that is minimum `0` and is maximum `20`.
813813
|Default value
@@ -823,7 +823,7 @@ m|+++0+++
823823
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
824824
|===
825825
|Description
826-
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`.
826+
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`.
827827
|Valid values
828828
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`.
829829
|Default value
@@ -839,7 +839,7 @@ m|++++++
839839
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
840840
|===
841841
|Description
842-
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`.
842+
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`.
843843
|Valid values
844844
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`.
845845
|Default value
@@ -855,7 +855,9 @@ m|++++++
855855
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
856856
|===
857857
|Description
858-
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.
858+
a|Determines whether the server is configured to host primary databases only, secondary databases only, or both.
859+
Initialized at the first DBMS startup and/or when a newly added server is enabled.
860+
The setting is used as the default input for the `ENABLE SERVER` command; can be overriden when the command is executed.
859861
|Valid values
860862
a|One of [PRIMARY, SECONDARY, NONE].
861863
|Default value
@@ -871,7 +873,7 @@ m|+++NONE+++
871873
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
872874
|===
873875
|Description
874-
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.
876+
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.
875877
|Valid values
876878
a|A comma-separated list where each element is a string identifying a server tag, which contains no duplicate items.
877879
|Default value
@@ -2297,13 +2299,11 @@ The DBMS settings must be consistent across all configuration files in a cluster
22972299
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
22982300
|===
22992301
|Description
2300-
a|Name of the default database. +
2301-
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.
2302-
2303-
The `initial.dbms.default_database` setting is meant to set the default database *before* the creation of the DBMS.
2304-
Once it is created, the setting is not valid anymore.
2302+
a|Specifies the default database name *before* the first DBMS startup.
2303+
After the initial default database is created, changing this setting has no effect.
2304+
To change the default database, use the xref:/clustering/databases.adoc#cluster-default-database[`dbms.setDefaultDatabase()`] procedure instead.
23052305

2306-
To set the default database, use the xref:/clustering/databases.adoc#cluster-default-database[`dbms.setDefaultDatabase()`] procedure instead.
2306+
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.
23072307
|Valid values
23082308
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.
23092309
|Default value

0 commit comments

Comments
 (0)