Skip to content

Commit 04538df

Browse files
Update configuration settings for 2025.01
1 parent 57e6c28 commit 04538df

File tree

7 files changed

+36
-185
lines changed

7 files changed

+36
-185
lines changed

modules/ROOT/pages/backup-restore/online-backup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ When a full backup is requested, it always triggers a checkpoint.
238238
The backup cannot proceed until the checkpoint finishes.
239239

240240
While the server is checkpointing, the backup job receives no data, which may lead to the backup timeout.
241-
To extend the backup timeout, modify the xref:configuration/configuration-settings.adoc#config_dbms.cluster.catchup.client_inactivity_timeout[`dbms.cluster.catchup.client_inactivity_timeout`] setting, which restricts the network inactivity.
241+
To extend the backup timeout, modify the xref:configuration/configuration-settings.adoc#config_dbms.cluster.network.client_inactivity_timeout[`dbms.cluster.network.client_inactivity_timeout`] setting, which restricts the network inactivity.
242242
It controls the timeout duration of the catchup protocol, which is the underlying protocol of multiple catchup processes, including backups.
243243

244244
You can also tune up xref:configuration/configuration-settings.adoc#_checkpoint_settings[the Checkpoint settings] or check that your disks are performant enough to handle the load.

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,7 @@ ALTER DATABASE nonExisting IF EXISTS SET TOPOLOGY 1 PRIMARY 0 SECONDARY
119119

120120
[role="statsonlyqueryresult"]
121121
0 rows
122-
// This part can be added back once it has been implemented.
123-
// The allocation approach can be specified with the setting `initial.dbms.database_allocator`.
124-
// The available options are:
125-
//
126-
// * `EQUAL_NUMBERS`
127-
// * `OPTIMAL_DISC_USAGE`
128-
// * `ALL`
122+
129123

130124
[[alter-access]]
131125
=== Alter database access

modules/ROOT/pages/clustering/setup/discovery.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ The configured server uses all the addresses from the SRV record to join or form
9898

9999
[[clustering-discovery-k8s]]
100100
=== Discovery in Kubernetes
101+
101102
A special case is when a cluster is running in https://kubernetes.io/[Kubernetes^] and each server is running as a Kubernetes service.
102103
Then, the addresses of the other servers can be obtained using the List Service API, as described in the https://kubernetes.io/docs/reference/kubernetes-api/[Kubernetes API documentation^].
103104

@@ -115,7 +116,7 @@ With this configuration, `dbms.cluster.endpoints` is not used and any value assi
115116
====
116117
* The pod running Neo4j must use a service account that has permission to list services.
117118
For further information, see the Kubernetes documentation on https://kubernetes.io/docs/reference/access-authn-authz/rbac/[RBAC authorization^] or https://kubernetes.io/docs/reference/access-authn-authz/abac/[ABAC authorization^].
118-
* The configured `server.discovery.advertised_address` must exactly match the Kubernetes-internal DNS name, which is of the form `<service-name>.<namespace>.svc.cluster.local`.
119+
* The configured `server.cluster.advertised_address` must exactly match the Kubernetes-internal DNS name, which is of the form `<service-name>.<namespace>.svc.cluster.local`.
119120
====
120121

121122
The discovery configuration is used for initial discovery and to continuously exchange information about changes to the topology of the cluster.

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

Lines changed: 32 additions & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -310,21 +310,6 @@ m|+++1024+++
310310
|===
311311

312312

