Skip to content

Clarify that consistency check is not supported for diff backups #2515

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
Aug 4, 2025
Merged

Clarify that consistency check is not supported for diff backups #2515

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
14 changes: 10 additions & 4 deletions modules/ROOT/pages/backup-restore/consistency-checker.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[consistency-checker]]
= Check database consistency

You can use the `neo4j-admin database check` command to check the consistency of a database, a dump, or a backup.
You can use the `neo4j-admin database check` command to check the consistency of a database, a dump, or a full backup.
The `neo4j-admin` tool is located in the _/bin_ directory.

== Syntax
Expand All @@ -22,15 +22,15 @@ neo4j-admin database check [-h] [--expand-commands] [--force] [--verbose]

=== Description

This command allows for checking the consistency of a database, a dump, or a backup.
This command allows for checking the consistency of a database, a dump, or a full backup.
It cannot be used with a database that is currently in use.

Some checks can be quite expensive, so it may be useful to turn some of them off for very large databases.
Increasing the heap size might be a good idea.

[NOTE]
====
It is not recommended to use an NFS to check the consistency of a database, a dump, or a backup as this slows the process down significantly.
It is not recommended to use an NFS to check the consistency of a database, a dump, or a full backup as this slows the process down significantly.
====

=== Parameters
Expand Down Expand Up @@ -199,6 +199,12 @@ Consistency check

=== Check the consistency of a backup/dump

[NOTE]
====
Note that consistency check is not supported for differential backups.
The backup chain must be aggregated into a full backup artifact before running consistency check.
====

Run with the `--from-path` option to check the consistency of a backup or a dump:

[source,shell]
Expand All @@ -209,7 +215,7 @@ bin/neo4j-admin database check --from-path=<directory-with-backup-or-dump> neo4j
[[check-database-from-cloud-uris]]
=== Check the consistency of a backup/dump stored in a cloud storage

The following examples show how to check the consistency of a backup or a dump stored in a cloud storage bucket using the `--from-path` option.
The following examples show how to check the consistency of a full backup or a dump stored in a cloud storage bucket using the `--from-path` option.

[.tabbed-example]
=====
Expand Down