Skip to content

Commit ec2224b

Browse files
Clarify that consistency check is not supported for diff backups (#2515)
1 parent e5ecedd commit ec2224b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[[consistency-checker]]
33
= Consistency checker
44

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

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

2323
=== Description
2424

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

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

3131
[NOTE]
3232
====
33-
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.
33+
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.
3434
====
3535

3636
=== Parameters
@@ -199,6 +199,12 @@ Consistency check
199199

200200
=== Check the consistency of a backup/dump
201201

202+
[NOTE]
203+
====
204+
Note that consistency check is not supported for differential backups.
205+
The backup chain must be aggregated into a full backup artifact before running consistency check.
206+
====
207+
202208
Run with the `--from-path` option to check the consistency of a backup or a dump:
203209

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

212-
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.
218+
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.
213219

214220
[.tabbed-example]
215221
=====

0 commit comments

Comments
 (0)