diff --git a/antora.yml b/antora.yml index a1ad7d02b..062fbe766 100644 --- a/antora.yml +++ b/antora.yml @@ -1,14 +1,14 @@ name: operations-manual title: Operations Manual -version: '2025.08' +version: '2025.09' current: true start_page: ROOT:index.adoc nav: - modules/ROOT/content-nav.adoc asciidoc: attributes: - neo4j-version: '2025.08' - neo4j-version-minor: '2025.08' - neo4j-version-exact: '2025.08.0' - neo4j-buildnumber: '2025.08' - neo4j-debian-package-version: '1:2025.08.0@' + neo4j-version: '2025.09' + neo4j-version-minor: '2025.09' + neo4j-version-exact: '2025.09.0' + neo4j-buildnumber: '2025.09' + neo4j-debian-package-version: '1:2025.09.0@' diff --git a/modules/ROOT/pages/backup-restore/consistency-checker.adoc b/modules/ROOT/pages/backup-restore/consistency-checker.adoc index 5e55e2d30..9a0983db7 100644 --- a/modules/ROOT/pages/backup-restore/consistency-checker.adoc +++ b/modules/ROOT/pages/backup-restore/consistency-checker.adoc @@ -115,7 +115,7 @@ Value can be plain numbers, like `10000000` or e.g. `20G` for 20 gigabytes, or e | xref:configuration/configuration-settings.adoc#config_server.directories.transaction.logs.root[`server.directories.transaction.logs.root`] |--from-path= -|Path to the directory containing dump/backup artifacts that need to be checked for consistency. If the directory contains multiple backups, it will select the most recent backup chain, based on the transaction IDs found, to perform the consistency check. +|label:changed[Changed in 2025.09] Path to a backup file or a directory containing dump/backup artifacts. If the path is to a single file, that artifact is selected and checked for consistency. If a directory is provided, the tool selects the most recent backup chain (based on transaction IDs) within it and checks that chain for consistency. | |--temp-path= @@ -208,11 +208,14 @@ The backup chain must be aggregated into a full recovered backup artifact before See xref:backup-restore/aggregate.adoc[] for more details. ==== -Run with the `--from-path` option to check the consistency of a backup or a dump: + +Run with the `--from-path` option to check the consistency of a backup or a dump. + +Starting with Neo4j 2025.09, the option accepts a path to a specific backup or dump file you want to be checked for consistency. +If only the directory is provided, the most recent backup chain (based on transaction IDs) within that directory will be checked. [source,shell] ---- -bin/neo4j-admin database check --from-path= neo4j +bin/neo4j-admin database check --from-path= neo4j ---- [[check-database-from-cloud-uris]] diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index e8eb175e7..995d65cc7 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -66,7 +66,8 @@ For more information, see xref:backup-restore/online-backup.adoc#online-backup-c ---- neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [--verbose] [--compress[=true|false]] [--keep-failed[=true|false]] - [--parallel-recovery[=true|false]] [--additional-config=] + [--parallel-recovery[=true|false]] [--remote-address-resolution + [=true|false]] [--additional-config=] [--include-metadata=none|all|users|roles] [--inspect-path=] [--pagecache=] [--temp-path=] [--to-path=] [--type=] [--from=[,...]]... [...] @@ -164,6 +165,10 @@ Note: this is an EXPERIMENTAL option. Consult Neo4j support before use. |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. |false +|--remote-address-resolution[=true\|false] +|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 + |--temp-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. | @@ -358,10 +363,26 @@ To view the latest processed transaction IDs (and other metrics) in Neo4j Browse ==== ==== Targeting multiple servers + 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. 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. If a name pattern is used for the database together with multiple target servers, all servers contribute to the list of matching databases. +[role=label--new-2025.09] +==== Using `--remote-address-resolution` + +Starting from 2025.09, the `--remote-address-resolution` option is available. +When enabled, the DBMS automatically selects the most appropriate servers to act as backup sources for a given database. + +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. +With remote address resolution enabled, the DBMS performs this mapping automatically, removing the need for manual server selection. + +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. + + [[online-backup-example]] == Examples diff --git a/modules/ROOT/pages/backup-restore/planning.adoc b/modules/ROOT/pages/backup-restore/planning.adoc index d7ad162bb..bb05e236b 100644 --- a/modules/ROOT/pages/backup-restore/planning.adoc +++ b/modules/ROOT/pages/backup-restore/planning.adoc @@ -183,6 +183,9 @@ Backing up a database in a clustered environment is not essentially different fr Use `SHOW DATABASE ` to learn which servers are hosting the database you want to back up. See xref:clustering/monitoring/show-databases-monitoring.adoc#show-databases-monitoring-listing-single[Listing a single database] for more information. +Starting from 2025.09, you can use the `--remote-address-resolution` option to let the DBMS select which servers to use as backup sources. +See xref:backup-restore/online-backup.adoc#_using_remote_address_resolution[Back up an online database -> Cluster configurations] for more details. + Restoring from the command line involves putting a copy of the database on disk on each server that will need it. That can be awkward to achieve. The recommended way to restore a database in a cluster is to xref::database-administration/standard-databases/seed-from-uri.adoc[seed from URI].