Skip to content

Commit 5dc7a9d

Browse files
Add a new page for deprecations, removals, and changes per version
1 parent 75f26f2 commit 5dc7a9d

File tree

3 files changed

+294
-1
lines changed

3 files changed

+294
-1
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,8 @@
239239
240240
* xref:procedures.adoc[]
241241
242+
* xref:changes-deprecations-removals.adoc[]
243+
242244
* xref:tutorial/index.adoc[]
243245
//** xref:tutorial/local-causal-cluster.adoc[]
244246
//** xref:tutorial/causal-backup-restore-db.adoc[]
Lines changed: 289 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,289 @@
1+
:description: Page contains lists of procedures, configuration settings, metrics removed or deprecated in Neo4j 2025. Also, you can find information on changed defaults and new functionality of neo4j-admin commands.
2+
3+
//Check Mark
4+
:check-mark: icon:check[]
5+
6+
7+
[[removals-deprecations-2025-01]]
8+
= Deprecations, removals, and changes per Neo4j version
9+
10+
== Neo4j 2025.01
11+
12+
=== Removed built-in Neo4j procedures
13+
14+
.See procedures removed in Neo4j 2025.01 without replacement.
15+
[%collapsible]
16+
====
17+
[options=header,cols="3m,1,1"]
18+
|===
19+
| Name
20+
| Community Edition
21+
| Enterprise Edition
22+
23+
| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_movetonextdiscoveryversion[`dbms.cluster.moveToNextDiscoveryVersion()`]
24+
|
25+
| {check-mark}
26+
27+
| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_showparalleldiscoverystate[`dbms.cluster.showParallelDiscoveryState()`]
28+
|
29+
| {check-mark}
30+
31+
| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_switchdiscoveryserviceversion[`dbms.cluster.switchDiscoveryServiceVersion()`]
32+
|
33+
| {check-mark}
34+
35+
|link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_setDatabaseAllocator[`dbms.setDatabaseAllocator()`]
36+
|
37+
|{check-mark}
38+
39+
|===
40+
====
41+
42+
=== Removed Neo4j configuration settings
43+
44+
.See all removed configuration settings in Neo4j 2025.01
45+
[%collapsible]
46+
====
47+
[options=header,cols="4m,2"]
48+
|===
49+
|Name
50+
|Notes
51+
52+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings/#config_db.cluster.raft.leader_transfer.priority_group[`db.cluster.raft.leader_transfer.priority_group`]
53+
|label:enterprise[Enterprise Edition]
54+
55+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_db.logs.query.annotation_data_as_json_enabled[`db.logs.query.annotation_data_as_json_enabled`]
56+
|label:dynamic[]
57+
58+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_db.tx_state.memory_allocation[`db.tx_state.memory_allocation`]
59+
|
60+
61+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_dbms.cluster.catchup.client_inactivity_timeout[`dbms.cluster.catchup.client_inactivity_timeout`]
62+
|label:enterprise[Enterprise Edition]
63+
64+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_dbms.cluster.discovery.log_level[`dbms.cluster.discovery.log_level`]
65+
|label:enterprise[Enterprise Edition]
66+
67+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_dbms.cluster.discovery.type[`dbms.cluster.discovery.type`]
68+
|label:enterprise[Enterprise Edition]
69+
70+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_dbms.cluster.discovery.v2.endpoints[`dbms.cluster.discovery.v2.endpoints`]
71+
|label:enterprise[Enterprise Edition]
72+
73+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_dbms.cluster.discovery.version[`dbms.cluster.discovery.version`]
74+
|label:enterprise[Enterprise Edition]
75+
76+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_dbms.kubernetes.discovery.v2.service_port_name[`dbms.kubernetes.discovery.v2.service_port_name`]
77+
|label:enterprise[Enterprise Edition]
78+
79+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_initial.dbms.database_allocator[`initial.dbms.database_allocator`]
80+
|label:enterprise[Enterprise Edition]
81+
82+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_server.cluster.catchup.connect_randomly_to_server_group[`server.cluster.catchup.connect_randomly_to_server_group`]
83+
|label:enterprise[Enterprise Edition] label:dynamic[]
84+
85+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_server.discovery.advertised_address[`server.discovery.advertised_address`]
86+
|label:enterprise[Enterprise Edition]
87+
88+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_server.discovery.listen_address[`server.discovery.listen_address`]
89+
|label:enterprise[Enterprise Edition]
90+
91+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_server.groups[`server.groups`]
92+
|label:enterprise[Enterprise Edition]
93+
94+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_server.memory.off_heap.block_cache_size[`server.memory.off_heap.block_cache_size`]
95+
|
96+
97+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_server.memory.off_heap.max_cacheable_block_size[`server.memory.off_heap.max_cacheable_block_size`]
98+
|
99+
100+
|link:{neo4j-docs-base-uri}/operations-manual/5/configuration/configuration-settings#config_server.memory.off_heap.transaction_max_size[`server.memory.off_heap.transaction_max_size`]
101+
|
102+
103+
|===
104+
====
105+
106+
107+
[role=label--enterprise]
108+
=== Removed Neo4j metrics
109+
110+
.See all removed metrics in Neo4j 2025.01
111+
[%collapsible]
112+
====
113+
[options="header"]
114+
|===
115+
|Name
116+
117+
a|**link:{neo4j-docs-base-uri}/operations-manual/5/monitoring/metrics/reference/#raft-core-metrics[Raft core metrics] - replaced accordingly by the link:{neo4j-docs-base-uri}/operations-manual/5/monitoring/metrics/reference/#raft-metrics[Raft metrics]**
118+
119+
|<prefix>.causal_clustering.core.append_index
120+
121+
|<prefix>.causal_clustering.core.commit_index
122+
123+
|<prefix>.causal_clustering.core.applied_index
124+
125+
|<prefix>.causal_clustering.core.term
126+
127+
|<prefix>.causal_clustering.core.tx_retries
128+
129+
|<prefix>.causal_clustering.core.is_leader
130+
131+
|<prefix>.causal_clustering.core.in_flight_cache.total_bytes
132+
133+
|<prefix>.causal_clustering.core.in_flight_cache.max_bytes
134+
135+
|<prefix>.causal_clustering.core.in_flight_cache.element_count
136+
137+
|<prefix>.causal_clustering.core.in_flight_cache.max_elements
138+
139+
|<prefix>.causal_clustering.core.in_flight_cache.hits
140+
141+
|<prefix>.causal_clustering.core.in_flight_cache.misses
142+
143+
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.lag
144+
145+
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.bytes
146+
147+
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.size
148+
149+
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.async_put
150+
151+
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.sync_put
152+
153+
|<prefix>.causal_clustering.core.message_processing_delay
154+
155+
|<prefix>.causal_clustering.core.message_processing_timer
156+
157+
|<prefix>.causal_clustering.core.replication_new
158+
159+
|<prefix>.causal_clustering.core.replication_attempt
160+
161+
|<prefix>.causal_clustering.core.replication_fail
162+
163+
|<prefix>.causal_clustering.core.replication_maybe
164+
165+
|<prefix>.causal_clustering.core.replication_success
166+
167+
|<prefix>.causal_clustering.core.last_leader_message
168+
169+
a|**link:{neo4j-docs-base-uri}/operations-manual/5/monitoring/metrics/reference/#read-replica-metrics[Read Replica metrics] - replaced accordingly by the link:{neo4j-docs-base-uri}/operations-manual/5/monitoring/metrics/reference/#store-copy-metrics[Store copy metrics]**
170+
171+
|<prefix>.causal_clustering.read_replica.pull_updates
172+
173+
|<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_requested
174+
175+
|<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_received
176+
177+
|===
178+
====
179+
180+
=== SSL framework
181+
182+
.See the CBC-based ciphers that are no longer used from Neo4j 2025.01:
183+
184+
* TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
185+
* TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
186+
* TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
187+
* TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
188+
189+
For more details, refer to the page on link:{neo4j-docs-base-uri}/operations-manual/5/security/ssl-framework/#ssl-other-configs[SSL framework] under the Security section.
190+
191+
.Private keys
192+
193+
Versions before Neo4j 5.0 allow keys to be stored with the old PKCS #1 standard.
194+
You can identify them by the line `-----BEGIN RSA PRIVATE KEY-----` at the beginning of the file.
195+
While Neo4j 5.0 can load and use those keys, they are considered deprecated and will be removed in a future version.
196+
197+
198+
.SSL-related configuration setting (or move it to the section 'Changed default values'?)
199+
200+
Starting from 2025.01, the default value of `dbms.ssl.policy.*.verify_hostname` is changed from `false` to `true`.
201+
See details in the table link:{neo4j-docs-base-uri}/operations-manual/5/security/ssl-framework/#ssl-configuration[in the table under Configuration section on the page SSL framework].
202+
203+
=== Ports
204+
205+
Port `5000` is no longer used from 2025.01 onwards.
206+
207+
=== Deprecated built-in procedures
208+
209+
.See all deprecated procedures
210+
[%collapsible]
211+
====
212+
[options=header, cols="3m,1,1,3"]
213+
|===
214+
| Name
215+
| Community Edition
216+
| Enterprise Edition
217+
| Comment
218+
219+
| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_quarantineDatabase[`dbms.quarantineDatabase()`] label:admin-only[]
220+
|
221+
| {check-mark}
222+
| Replaced by xref:procedures.adoc#procedure_dbms_unquarantineDatabase[`dbms.unquarantineDatabase()`]
223+
|===
224+
====
225+
226+
=== Java API
227+
228+
In 2025.01, the deprecated public API is removed.
229+
230+
=== Neo4j configuration settings with changed default values
231+
232+
[options=header, cols="3m,1,1"]
233+
|===
234+
| Name
235+
| Old default value
236+
| New default value
237+
238+
|`dbms.cypher.infer_schema_parts`
239+
|`OFF`
240+
|`MOST_SELECTIVE_LABEL`
241+
242+
|`db.logs.query.annotation_data_format`
243+
|`CYPHER`
244+
|`JSON`
245+
246+
|`dbms.databases.seed_from_uri_providers`
247+
|`S3SeedProvider,CloudSeedProvider`
248+
|`CloudSeedProvider`
249+
250+
|`server.metrics.csv.rotation.compression`
251+
|`NONE`
252+
|`ZIP`
253+
254+
|`server.panic.shutdown_on_panic`
255+
|`false`
256+
|`true`
257+
258+
|===
259+
260+
261+
=== Changed valid values of configuration settings
262+
263+
The `server.logs.config` is changed to depend on the provided path for the _conf_ directory instead of having the _conf_ directory encoded in the default values.
264+
265+
[options=header, cols="2m,3,3"]
266+
|===
267+
| Name
268+
| Old valid value
269+
| New valid value
270+
271+
|`server.logs.config`
272+
|A path. If relative, it is resolved from `server.directories.neo4j_home`.
273+
|A path. If relative, it is resolved from `server.directories.configuration`.
274+
|===
275+
276+
=== Renamed configuration settings
277+
278+
`dbms.cluster.discovery.endpoints` => `dbms.cluster.endpoints`
279+
280+
`dbms.kubernetes.service_port_name` => `dbms.kubernetes.discovery.service_port_name`
281+
282+
[role=label--enterprise]
283+
=== Renamed metric
284+
285+
In Neo4j 2025.01, the `<prefix>.store.size.total` is renamed to `<prefix>.store.size.full` to be in line with the .
286+
See the table xref:monitoring/metrics/reference.adoc#db-store-size-metrics[Database store size metrics] for more details.
287+
288+
289+

modules/ROOT/pages/clustering/servers.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
:description: This section describes how to manage servers in a cluster.
2+
:page-role: enterprise-edition
3+
24
[[manage-servers]]
35
= Managing servers in a cluster
46

57
As described previously, server-management is completely separate from database-management in a clustered environment.
68
This section describes how to work with servers in a cluster: adding and removing them, as well as altering their metadata.
79

8-
910
[[server-states]]
1011
== Server states
12+
1113
A server can exist in five different states within the DBMS:
1214

1315

0 commit comments

Comments
 (0)