You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/backup-restore/aggregate.adoc
+48-48Lines changed: 48 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
[role=enterprise-edition]
2
2
[[aggregate-backup]]
3
3
= 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.
5
5
6
6
[[aggregate-backup-command]]
7
7
== Command
8
8
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].
|Name of the database for which to aggregate the artifacts. Can contain `*` and `?` for globbing.
46
+
|===
47
+
48
+
36
49
[[aggregate-backup-command-options]]
37
50
=== Options
38
51
39
-
[options="header",cols="m,m,a"]
52
+
.`neo4j-admin database aggregate-backup` options
53
+
[options="header", cols="5m,6a,4m"]
40
54
|===
41
55
| Option
42
-
| Default
43
56
| Description
57
+
| Default
44
58
45
-
| --from-path
59
+
|--additional-config=<file>
60
+
|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file.
46
61
|
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.
68
62
69
63
| --expand-commands
70
-
|
71
64
| 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.
72
69
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.
74
72
|
75
-
| Configuration file to provide additional or override the existing configuration settings in the _neo4j.conf_ file.
76
-
|===
77
73
78
-
[[aggregate-backup-command-parameters]]
79
-
=== Parameters
74
+
|-h, --help
75
+
|Show this help message and exit.
76
+
|
80
77
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
86
81
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.
0 commit comments