Skip to content

Commit 21ecf7e

Browse files
Document --remote-address-resolution (#2584)
1 parent b1f5421 commit 21ecf7e

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

modules/ROOT/pages/backup-restore/online-backup.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ For more information, see xref:backup-restore/online-backup.adoc#online-backup-c
6666
----
6767
neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [--verbose]
6868
[--compress[=true|false]] [--keep-failed[=true|false]]
69-
[--parallel-recovery[=true|false]] [--additional-config=<file>]
69+
[--parallel-recovery[=true|false]] [--remote-address-resolution
70+
[=true|false]] [--additional-config=<file>]
7071
[--include-metadata=none|all|users|roles] [--inspect-path=<path>]
7172
[--pagecache=<size>] [--temp-path=<path>] [--to-path=<path>]
7273
[--type=<type>] [--from=<host:port>[,<host:port>...]]... [<database>...]
@@ -164,6 +165,10 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
164165
|label:new[Introduced in 2025.04] When performing a differential backup, prefer the latest non-empty differential backup as the parent instead of the latest backup.
165166
|false
166167

168+
|--remote-address-resolution[=true\|false]
169+
|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.
170+
|false
171+
167172
|--temp-path=<path>
168173
|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.
169174
|
@@ -358,10 +363,26 @@ To view the latest processed transaction IDs (and other metrics) in Neo4j Browse
358363
====
359364

360365
==== Targeting multiple servers
366+
361367
It is recommended to provide a list of multiple target servers when taking a backup from a cluster, since that may allow a backup to succeed even if some server is down, or not all databases are hosted on the same servers.
362368
If the command finds one or more servers that do not respond, it continues trying to backup from other servers and continues backing up other requested databases, but the exit code of the command is non-zero, to alert the user to the fact there is a problem.
363369
If a name pattern is used for the database together with multiple target servers, all servers contribute to the list of matching databases.
364370

371+
[role=label--new-2025.09]
372+
==== Using `--remote-address-resolution`
373+
374+
Starting from 2025.09, the `--remote-address-resolution` option is available.
375+
When enabled, the DBMS automatically selects the most appropriate servers to act as backup sources for a given database.
376+
377+
By default, the online backup command requires the user to determine which servers host the target database and direct the command to one of them.
378+
With remote address resolution enabled, the DBMS performs this mapping automatically, removing the need for manual server selection.
379+
380+
The server selection occurs in the following order:
381+
382+
* The DBMS first selects all servers hosting the database in secondary mode.
383+
* 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.
384+
385+
365386
[[online-backup-example]]
366387
== Examples
367388

modules/ROOT/pages/backup-restore/planning.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,9 @@ Backing up a database in a clustered environment is not essentially different fr
183183
Use `SHOW DATABASE <database>` to learn which servers are hosting the database you want to back up.
184184
See xref:clustering/monitoring/show-databases-monitoring.adoc#show-databases-monitoring-listing-single[Listing a single database] for more information.
185185

186+
Starting from 2025.09, you can use the `--remote-address-resolution` option to let the DBMS select which servers to use as backup sources.
187+
See xref:backup-restore/online-backup.adoc#_using_remote_address_resolution[Back up an online database -> Cluster configurations] for more details.
188+
186189
Restoring from the command line involves putting a copy of the database on disk on each server that will need it.
187190
That can be awkward to achieve.
188191
The recommended way to restore a database in a cluster is to xref::database-administration/standard-databases/seed-from-uri.adoc[seed from URI].

0 commit comments

Comments
 (0)