Skip to content
Open
Changes from all commits
Commits
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
32 changes: 27 additions & 5 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,15 @@ For more information, see xref:backup-restore/online-backup.adoc#online-backup-c

[source,role=noheader]
----
neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [--verbose] [--compress[=true|false]]
[--keep-failed[=true|false]] [--parallel-recovery[=true|false]] [--remote-address-resolution
[=true|false]] [--additional-config=<file>] [--include-metadata=none|all|users[=user1,user2]
|roles] [--inspect-path=<path>] [--pagecache=<size>] [--temp-path=<path>]
[--to-path=<path>] [--type=<type>] [--from=<host:port>[,<host:port>...]]... [<database>...]
neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [--verbose]
[--compress[=true|false]] [--keep-failed[=true|false]]
[--parallel-download[=true|false]] [--parallel-recovery[=true|false]]
[--remote-address-resolution[=true|false]] [--skip-recovery
[=true|false]] [--additional-config=<file>]
[--include-metadata=none|all|users[=user1,user2]|roles]
[--inspect-path=<path>] [--pagecache=<size>] [--temp-path=<path>]
[--to-path=<path>] [--type=<type>] [--from=<host:port>[,<host:
port>...]]... [<database>...]
----

=== Description
Expand Down Expand Up @@ -154,6 +158,10 @@ It is recommended to use `SHOW USERS`, `SHOW ROLES`, and `SHOW ROLE $role PRIVIL
|The size of the page cache to use for the backup process.
|

|--parallel-download[=true\|false]
|label:new[Introduced in 2025.11] Download backup data from multiple Neo4j instances in parallel.
|false

|--parallel-recovery[=true\|false]
| Allow multiple threads to apply pulled transactions to a backup in parallel. For some databases and workloads, this may reduce backup times significantly.
Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
Expand All @@ -167,6 +175,11 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
|label:new[Introduced in 2025.09] Allow the DBMS to automatically determine which servers are eligible to serve as backup sources, instead of requiring manual selection.
|false

|--skip-recovery[=true\|false]
|label:new[Introduced in 2025.11] Skip recovery as part of the full backup. Skipping recovery might result in faster backups,
but recovery will have to be done during restore time.
|true

|--temp-path=<path>
|Provide a path to a temporary empty directory for storing backup files until the command is completed. The files will be deleted once the command is finished.
|
Expand Down Expand Up @@ -380,6 +393,15 @@ The server selection occurs in the following order:
* The DBMS first selects all servers hosting the database in secondary mode.
* If it is not possible to back up from one of the secondaries, the DBMS attempts to take a backup from the primary followers before finally trying the database primary writer.

[role=label--new-2025.11]
==== Using `--parallel-download`

Starting from 2025.11, the `--parallel-download` option is available.
When enabled, the backup process will pull data from multiple instances which have been either defined in the
--from or determined from --remote-address-resolution.

Note that this will speed up the backup process if there are enough throughput provisioned in both the
backup process and the instances from which data is being pulled from.

[[online-backup-example]]
== Examples
Expand Down