Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
25e4427
Update to 2025.07 (#2464)
NataliaIvakina Jul 2, 2025
e507b34
Add new metric message_processing_timer (#2437)
RagnarW Jul 3, 2025
78224e0
Update configuration settings for 2025.07 (#2460)
NataliaIvakina Jul 3, 2025
e8522d5
fix a few broken links (#2466)
renetapopova Jul 4, 2025
9a20db8
Allow multiple :START_ID/:END_ID columns in CSV input for importer (#…
sherfert Jul 9, 2025
c392de5
update the checkpoint messages (#2468)
renetapopova Jul 9, 2025
fa28fdd
Improve enabling command expansion section (#2470)
renetapopova Jul 9, 2025
bc22295
Update the Set up the repository for Linux rpm (#2475)
renetapopova Jul 11, 2025
4ee8e93
Remove Nodes 25 banner
lidiazuin Jul 14, 2025
89f9076
Remove --show-metadata from neo4j-admin backup inspect (#2480)
renetapopova Jul 15, 2025
db79312
Fix the helm install backup-name neo4j/neo4j-admin command (#2469)
renetapopova Jul 15, 2025
afb1336
Fix a typo in one of the shell commands in Access the Neo4j cluster f…
renetapopova Jul 15, 2025
e6cd341
Remove against the system database from Handy tips (#2478)
renetapopova Jul 16, 2025
7e2472c
Clarify version for parquet header support. (#2489)
meistermeier Jul 18, 2025
c8e97aa
Update Kubernetes oprations manual for backups (#2462)
bfeshti Jul 18, 2025
968734b
Restyle RBAC limitations and warn about use of fail-open DENY semanti…
renetapopova Jul 21, 2025
f01eb32
Server tags are not used during database allocation (#2499)
jackwaudby Jul 23, 2025
e776432
Fix the restore metadata paths (#2498)
renetapopova Jul 23, 2025
ddeab82
`DEALLOCATING` is an irreversible server state (#2500)
jackwaudby Jul 25, 2025
5597e39
Remove externalService and add services.neo4j.spec.loadBalancerIP (#2…
renetapopova Jul 25, 2025
dcf808d
Improve the table formatting (#2453) (#2510)
NataliaIvakina Jul 30, 2025
e6bfc0e
Update to 2025.08 (#2514)
NataliaIvakina Jul 31, 2025
1e91ab0
Update the metric in the cluster endpoint description (#2516)
NataliaIvakina Aug 1, 2025
afc8c6a
Clarify that consistency check is not supported for diff backups (#2515)
NataliaIvakina Aug 4, 2025
22324cf
Clarify seed from a URI that dumps can also be used as seeds (#2509)
renetapopova Aug 4, 2025
2cd1738
Use v2 workflows rc-1 (#2528)
recrwplay Aug 13, 2025
b6e04e9
Add cypher-5 and cypher-25 role labels (#2527)
renetapopova Aug 13, 2025
0595063
remove 'open a support ticket' requirement with neo4j-admin database …
fiquick Aug 13, 2025
fbf7179
Fixes the rendering of some pages (#2532)
renetapopova Aug 13, 2025
5fa926d
Document throughput based checkpoint limiter (#2535)
renetapopova Aug 14, 2025
3e14389
First batch of refreshed images (#2525)
lidiazuin Aug 15, 2025
6b3aea3
Add documentation for the alter database privileges on database level…
Hunterness Aug 19, 2025
495aa87
Update the description of the history option (#2543)
NataliaIvakina Aug 19, 2025
2f3b2ca
Add tabbed examples for multiple node IDs (#2512)
NataliaIvakina Aug 20, 2025
53edba8
Document the configuration settings introduced for the Unix Domain So…
renetapopova Aug 21, 2025
8fc0f47
Fix the broken links (#2538)
renetapopova Aug 27, 2025
f82603a
Fix broken links (#2548)
NataliaIvakina Aug 27, 2025
5b4c8d7
Clarify backup/restore strategy regarding system db (#2521)
NataliaIvakina Aug 28, 2025
7613a00
Fix the name of `neo4j-admin server unbind` cmd (#2558)
NataliaIvakina Sep 1, 2025
ccdf037
Update the Neo4j version to 2025.09 (#2564)
NataliaIvakina Sep 2, 2025
d79cd5d
Add missing property in the YAML file examples (#2557)
NataliaIvakina Sep 3, 2025
8012b25
Update links to the Browser docs (#2556)
NataliaIvakina Sep 3, 2025
5383969
Remove problematic part from `unbind` docs (#2570)
gfx54b Sep 5, 2025
8b25ec9
Clarify using of the `ALTER SERVER` options (#2551)
NataliaIvakina Sep 8, 2025
a0b3a06
Update docs to clarify that `IF NOT EXISTS` check for both databases …
Hunterness Sep 9, 2025
70a298a
Workflows v2 (#2542)
recrwplay Sep 9, 2025
0f0ce11
Refine filesystem requirements (#2578)
NataliaIvakina Sep 9, 2025
1eecf54
Render example URI as code instead of link (#2582)
NataliaIvakina Sep 10, 2025
657fc5e
Updated diagram for Kubernetes (#2546)
lidiazuin Sep 10, 2025
c9e57f9
Add a new guide on deploying multi-region cluster (#2559)
NataliaIvakina Sep 11, 2025
155504c
Re-uploading corrupted image that is broken on website (#2591)
lidiazuin Sep 11, 2025
3406f4a
Add the NODES 25 register promo (#2593)
recrwplay Sep 11, 2025
a125b1c
Update page-ad-image URI format in publish.yml (#2594)
recrwplay Sep 11, 2025
d8d6f9f
Fix the code example in the restore backup section (#2595)
NataliaIvakina Sep 12, 2025
eb96fc7
Trigger publish from multiple branches (#2598)
recrwplay Sep 13, 2025
ccc9fee
Render an example link as code (#2599)
NataliaIvakina Sep 16, 2025
0246389
Restore page-aliases for the pages on neo4j-admin cmds (#2600)
NataliaIvakina Sep 16, 2025
7aa9c3b
Remove the page on deploying cluster across AKS clusters (#2547)
NataliaIvakina Sep 16, 2025
93ce118
Document how to recover unrecovered full backup (#2601)
NataliaIvakina Sep 17, 2025
b1f5421
run consistency check against a specific full backup when many fulls …
renetapopova Sep 18, 2025
21ecf7e
Document `--remote-address-resolution` (#2584)
NataliaIvakina Sep 19, 2025
d638f13
Fixing color of text to match the other nodes (#2614)
lidiazuin Sep 22, 2025
f0ca7ea
Correct inaccuracy about horizontal scaling in Neo4j (#2613)
NataliaIvakina Sep 23, 2025
7cbcba8
Improve docs for macOS installation (#2497)
renetapopova Sep 25, 2025
b4a5f48
Fix some typos in the configuration settings and update one descripti…
renetapopova Sep 25, 2025
6092876
Publish 2025.09 release
NataliaIvakina Sep 29, 2025
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
12 changes: 6 additions & 6 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -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@'
9 changes: 6 additions & 3 deletions modules/ROOT/pages/backup-restore/consistency-checker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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>
|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=<path>
Expand Down Expand Up @@ -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=<directory-with-backup-or-dump> neo4j
bin/neo4j-admin database check --from-path=<path-to-backup-or-dump> neo4j
----

[[check-database-from-cloud-uris]]
Expand Down
23 changes: 22 additions & 1 deletion modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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=<file>]
[--parallel-recovery[=true|false]] [--remote-address-resolution
[=true|false]] [--additional-config=<file>]
[--include-metadata=none|all|users|roles] [--inspect-path=<path>]
[--pagecache=<size>] [--temp-path=<path>] [--to-path=<path>]
[--type=<type>] [--from=<host:port>[,<host:port>...]]... [<database>...]
Expand Down Expand Up @@ -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=<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 @@ -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

Expand Down
3 changes: 3 additions & 0 deletions modules/ROOT/pages/backup-restore/planning.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,9 @@ Backing up a database in a clustered environment is not essentially different fr
Use `SHOW DATABASE <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].
Expand Down