Skip to content

Commit 4df27ca

Browse files
authored
Document max-off-heap-memory and the deprecation of --pagecache (#2263)
1 parent 42dc21c commit 4df27ca

File tree

2 files changed

+38
-8
lines changed

2 files changed

+38
-8
lines changed

modules/ROOT/pages/changes-deprecations-removals.adoc

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ However, it is recommended to update your _neo4j.conf_ file to use the new setti
3737
| Old name
3838
| New name
3939

40-
|`dbms.cluster.discovery.v2.endpoints`
40+
|`dbms.cluster.discovery.v2.endpoints`
4141
|`dbms.cluster.endpoints`
4242

4343
|`dbms.kubernetes.discovery.v2.service_port_name`
@@ -258,7 +258,7 @@ The `server.logs.config` and the `server.logs.user.config` are changed to depend
258258
<prefix>.causal_clustering.core.replication_fail +
259259
<prefix>.causal_clustering.core.replication_maybe +
260260
<prefix>.causal_clustering.core.replication_success +
261-
<prefix>.causal_clustering.core.last_leader_message
261+
<prefix>.causal_clustering.core.last_leader_message
262262
263263
|**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]**
264264
@@ -279,7 +279,7 @@ The `server.logs.config` and the `server.logs.user.config` are changed to depend
279279

280280

281281
[role=label--enterprise]
282-
==== Renamed metrics
282+
==== Renamed metrics
283283

284284
In Neo4j 2025.01, the `<prefix>.store.size.total` is renamed to `<prefix>.store.size.full` to be in line with the Prometheus naming requirements.
285285

@@ -386,7 +386,7 @@ For deprecations in Cypher language, see link:https://neo4j.com/docs/cypher-manu
386386
| Enterprise Edition
387387
| Comment
388388
389-
| xref:procedures.adoc#procedure_dbms_cluster_recreateDatabase[`dbms.cluster.recreateDatabase()`]
389+
| xref:procedures.adoc#procedure_dbms_cluster_recreateDatabase[`dbms.cluster.recreateDatabase()`]
390390
|
391391
| {check-mark}
392392
| label:deprecated[Deprecated in 2025.04] +
@@ -532,6 +532,21 @@ Replaced by xref:backup-restore/aggregate.adoc[`neo4j-admin backup aggregate`]
532532
|===
533533
====
534534

535+
.See all deprecated command options
536+
[%collapsible]
537+
====
538+
[options=header, cols="3m,2,3"]
539+
|===
540+
| Command
541+
| Option
542+
| Comment
543+
544+
| link:{neo4j-docs-base-uri}/operations-manual/current/database-administration/standard-databases/migrate-database[`neo4-admin database migrate`]
545+
| `--page-cache` label:deprecated[Deprecated in 2025.04]
546+
| The option is deprecated and replaced by the `--max-off-heap-memory` option.
547+
|===
548+
====
549+
535550
=== Seed providers
536551

537552
`S3SeedProvider` is deprecated since Neo4j 5.26 and replaced by the `CloudSeedProvider`.

modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ The `neo4j-admin database migrate` has the following syntax:
1919
----
2020
neo4j-admin database migrate [-h] [--expand-commands]
2121
[--force-btree-indexes-to-range]
22-
[--verbose]
23-
[--additional-config=<file>] [--pagecache=<size>]
22+
[--verbose] [--additional-config=<file>]
23+
[--max-off-heap-memory=<size>] [--pagecache=<size>]
2424
[--to-format=standard|high_limit|aligned|block] <database>
2525
----
2626

@@ -46,36 +46,51 @@ The `neo4j-admin database migrate` command is run only on a stopped database.
4646
The `neo4j-admin database migrate` command has the following options:
4747

4848
.`neo4j-admin database migrate` options
49-
[options="header", cols="5m,6a"]
49+
[options="header", cols="5m,6a,1m"]
5050
|===
5151
| Option
5252
| Description
53+
| Default
5354

5455
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
5556
|Configuration file with additional configuration.
57+
|
5658

5759
|--expand-commands
5860
|Allow command expansion in config value evaluation.
61+
|
5962

6063
|--force-btree-indexes-to-range
6164
|Special option for automatically turning all BTREE indexes/constraints into RANGE. Be aware that RANGE indexes are not always the optimal replacement of BTREEs and performance may be affected while the new indexes are populated.
6265
See the Neo4j v5 migration guide online for more information.
6366
The newly created indexes will be populated in the background on the first database start up following the migration and users should monitor the successful completion of that process.
6467
[NOTE]
6568
This option is only relevant when migrating from Neo4j 4.4.
69+
|
70+
6671
|-h, --help
6772
|Show this help message and exit.
73+
|
74+
75+
|--max-off-heap-memory=<size> label:new[Introduced in Neo4j 2025.04]
76+
|Maximum memory that neo4j-admin can use for various data structures and caching to improve performance.
77+
Values can be plain numbers, such as 10000000, or 20G for 20 gigabytes.
78+
It can also be specified as a percentage of the available memory, for example 70%.
79+
|90%
6880

69-
|--pagecache=<size>
81+
|--pagecache=<size> label:deprecated[Deprecated in Neo4j 2025.04]
7082
|The size of the page cache to use for the migration process. The general rule is that values up to the size of the database proportionally increase performance.
83+
|
7184

7285
|--to-format=standard\|high_limit\|aligned\|block
7386
|Name of the format to migrate the store to.
7487
If the format is specified, the target database is migrated to the latest known combination of `MAJOR` and `MINOR` versions of the specified format.
7588
If not specified, the tool migrates the target database to the latest known combination of `MAJOR` and `MINOR` versions of the current format.
89+
|
7690

7791
|--verbose
7892
|Enable verbose output.
93+
|
7994
|===
8095

8196
[NOTE]

0 commit comments

Comments
 (0)