diff --git a/modules/ROOT/pages/backup-restore/consistency-checker.adoc b/modules/ROOT/pages/backup-restore/consistency-checker.adoc index 48f511431..9a7249480 100644 --- a/modules/ROOT/pages/backup-restore/consistency-checker.adoc +++ b/modules/ROOT/pages/backup-restore/consistency-checker.adoc @@ -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 @@ -22,7 +22,7 @@ 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. @@ -30,7 +30,7 @@ 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 @@ -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] @@ -209,7 +215,7 @@ bin/neo4j-admin database check --from-path= 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] =====