Skip to content

Document the option to change backup memory settings via --additional-config (#2747) #2753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2025
+11 −6
Merged

Document the option to change backup memory settings via --additional-config (#2747) #2753

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,17 +264,22 @@ This needs to be changed if backups are to be taken from another machine.
[[online-backup-memory]]
=== Memory configuration

The following options are available for configuring the memory allocated to the backup client:

* Configure heap size for the backup::
You can configure the memory allocated to the backup client in several ways:

* Configure heap size:
+
`HEAP_SIZE` configures the maximum heap size allocated for the backup process.
This is done by setting the environment variable `HEAP_SIZE` before starting the operation.
Define the variable `HEAP_SIZE` before starting the operation.
If not specified, the Java Virtual Machine chooses a value based on the server resources.

* Configure page cache for the backup::
* Configure page cache:
+
Set the page cache size with the `--pagecache` option of the `neo4j-admin database backup` command.

* Override the memory settings:
+
Use the `--additional-config` option of the `neo4j-admin database backup` command to override the memory configurations in the _neo4j.conf_ file.

The page cache size can be configured by using the `--pagecache` option of the `neo4j-admin database backup` command.

[TIP]
====
Expand Down