Skip to content

Update the neo4j-admin backup aggregate command #2062

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 2 commits into from
Jan 20, 2025
Merged

Update the neo4j-admin backup aggregate command #2062

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7634aa4
Update the `neo4j-admin backup aggregate` command
NataliaIvakina Jan 17, 2025
1fc866d
Few edits on labels
NataliaIvakina Jan 17, 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
24 changes: 16 additions & 8 deletions modules/ROOT/pages/backup-restore/aggregate.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,31 @@ This operation is called _recovery_ and can be costly.
[[aggregate-backup-syntax]]
=== Syntax

[role=label--new-2025.01]
[source,role=noheader]
----
neo4j-admin database aggregate-backup [-h] [--expand-commands]
neo4j-admin backup aggregate [-h] [--expand-commands]
[--verbose] [--keep-old-backup[=true|false]]
[--parallel-recovery[=true|false]]
[--additional-config=<file>] --from-path=<path>
[--temp-path=<path>] [<database>]
----

[NOTE]
====
In Neo4j 2025.01, the `neo4j-admin database aggregate-backup` command is deprecated.
It is recommended to use the new command name, `neo4j-admin backup aggregate`.
====


=== Description

Aggregates a chain of backup artifacts into a single artifact.

[[aggregate-backup-command-parameters]]
=== Parameters

.`neo4j-admin database aggregate-backup` parameters
.`neo4j-admin backup aggregate` parameters
[options="header", cols="1m,3a"]
|===
| Parameter
Expand All @@ -52,7 +60,7 @@ Aggregates a chain of backup artifacts into a single artifact.
[[aggregate-backup-command-options]]
=== Options

.`neo4j-admin database aggregate-backup` options
.`neo4j-admin backup aggregate` options
[options="header", cols="5m,6a,4m"]
|===
| Option
Expand Down Expand Up @@ -128,7 +136,7 @@ The following is an example of how to perform aggregation of a set of backups lo

[source,shell]
----
bin/neo4j-admin database aggregate-backup --from-path=/mnt/backups/ neo4j
bin/neo4j-admin backup aggregate --from-path=/mnt/backups/ neo4j
----
The command first looks inside the `/mnt/backups/` directory for a backup chain for the database `neo4j`. If found, it is then aggregated into a single backup artifact.

Expand All @@ -138,7 +146,7 @@ The following is an example of how to perform aggregation of a set of backups id

[source,shell]
----
bin/neo4j-admin database aggregate-backup --from-path=/mnt/backups/neo4j-2022-10-18T13-00-07.backup
bin/neo4j-admin backup aggregate --from-path=/mnt/backups/neo4j-2022-10-18T13-00-07.backup
----
The command checks the `/mnt/backups/` directory for a backup chain including the file _neo4j-2022-10-18T13-00-07.backup_, for the database `neo4j`.
If found, it is then aggregated into a single backup artifact.
Expand All @@ -162,7 +170,7 @@ The example assumes that you have a backup chain located in the `myBucket/myDire
+
[source,shell]
----
bin/neo4j-admin database aggregate-backup --from-path=s3://myBucket/myDirectory/myBackup.backup mydatabase
bin/neo4j-admin backup aggregate --from-path=s3://myBucket/myDirectory/myBackup.backup mydatabase
----
======

Expand All @@ -176,7 +184,7 @@ The example assumes that you have a backup chain located in the `myBucket/myDire
+
[source,shell]
----
bin/neo4j-admin database aggregate-backup --from-path=gs://myBucket/myDirectory/myBackup.backup mydatabase
bin/neo4j-admin backup aggregate --from-path=gs://myBucket/myDirectory/myBackup.backup mydatabase
----
======

Expand All @@ -190,7 +198,7 @@ The example assumes that you have a backup chain located with a `myStorageAccoun
+
[source,shell]
----
bin/neo4j-admin database aggregate-backup --from-path=azb://myStorageAccount/myContainer/myDirectory/myBackup.backup mydatabase
bin/neo4j-admin backup aggregate --from-path=azb://myStorageAccount/myContainer/myDirectory/myBackup.backup mydatabase
----
======
=====
Loading