313-
[role=label--enterprise-edition label--deprecated-5.26]
314-
[[config_dbms.cluster.catchup.client_inactivity_timeout]]
315-
=== `dbms.cluster.catchup.client_inactivity_timeout`
316-
317-
.dbms.cluster.catchup.client_inactivity_timeout
318-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
319-
|===
320-
|Description
321-
a|The catch-up protocol times out if the given duration elapses with no network activity. Every message received by the client from the server extends the timeout duration.
322-
|Valid values
323-
a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`).
324-
|Default value
325-
m|+++10m+++
326-
|===
327-
328313
[role=label--enterprise-edition]
329314
[[config_dbms.cluster.network.client_inactivity_timeout]]
330315
=== `dbms.cluster.network.client_inactivity_timeout`
@@ -659,22 +644,6 @@ m|+++false+++
659644
|===
660645

661646

662-
[role=label--enterprise-edition label--deprecated-5.23]
663-
[[config_initial.dbms.database_allocator]]
664-
=== `initial.dbms.database_allocator`
665-
666-
.initial.dbms.database_allocator
667-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
668-
|===
669-
|Description
670-
a|Name of the initial database allocator. After the creation of the DBMS, it can be set by running the `CALL dbms.setDatabaseAllocator()` procedure.
671-
|Valid values
672-
a|A string.
673-
|Default value
674-
m|+++EQUAL_NUMBERS+++
675-
|===
676-
677-
678647
[role=label--enterprise-edition]
679648
[[config_initial.dbms.default_primaries_count]]
680649
=== `initial.dbms.default_primaries_count`
@@ -915,21 +884,6 @@ m|+++PRIMARY+++
915884
|===
916885

917886

918-
[role=label--enterprise-edition label--deprecated-5.23]
919-
[[config_server.discovery.listen_address]]
920-
=== `server.discovery.listen_address`
921-
922-
.server.discovery.listen_address
923-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
924-
|===
925-
|Description
926-
a|Host and port to bind the cluster member discovery management communication.
927-
|Valid values
928-
a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address.
929-
|Default value
930-
m|+++:5000+++
931-
|===
932-
933887
== Connection settings
934888

935889
Connection settings control the communication between servers and between a server and a client.
@@ -1463,22 +1417,6 @@ m|+++localhost+++
14631417
|===
14641418

14651419

1466-
[role=label--enterprise-edition label--deprecated-5.23]
1467-
[[config_server.discovery.advertised_address]]
1468-
=== `server.discovery.advertised_address`
1469-
1470-
.server.discovery.advertised_address
1471-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1472-
|===
1473-
|Description
1474-
a|Advertised cluster member discovery management communication.
1475-
|Valid values
1476-
a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from `server.default_advertised_address`.
1477-
|Default value
1478-
m|+++:5000+++
1479-
|===
1480-
1481-
14821420
[role=label--enterprise-edition]
14831421
[[config_server.routing.advertised_address]]
14841422
=== `server.routing.advertised_address`
@@ -1799,6 +1737,7 @@ m|+++false+++
17991737
|===
18001738

18011739

1740+
[role=label--changed-2025.01]
18021741
[[config_dbms.cypher.infer_schema_parts]]
18031742
=== `dbms.cypher.infer_schema_parts`
18041743

@@ -1816,7 +1755,7 @@ If more than one label can be inferred for a given node, the planner keeps the m
18161755
|Valid values
18171756
a|One of [MOST_SELECTIVE_LABEL, OFF].
18181757
|Default value
1819-
m|+++OFF+++
1758+
m|+++MOST_SELECTIVE_LABEL+++
18201759
|===
18211760

18221761
For some queries, the planner can infer predicates such as labels or types from the graph structure that can improve estimating the number of rows that each operator produces.
@@ -2075,7 +2014,7 @@ m|+++UTC+++
20752014
|===
20762015

20772016

2078-
[role=label--enterprise-edition]
2017+
[role=label--enterprise-edition label--changed-2025.01]
20792018
[[config_dbms.databases.seed_from_uri_providers]]
20802019
=== `dbms.databases.seed_from_uri_providers`
20812020

@@ -2086,12 +2025,13 @@ m|+++UTC+++
20862025
a|Databases can be created from an existing _seed_ (a database backup or dump) stored at a specific source URI.
20872026
Different implementations of `com.neo4j.dbms.seeding.SeedProvider` support various types of seed sources.
20882027

2089-
The following values are available: `S3SeedProvider`, `CloudSeedProvider`, `URLConnectionSeedProvider`, and `FileSeedProvider`.
2028+
The following values are available: `CloudSeedProvider`, `FileSeedProvider`, `S3SeedProvider`, and `URLConnectionSeedProvider`.
20902029

2091-
* `S3SeedProvider` supports seeds addressed with `s3`.
20922030
* `CloudSeedProvider` supports seeds addressed with `s3`, `azb`, `gs`.
2093-
* `URLConnectionSeedProvider` supports seeds addressed with `ftp`,`http`, and `https`.
20942031
* `FileSeedProvider` supports seeds addressed with `file`.
2032+
* `S3SeedProvider` supports seeds addressed with `s3`, but is deprecated and only usable from Cypher 5.
2033+
* `URLConnectionSeedProvider` supports seeds addressed with `ftp`,`http`, and `https`.
2034+
20952035

20962036
This list specifies enabled seed providers.
20972037
If a seed source (URI scheme) is supported by multiple providers in the list, the first matching provider will be used.
@@ -2100,7 +2040,7 @@ See xref:/clustering/databases.adoc#cluster-seed-uri[Seed from URI] for more inf
21002040
|Valid values
21012041
a|A comma-separated list where each element is a string.
21022042
|Default value
2103-
m|+++S3SeedProvider,CloudSeedProvider+++
2043+
m|+++CloudSeedProvider+++
21042044
|===
21052045

21062046

@@ -2317,26 +2257,7 @@ Neo4j has two different configuration files for logging, one for the _neo4j.log_
23172257
For more information, see xref:/monitoring/logging.adoc[Logging].
23182258

23192259

2320-
[role=label--deprecated-5.12 label--dynamic]
2321-
[[config_db.logs.query.annotation_data_as_json_enabled]]
2322-
=== `db.logs.query.annotation_data_as_json_enabled`
2323-
2324-
.db.logs.query.annotation_data_as_json_enabled
2325-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
2326-
|===
2327-
|Description
2328-
a|Log the annotation data as JSON strings instead of a Cypher map. This configuration has an effect only when the query log is in JSON format.
2329-
If `true`, it collapses the nested JSON objects in the query logger.
2330-
|Valid values
2331-
a|A boolean.
2332-
|Default value
2333-
m|+++false+++
2334-
|Replaced by
2335-
a|<<config_db.logs.query.annotation_data_format,`db.logs.query.annotation_data_format`>>
2336-
|===
2337-
2338-
2339-
[role=label--dynamic]
2260+
[role=label--dynamic label--changed-2025.01]
23402261
[[config_db.logs.query.annotation_data_format]]
23412262
=== `db.logs.query.annotation_data_format`
23422263

@@ -2354,7 +2275,7 @@ This only have effect when the query log is in JSON format.
23542275
|Valid values
23552276
a|One of [CYPHER, JSON, FLAT_JSON].
23562277
|Default value
2357-
m|+++CYPHER+++
2278+
m|+++JSON+++
23582279
|===
23592280

23602281

@@ -2529,6 +2450,7 @@ m|+++false+++
25292450
|===
25302451

25312452

2453+
[role=label--changed-2025.01]
25322454
[[config_server.logs.config]]
25332455
=== `server.logs.config`
25342456

@@ -2538,7 +2460,7 @@ m|+++false+++
25382460
|Description
25392461
a|Path to the logging configuration for debug, query, http and security logs.
25402462
|Valid values
2541-
a|A path. If relative, it is resolved from server.directories.neo4j_home.
2463+
a|A path. If relative, it is resolved from server.directories.configuration.
25422464
|Default value
25432465
m|+++conf/server-logs.xml+++
25442466
|===
@@ -2619,6 +2541,7 @@ m|+++20.00MiB+++
26192541
|===
26202542

26212543

2544+
[role=label--changed-2025.01]
26222545
[[config_server.logs.user.config]]
26232546
=== `server.logs.user.config`
26242547

@@ -2628,7 +2551,7 @@ m|+++20.00MiB+++
26282551
|Description
26292552
a|Path to the logging configuration of user logs.
26302553
|Valid values
2631-
a|A path. If relative, it is resolved from `server.directories.neo4j_home`.
2554+
a|A path. If relative, it is resolved from server.directories.configuration.
26322555
|Default value
26332556
m|+++conf/user-logs.xml+++
26342557
|===
@@ -2735,21 +2658,6 @@ m|+++0B+++
27352658
|===
27362659

27372660

2738-
[role=label--deprecated-5.8]
2739-
[[config_db.tx_state.memory_allocation]]
2740-
=== `db.tx_state.memory_allocation`
2741-
2742-
.db.tx_state.memory_allocation
2743-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
2744-
|===
2745-
|Description
2746-
a|Defines whether memory for transaction state should be allocated on- or off-heap. Note that for small transactions you can gain up to 25% write speed by setting it to `ON_HEAP`.
2747-
|Valid values
2748-
a|One of [ON_HEAP, OFF_HEAP].
2749-
|Default value
2750-
m|+++ON_HEAP+++
2751-
|===
2752-
27532661

27542662
[role=label--deprecated-5.7]
27552663
[[config_server.db.query_cache_size]]
@@ -2830,54 +2738,6 @@ m|
28302738
|===
28312739

28322740

2833-
[role=label--deprecated-5.26]
2834-
[[config_server.memory.off_heap.block_cache_size]]
2835-
=== `server.memory.off_heap.block_cache_size`
2836-
2837-
.server.memory.off_heap.block_cache_size
2838-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
2839-
|===
2840-
|Description
2841-
a|Defines the size of the off-heap memory blocks cache. The cache will contain this number of blocks for each block size that is power of two. Thus, maximum amount of memory used by blocks cache can be calculated as 2 * <<config_server.memory.off_heap.max_cacheable_block_size,server.memory.off_heap.max_cacheable_block_size>> * `server.memory.off_heap.block_cache_size`
2842-
|Valid values
2843-
a|An integer that is minimum `16`.
2844-
|Default value
2845-
m|+++128+++
2846-
|===
2847-
2848-
2849-
[role=label--deprecated-5.26]
2850-
[[config_server.memory.off_heap.max_cacheable_block_size]]
2851-
=== `server.memory.off_heap.max_cacheable_block_size`
2852-
2853-
.server.memory.off_heap.max_cacheable_block_size
2854-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
2855-
|===
2856-
|Description
2857-
a|Defines the maximum size of an off-heap memory block that can be cached to speed up allocations. The value must be a power of 2.
2858-
|Valid values
2859-
a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `4.00KiB` and is power of 2.
2860-
|Default value
2861-
m|+++512.00KiB+++
2862-
|===
2863-
2864-
2865-
[role=label--deprecated-5.8]
2866-
[[config_server.memory.off_heap.transaction_max_size]]
2867-
=== `server.memory.off_heap.transaction_max_size`
2868-
2869-
.server.memory.off_heap.transaction_max_size
2870-
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
2871-
|===
2872-
|Description
2873-
a|The maximum amount of off-heap memory that can be used to store transaction state data; it's a total amount of memory shared across all active transactions. Zero means 'unlimited'. Used when <<config_db.tx_state.memory_allocation,db.tx_state.memory_allocation>> is set to 'OFF_HEAP'.
2874-
|Valid values
2875-
a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `0B`.
2876-
|Default value
2877-
m|+++2.00GiB+++
2878-
|===
2879-
2880-
28812741
[[config_server.memory.pagecache.directio]]
28822742
=== `server.memory.pagecache.directio`
28832743

@@ -3053,7 +2913,7 @@ m|+++30s+++
30532913
|===
30542914

30552915

3056-
[role=label--enterprise-edition]
2916+
[role=label--enterprise-edition label--changed-2025.01]
30572917
[[config_server.metrics.csv.rotation.compression]]
30582918
=== `server.metrics.csv.rotation.compression`
30592919

@@ -3065,7 +2925,7 @@ a|Decides what compression to use for the csv history files.
30652925
|Valid values
30662926
a|One of [NONE, ZIP, GZ].
30672927
|Default value
3068-
m|+++NONE+++
2928+
m|+++ZIP+++
30692929
|===
30702930

30712931

@@ -4544,6 +4404,22 @@ m|+++cluster-state+++
45444404
|===
45454405

45464406

4407+
[role=label--enterprise-edition label--new-2025.01]
4408+
[[config_server.directories.configuration]]
4409+
=== `server.directories.configuration`
4410+
4411+
.server.directories.configuration
4412+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
4413+
|===
4414+
|Description
4415+
a|Root location of the configuration directory.
4416+
|Valid values
4417+
a|A path. If relative, it is resolved from server.directories.configuration
4418+
|Default value
4419+
m|+++conf+++
4420+
|===
4421+
4422+
45474423
[[config_server.directories.data]]
45484424
=== `server.directories.data`
45494425

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ RETURN name
3838
| "db.checkpoint.iops.limit" |
3939
| "db.format" |
4040
| "db.lock.acquisition.timeout" |
41-
| "db.logs.query.annotation_data_as_json_enabled" |
4241
| "db.logs.query.annotation_data_format" |
4342
| "db.logs.query.early_raw_logging_enabled" |
4443
| "db.logs.query.enabled" |

0 commit comments

Comments
 (0)