From 7634aa421d05b596229c2e9bfc66204d75626f20 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Fri, 17 Jan 2025 15:56:12 +0100 Subject: [PATCH 1/2] Update the `neo4j-admin backup aggregate` command --- .../ROOT/pages/backup-restore/aggregate.adoc | 24 ++++++++++++------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index 9a460be0a..9e3ba2034 100644 --- a/modules/ROOT/pages/backup-restore/aggregate.adoc +++ b/modules/ROOT/pages/backup-restore/aggregate.adoc @@ -22,15 +22,23 @@ 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=] --from-path= [--temp-path=] [] ---- +[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. @@ -38,7 +46,7 @@ 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 @@ -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 @@ -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. @@ -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. @@ -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 ---- ====== @@ -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 ---- ====== @@ -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 ---- ====== ===== From 1fc866d8caa19199cf0231ee9df94901b444be3f Mon Sep 17 00:00:00 2001 From: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Fri, 17 Jan 2025 16:04:02 +0100 Subject: [PATCH 2/2] Few edits on labels --- modules/ROOT/pages/backup-restore/aggregate.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index 9e3ba2034..b23c61c8f 100644 --- a/modules/ROOT/pages/backup-restore/aggregate.adoc +++ b/modules/ROOT/pages/backup-restore/aggregate.adoc @@ -19,10 +19,10 @@ This operation is called _recovery_ and can be costly. * Reduces the risk of losing chain’s links. +[role=label--changed-2025.01] [[aggregate-backup-syntax]] === Syntax -[role=label--new-2025.01] [source,role=noheader] ---- neo4j-admin backup aggregate [-h] [--expand-commands] @@ -34,7 +34,7 @@ neo4j-admin backup aggregate [-h] [--expand-commands] [NOTE] ==== -In Neo4j 2025.01, the `neo4j-admin database aggregate-backup` command is deprecated. +In Neo4j 2025.01, the name `neo4j-admin database aggregate-backup` is deprecated. It is recommended to use the new command name, `neo4j-admin backup aggregate`. ====