Skip to content

Commit ba59e0f

Browse files
authored
Update neo4j-admin database aggregate-backup syntax and options to reflect the code (#708)
Cherry-picked from #706
1 parent 24d52ce commit ba59e0f

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

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

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[role=enterprise-edition]
22
[[aggregate-backup]]
33
= Aggregate a database backup chain
4-
:description: This section describes how to aggregate a backup chain into a single backup.
4+
:description: This section describes how to aggregate a backup chain into a single backup.
55

66
[[aggregate-backup-command]]
77
== Command
88

9-
The aggregate command turns a xref:backup-restore/online-backup.adoc#backup-chain[backup chain] into a single xref:backup-restore/online-backup.adoc#backup-artifact[full backup artifact].
9+
The aggregate command turns a xref:backup-restore/online-backup.adoc#backup-chain[a chain of backup artifacts] into a single xref:backup-restore/online-backup.adoc#backup-artifact[full backup artifact].
1010

1111
image:backup-chain-aggregation.svg[title="Backup chain aggregation",role="middle"]
1212

@@ -24,71 +24,71 @@ This operation is called _recovery_ and can be costly.
2424

2525
[source,role=noheader]
2626
----
27-
neo4j-admin database aggregate-backup --from-path=<path>
28-
[--keep-old-backup[=true|false]]
29-
[--parallel-recovery[=true|false]]
30-
[--verbose]
31-
[--expand-commands]
32-
[--additional-config=<file>]
33-
<database>
27+
neo4j-admin database aggregate-backup [-h] [--expand-commands]
28+
[--verbose] [--keep-old-backup[=true|false]]
29+
[--parallel-recovery[=true|false]]
30+
[--additional-config=<file>]
31+
--from-path=<path> [<database>]
3432
----
3533

34+
35+
[[aggregate-backup-command-parameters]]
36+
=== Parameters
37+
38+
.`neo4j-admin database aggregate-backup` parameters
39+
[options="header", cols="1m,3a"]
40+
|===
41+
| Parameter
42+
| Description
43+
44+
|<database>
45+
|Name of the database for which to aggregate the artifacts. Can contain `*` and `?` for globbing.
46+
|===
47+
48+
3649
[[aggregate-backup-command-options]]
3750
=== Options
3851

39-
[options="header",cols="m,m,a"]
52+
.`neo4j-admin database aggregate-backup` options
53+
[options="header", cols="5m,6a,4m"]
4054
|===
4155
| Option
42-
| Default
4356
| Description
57+
| Default
4458

45-
| --from-path
59+
|--additional-config=<file>
60+
|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file.
4661
|
47-
| Directory where the backup artifacts are located.
48-
Directory where the backup artifacts are located, or optionally the path to a specific _.backup file_ forcing `aggregate` to find the backup chain for that specific backup (and guarding against the risk of identifying the wrong backup chain, if more than one exists in a given directory).
49-
When a file is supplied, the _<database>_ parameter should be omitted.
50-
The option to supply a file is only available in Neo4j 5.2 and later.
51-
52-
| --keep-old-backup
53-
| false
54-
| If set to true, the old backup chain is not removed.
55-
56-
| --parallel-recovery
57-
| false
58-
| Allow multiple threads to apply pulled transactions to a backup in parallel.
59-
For some databases and workloads this may reduce aggregate times significantly.
60-
[NOTE]
61-
====
62-
`parallel-recovery` is an experimental option.
63-
Consult Neo4j support before use.
64-
====
65-
| --verbose
66-
|
67-
| Enable verbose output.
6862

6963
| --expand-commands
70-
|
7164
| Allow command expansion in config value evaluation.
65+
|
66+
67+
|--from-path=<path>
68+
|Accepts either a path to a single artifact file or a folder containing backup artifacts.
7269

73-
| --additional-config
70+
When a file is supplied, the _<database>_ parameter should be omitted.
71+
The option to supply a file is only available in Neo4j 5.2 and later.
7472
|
75-
| Configuration file to provide additional or override the existing configuration settings in the _neo4j.conf_ file.
76-
|===
7773

78-
[[aggregate-backup-command-parameters]]
79-
=== Parameters
74+
|-h, --help
75+
|Show this help message and exit.
76+
|
8077

81-
[options="header",cols="m,m,a"]
82-
|===
83-
| Parameter
84-
| Default
85-
| Description
78+
|--keep-old-backup[=true\|false]
79+
|If set to true, the old backup chain is not removed.
80+
|false
8681

87-
| <database>
88-
| neo4j
89-
| Name of the database for which to aggregate the artifacts.
90-
Can contain `*` and `?` for globbing.
82+
|--parallel-recovery[=true\|false]
83+
|Allow multiple threads to apply pulled transactions to a backup in parallel.
84+
For some databases and workloads, this may reduce aggregate times significantly.
85+
Note: this is an EXPERIMENTAL option.
86+
Consult Neo4j support before use.
87+
|false
9188

89+
|--verbose
90+
|Enable verbose output.
91+
|
9292
|===
9393

9494
[[aggregate-backup-example]]

0 commit comments

Comments
 (0)