-
Notifications
You must be signed in to change notification settings - Fork 82
Document validate backup #2768
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.
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
Open
renetapopova
wants to merge
4
commits into
neo4j:dev
Choose a base branch
from
renetapopova:dev-validate-backup
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+125
−15
Open
Document validate backup #2768
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| :page-role: new-2025.12 enterprise-edition not-on-aura | ||
| [[validate-backup]] | ||
| = Validate a sharded property database backup | ||
| :description: This section describes how to validate a sharded property database backup using the neo4j-admin backup validate command. | ||
| :keywords: neo4j-admin, backup, validate, sharded property databases, sharding | ||
|
|
||
| When you back up a sharded property database, you create multiple backup chains—one for each shard. | ||
| The backup chains of the graph shard will have 1 full backup and 0 or more differential backups. | ||
| Whereas the property shard backup chains will have only 1 full backup, differential backups of property shards are not supported. | ||
| See xref:scalability/sharded-property-databases/admin-operations.adoc#backup-and-restore[Backup and restore] for more information on backing up sharded property databases. | ||
|
|
||
| To ensure that the backup chains are valid and can be used for restoration, you can use the `neo4j-admin backup validate` command. | ||
|
|
||
| [[validate-backup-command]] | ||
| == Command | ||
|
|
||
| The `neo4j-admin backup validate` command checks the integrity and consistency of the backup artifacts for a specified sharded property database. | ||
|
|
||
| [[validate-backup-syntax]] | ||
| === Syntax | ||
|
|
||
| [source,role=noheader] | ||
| ---- | ||
| neo4j-admin backup validate [-h] [--expand-commands] [--verbose] | ||
| [--additional-config=<file>] --database=<database> | ||
| [--format=<value>] --from-path=<backup-path> | ||
| ---- | ||
|
|
||
|
|
||
| === Description | ||
|
|
||
| Command to validate a collection of backups. | ||
|
|
||
| [[validate-backup-command-options]] | ||
| === Options | ||
|
|
||
| .`neo4j-admin backup validate` options | ||
| [options="header", cols="5m,6a,4m"] | ||
| |=== | ||
| | Option | ||
| | Description | ||
| | Default | ||
|
|
||
| |--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] | ||
| |Configuration file with additional configuration. | ||
| | | ||
|
|
||
| |--database=<database> | ||
| |Name of the database to validate. | ||
| | | ||
|
|
||
| | --expand-commands | ||
| | Allow command expansion in config value evaluation. | ||
| | | ||
|
|
||
| |--format=<value> | ||
| |Format of the output of the command. Possible values are: 'JSON, TABULAR'. | ||
| |TABULAR | ||
|
|
||
| |--from-path=<backup-path> | ||
| |Path denoting a directory to where backups are stored. | ||
| | | ||
|
|
||
| |-h, --help | ||
| |Show this help message and exit. | ||
| | | ||
|
|
||
| |--verbose | ||
| |Enable verbose output. | ||
| | | ||
|
|
||
| |=== | ||
|
|
||
| [[validate-backup-example]] | ||
| == Example | ||
|
|
||
| To validate a backup for the database `foo` located at _s3://bucket/backups_, use the following command: | ||
|
|
||
| [source,shell] | ||
| ---- | ||
| bin/neo4j-admin backup validate "foo" --from-path=s3://bucket/backups | ||
| ---- | ||
|
|
||
| The output will indicate whether the backups are valid. | ||
| For example: | ||
|
|
||
| [result] | ||
| ---- | ||
| | DATABASE | PATH | STATUS | | ||
| | foo-g000 | /bucket/backups/foo-g000-2025-06-11T21-04-42.backup | OK | | ||
| | foo-p000 | /bucket/backups/foo-p000-2025-06-11T21-04-37.backup | OK | | ||
| | foo-p001 | /bucket/backups/foo-p001-2025-06-11T21-04-40.backup | OK | | ||
| ---- | ||
|
|
||
| If valid, the backups can be used to xref:scalability/sharded-property-databases/data-ingestion.adoc#creating-sharded-db-from-uri[seed a sharded property database]. | ||
|
|
||
| For more examples and details, see xref:scalability/sharded-property-databases/admin-operations.adoc#backup-and-restore[Backup and restore]. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.