Skip to content

Update the restore command #2090

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 3 commits into from
Feb 10, 2025
Merged

Update the restore command #2090

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2312e89
Update the restore command
NataliaIvakina Jan 30, 2025
321eae5
Fix the test
NataliaIvakina Jan 30, 2025
22d6c22
Update modules/ROOT/pages/backup-restore/restore-backup.adoc
NataliaIvakina Feb 4, 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
18 changes: 9 additions & 9 deletions modules/ROOT/pages/backup-restore/restore-backup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,11 @@ This recovery operation is resource-intensive and can be decoupled from the rest

[source,role=noheader]
----
neo4j-admin database restore [-h] [--expand-commands]
[--verbose] [--overwrite-destination[=true|false]]
[--additional-config=<file>]
--from-path=<path>[,<path>...]
neo4j-admin database restore [-h] [--expand-commands] [--verbose] [--overwrite-destination
[=true|false]] [--source-database[=source-database-name]]
[--additional-config=<file>] --from-path=<path> [,<path>...]
[--restore-until=<recovery-criteria>] [--temp-path=<path>]
[--to-path-data=<path>] [--to-path-txn=<path>]
[<database>]
[--to-path-data=<path>] [--to-path-txn=<path>] [<database>]
----

=== Parameters
Expand Down Expand Up @@ -77,9 +75,7 @@ neo4j-admin database restore [-h] [--expand-commands]
|

|--from-path=<path>[,<path>...]
|A single path or a comma-separated list of paths pointing to a backup artifact file.
An artifact file can be 1) a full backup, in which case it is restored directly or, 2) a differential backup, in which case the command tries first to find in the folder a backup chain ending at that specific differential backup and then restores that chain.
It is possible to restore backups from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
|The path can point to an individual backup artifact, a folder that contains artifacts, or a comma-separated list of backup artifact files. An artifact file can be 1) a full backup, in which case it is restored directly or, 2) a differential backup, in which case the command tries first to find in the folder a backup chain ending at that specific differential backup and then restores that chain. It is possible to restore backups from AWS S3 buckets, Google Cloud storage buckets, and Azure buckets using the appropriate URI as the path.
|

|-h, --help
Expand All @@ -104,6 +100,10 @@ The restore recovers transaction logs up to, but not including, the transaction
The restore recovers transactions that were committed before the provided timestamp.
|

| --source-database[=source-database-name]
|label:new[Introduced in 2025.02] If `from-path` specifies a folder that contains backups for multiple databases, what database name should be used to filter the artifacts. It's mandatory to specify it in this case.
|

| --to-path-data=<path>
|Base directory for databases.
Usage of this option is only allowed if the `--from-path` parameter points to exactly one directory.
Expand Down