You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add missing options of the copy and incremental import commands (neo4j#2068)
Document changes for the 2025.01 release:
* new option of the copy command
* new option of the incremental import command
The `neo4j-admin database restore` command will be updated in the
2025.02 release.
@@ -123,13 +124,6 @@ The indexes will be built the first time the database is started.
123
124
|Force the command to run even if the integrity of the database cannot be verified.
124
125
|
125
126
126
-
|--from-pagecache=<size>
127
-
|The size of the page cache to use for reading.
128
-
[TIP]
129
-
You can use the `--from-pagecache` option to speed up the copy operation by specifying how much cache to allocate when reading the source.
130
-
The `--from-pagecache` should be assigned whatever memory you can spare since Neo4j does random reads from the source.
131
-
|8m
132
-
133
127
|--from-path-data=<path>
134
128
|Path to the databases directory, containing the database directory to source from.
135
129
It can be used to target databases outside of the installation.
@@ -155,6 +149,12 @@ relationship types will not be included in the copy.
155
149
Cannot be combined with `--copy-only-relationships-with-types`.
156
150
|
157
151
152
+
|--from-pagecache, --max-off-heap-memory=<size>
153
+
|label:new[Introduced in 2025.01] Maximum memory that neo4j-admin can use for various data structures and caching to improve performance.
154
+
Values can be plain numbers, such as 10000000, or 20G for 20 gigabytes.
155
+
It can also be specified as a percentage of the available memory, for example 70%.
156
+
|90%
157
+
158
158
|--skip-labels=<label>[,<label>...]
159
159
|A comma-separated list of labels to ignore.
160
160
|
@@ -210,6 +210,18 @@ The block format is the default format for all newly-created databases as long a
210
210
For more information on the block format, see xref:database-internals/store-formats.adoc[Store formats].
211
211
====
212
212
213
+
[NOTE]
214
+
====
215
+
Neo4j 2025.01 introduces a dual-named option `--from-pagecache, --max-off-heap-memory=<size>`, which enhances the functionality of the `--from-pagecache=<size>` option.
216
+
217
+
The new option determines the maximum amount of off-heap memory available during the copy process for reading and writing, instead of specifying how much cache to allocate when reading the source.
218
+
219
+
For details, see <<off-heap-memory-control,Improving the performance>>.
220
+
221
+
Note that the `--from-pagecache` option may be removed in future versions.
222
+
====
223
+
224
+
213
225
[[copy-database-examples]]
214
226
== Examples
215
227
@@ -363,3 +375,29 @@ Therefore, with an additional 144 GB of both read and write, the best-case scena
363
375
364
376
Finally, it is also important to consider that in almost all Cloud environments, the published IOPS value may not be the same as the actual value, or be able to continuously maintain the maximum possible IOPS.
365
377
The real processing time for this example _could_ be well above that estimation of 3 hours.
378
+
379
+
[[off-heap-memory-control]]
380
+
=== Improving the performance
381
+
382
+
You can improve the performance of the copy process by specifying the memory limit.
383
+
Neo4j 2025.01 introduces an option `--from-pagecache, --max-off-heap-memory=<size>` to replace the old `--from-pagecache=<size>` option.
384
+
385
+
The new option controls how much off-heap memory the copy process may use in addition to the heap size the JVM is given.
386
+
Values can be plain numbers, such as 10000000, or 20G for 20 gigabytes.
387
+
It can also be specified as a percentage of the available memory, for example 70%.
388
+
389
+
Starting from 2025.01, to configure the off-heap memory value, you can use either the old name `--from-pagecache=<size>` or the new one `--max-off-heap-memory=<size>`.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/changes-deprecations-removals.adoc
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -529,4 +529,20 @@ Replaced by xref:backup-restore/aggregate.adoc[`neo4j-admin backup aggregate`]
529
529
For more information, see xref:clustering/databases.adoc#s3-seed-provider[Seed from URI].
530
530
531
531
532
+
== Changes in Neo4j 2025.x
533
+
534
+
The section covers changes to Neo4j server functionality across different areas.
535
+
536
+
=== Neo4j-admin tool
537
+
538
+
Neo4j 2025.01::
539
+
540
+
* The `neo4j-admin database copy` command.
541
+
+
542
+
The functionality of the `--from-pagecache=<size>` option is changed. +
543
+
Instead of specifying how much cache to allocate when reading the source, now you can control the maximum amount of off-heap memory used for the copy operation, both for reading and writing.
544
+
By configuring the off-heap memory value, you can impact the cache allocation as well. +
545
+
To reflect this change, a new name was added to the option: `--max-off-heap-memory=<size>`.
546
+
+
547
+
For details, refer to the xref:backup-restore/copy-database.adoc#off-heap-memory-control[Improving the performance].
@@ -878,6 +879,10 @@ performance, this value should not be greater than the number of available proce
878
879
|Whether or not strings should be trimmed for whitespaces.
879
880
|false
880
881
882
+
|--update-all-matching-relationships
883
+
|label:new[Introduced in 2025.01] If one relationship data entry matches multiple existing relationships, this decides whether to update all matching, or to instead log as error.
0 commit comments