From d74e80a27594446733c8262a517cd0ffd7a9b9c5 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 15 Apr 2025 11:03:44 +0100 Subject: [PATCH] Document max-off-heap-memory and the deprecation of --pagecache --- .../pages/changes-deprecations-removals.adoc | 23 +++++++++++++++---- .../standard-databases/migrate-database.adoc | 23 +++++++++++++++---- 2 files changed, 38 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/changes-deprecations-removals.adoc b/modules/ROOT/pages/changes-deprecations-removals.adoc index dea9e0f20..2d37ff323 100644 --- a/modules/ROOT/pages/changes-deprecations-removals.adoc +++ b/modules/ROOT/pages/changes-deprecations-removals.adoc @@ -37,7 +37,7 @@ However, it is recommended to update your _neo4j.conf_ file to use the new setti | Old name | New name -|`dbms.cluster.discovery.v2.endpoints` +|`dbms.cluster.discovery.v2.endpoints` |`dbms.cluster.endpoints` |`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 .causal_clustering.core.replication_fail + .causal_clustering.core.replication_maybe + .causal_clustering.core.replication_success + -.causal_clustering.core.last_leader_message +.causal_clustering.core.last_leader_message |**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]** @@ -279,7 +279,7 @@ The `server.logs.config` and the `server.logs.user.config` are changed to depend [role=label--enterprise] -==== Renamed metrics +==== Renamed metrics In Neo4j 2025.01, the `.store.size.total` is renamed to `.store.size.full` to be in line with the Prometheus naming requirements. @@ -386,7 +386,7 @@ For deprecations in Cypher language, see link:https://neo4j.com/docs/cypher-manu | Enterprise Edition | Comment -| xref:procedures.adoc#procedure_dbms_cluster_recreateDatabase[`dbms.cluster.recreateDatabase()`] +| xref:procedures.adoc#procedure_dbms_cluster_recreateDatabase[`dbms.cluster.recreateDatabase()`] | | {check-mark} | label:deprecated[Deprecated in 2025.04] + @@ -532,6 +532,21 @@ Replaced by xref:backup-restore/aggregate.adoc[`neo4j-admin backup aggregate`] |=== ==== +.See all deprecated command options +[%collapsible] +==== +[options=header, cols="3m,2,3"] +|=== +| Command +| Option +| Comment + +| link:{neo4j-docs-base-uri}/operations-manual/current/database-administration/standard-databases/migrate-database[`neo4-admin database migrate`] +| `--page-cache` label:deprecated[Deprecated in 2025.04] +| The option is deprecated and replaced by the `--max-off-heap-memory` option. +|=== +==== + === Seed providers `S3SeedProvider` is deprecated since Neo4j 5.26 and replaced by the `CloudSeedProvider`. diff --git a/modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc b/modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc index b3752aadb..bf0386a85 100644 --- a/modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc +++ b/modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc @@ -19,8 +19,8 @@ The `neo4j-admin database migrate` has the following syntax: ---- neo4j-admin database migrate [-h] [--expand-commands] [--force-btree-indexes-to-range] - [--verbose] - [--additional-config=] [--pagecache=] + [--verbose] [--additional-config=] + [--max-off-heap-memory=] [--pagecache=] [--to-format=standard|high_limit|aligned|block] ---- @@ -46,16 +46,19 @@ The `neo4j-admin database migrate` command is run only on a stopped database. The `neo4j-admin database migrate` command has the following options: .`neo4j-admin database migrate` options -[options="header", cols="5m,6a"] +[options="header", cols="5m,6a,1m"] |=== | Option | Description +| Default |--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. +| |--expand-commands |Allow command expansion in config value evaluation. +| |--force-btree-indexes-to-range |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. @@ -63,19 +66,31 @@ See the Neo4j v5 migration guide online for more information. 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. [NOTE] This option is only relevant when migrating from Neo4j 4.4. +| + |-h, --help |Show this help message and exit. +| + +|--max-off-heap-memory= label:new[Introduced in Neo4j 2025.04] +|Maximum memory that neo4j-admin can use for various data structures and caching to improve performance. +Values can be plain numbers, such as 10000000, or 20G for 20 gigabytes. +It can also be specified as a percentage of the available memory, for example 70%. +|90% -|--pagecache= +|--pagecache= label:deprecated[Deprecated in Neo4j 2025.04] |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. +| |--to-format=standard\|high_limit\|aligned\|block |Name of the format to migrate the store to. If the format is specified, the target database is migrated to the latest known combination of `MAJOR` and `MINOR` versions of the specified format. If not specified, the tool migrates the target database to the latest known combination of `MAJOR` and `MINOR` versions of the current format. +| |--verbose |Enable verbose output. +| |=== [NOTE]