Skip to content

Commit 7634aa4

Browse files
Update the neo4j-admin backup aggregate command
1 parent 83017a5 commit 7634aa4

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

modules/ROOT/pages/backup-restore/aggregate.adoc

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,31 @@ This operation is called _recovery_ and can be costly.
2222
[[aggregate-backup-syntax]]
2323
=== Syntax
2424

25+
[role=label--new-2025.01]
2526
[source,role=noheader]
2627
----
27-
neo4j-admin database aggregate-backup [-h] [--expand-commands]
28+
neo4j-admin backup aggregate [-h] [--expand-commands]
2829
[--verbose] [--keep-old-backup[=true|false]]
2930
[--parallel-recovery[=true|false]]
3031
[--additional-config=<file>] --from-path=<path>
3132
[--temp-path=<path>] [<database>]
3233
----
3334

35+
[NOTE]
36+
====
37+
In Neo4j 2025.01, the `neo4j-admin database aggregate-backup` command is deprecated.
38+
It is recommended to use the new command name, `neo4j-admin backup aggregate`.
39+
====
40+
41+
3442
=== Description
3543

3644
Aggregates a chain of backup artifacts into a single artifact.
3745

3846
[[aggregate-backup-command-parameters]]
3947
=== Parameters
4048

41-
.`neo4j-admin database aggregate-backup` parameters
49+
.`neo4j-admin backup aggregate` parameters
4250
[options="header", cols="1m,3a"]
4351
|===
4452
| Parameter
@@ -52,7 +60,7 @@ Aggregates a chain of backup artifacts into a single artifact.
5260
[[aggregate-backup-command-options]]
5361
=== Options
5462

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

129137
[source,shell]
130138
----
131-
bin/neo4j-admin database aggregate-backup --from-path=/mnt/backups/ neo4j
139+
bin/neo4j-admin backup aggregate --from-path=/mnt/backups/ neo4j
132140
----
133141
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.
134142

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

139147
[source,shell]
140148
----
141-
bin/neo4j-admin database aggregate-backup --from-path=/mnt/backups/neo4j-2022-10-18T13-00-07.backup
149+
bin/neo4j-admin backup aggregate --from-path=/mnt/backups/neo4j-2022-10-18T13-00-07.backup
142150
----
143151
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`.
144152
If found, it is then aggregated into a single backup artifact.
@@ -162,7 +170,7 @@ The example assumes that you have a backup chain located in the `myBucket/myDire
162170
+
163171
[source,shell]
164172
----
165-
bin/neo4j-admin database aggregate-backup --from-path=s3://myBucket/myDirectory/myBackup.backup mydatabase
173+
bin/neo4j-admin backup aggregate --from-path=s3://myBucket/myDirectory/myBackup.backup mydatabase
166174
----
167175
======
168176
@@ -176,7 +184,7 @@ The example assumes that you have a backup chain located in the `myBucket/myDire
176184
+
177185
[source,shell]
178186
----
179-
bin/neo4j-admin database aggregate-backup --from-path=gs://myBucket/myDirectory/myBackup.backup mydatabase
187+
bin/neo4j-admin backup aggregate --from-path=gs://myBucket/myDirectory/myBackup.backup mydatabase
180188
----
181189
======
182190
@@ -190,7 +198,7 @@ The example assumes that you have a backup chain located with a `myStorageAccoun
190198
+
191199
[source,shell]
192200
----
193-
bin/neo4j-admin database aggregate-backup --from-path=azb://myStorageAccount/myContainer/myDirectory/myBackup.backup mydatabase
201+
bin/neo4j-admin backup aggregate --from-path=azb://myStorageAccount/myContainer/myDirectory/myBackup.backup mydatabase
194202
----
195203
======
196204
=====

0 commit comments

Comments
 (0)