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
| Comma-separated list of host and port of Neo4j instances, each of which are tried in order.
93
-
94
-
| --type
95
-
| AUTO
96
-
| Type of backup to perform. Possible values are: `FULL`, `DIFF`, `AUTO`.
83
+
|<database>
84
+
|Name of the remote database to backup. Can contain `*` and `?` for globbing (required unless `--inspect-path` is used).
85
+
|neo4j
86
+
|===
97
87
98
-
| --compress
99
-
| true
100
-
| Request backup artifact to be compressed.
101
-
If disabled, backup artifact creation is faster but the size of the produced artifact is approximately equal to the size of backed-up database.
88
+
[TIP]
89
+
====
90
+
With a single `*` as a value, you can back up all the databases of the DBMS.
91
+
====
102
92
103
-
| --keep-failed
104
-
| false
105
-
| Request failed backup to be preserved for further post-failure analysis.
106
-
If enabled, a directory with the failed backup database is preserved.
93
+
[[backup-command-options]]
94
+
=== Options
107
95
108
-
| --pagecache
109
-
| 8m
110
-
| The size of the page cache to use for the backup process.
96
+
.`neo4j-admin database backup` options
97
+
[options="header", cols="5m,6a,4m"]
98
+
|===
99
+
| Option
100
+
| Description
101
+
| Default
111
102
112
-
| --include-metadata
103
+
|--additional-config=<file>
104
+
|Configuration file with additional configuration or override the existing configuration settings in the _neo4j.conf_ file.
113
105
|
114
-
| Include metadata in the backup.
115
-
Metadata contains security settings related to the database.
116
-
Cannot be used for backing up the `system` database.
117
-
118
-
- `roles` - commands to create the roles and privileges (for both database and graph) that affect the use of the database.
119
-
- `users` - commands to create the users that can use the database and their role assignments.
120
-
- `all` - include roles and users.
121
106
122
-
| --parallel-recovery
123
-
| false
124
-
| Allow multiple threads to apply transactions to a backup in parallel.
125
-
For some databases and workloads, this may reduce execution times significantly.
107
+
|--compress[=true\|false]
108
+
|Request backup artifact to be compressed. If disabled, backup artifact creation is faster but the size of the produced artifact will be approximately equal to the size of backed-up database.
109
+
|true
126
110
127
-
[NOTE]
128
-
====
129
-
`parallel-recovery` is an experimental option.
130
-
Consult Neo4j support before use.
131
-
====
132
-
133
-
| --inspect-path
111
+
| --expand-commands
112
+
|Allow command expansion in config value evaluation.
134
113
|
135
-
| List and show the metadata of the backup artifact(s).
136
-
Accepts a folder or a file.
137
114
138
-
| --verbose
115
+
|--from=<host:port>[,<host:port>...]
116
+
|Comma-separated list of host and port of Neo4j instances, each of which are tried in order.
139
117
|
140
-
| Enable verbose output.
141
118
142
-
| --expand-commands
119
+
|-h, --help
120
+
|Show this help message and exit.
143
121
|
144
-
| Allow command expansion in config value evaluation.
145
122
146
-
| --additional-config
123
+
|--include-metadata=none\|all\|users\|roles
124
+
|Include metadata in file. Can't be used for backing system database.
125
+
- roles - commands to create the roles and privileges (for both database and graph) that affect the use of the database
126
+
- users - commands to create the users that can use the database and their role assignments
127
+
- all - include roles and users
128
+
- none - don't include any metadata
129
+
|all
130
+
131
+
|--inspect-path=<path>
132
+
|List and show the metadata of the backup artifact(s). Accepts a folder or a file.
147
133
|
148
-
| Configuration file to provide additional or override the existing configuration settings in the _neo4j.conf_ file.
149
-
|===
150
134
151
-
[[backup-backup-command-parameters]]
152
-
=== Parameters
135
+
|--keep-failed[=true\|false]
136
+
|Request failed backup to be preserved for further post-failure analysis. If enabled, a directory with the failed backup database is preserved.
137
+
|false
153
138
154
-
[options="header",cols="m,m,a"]
155
-
|===
156
-
| Parameter
157
-
| Default
158
-
| Description
139
+
|--pagecache=<size>
140
+
|The size of the page cache to use for the backup process.
141
+
|
142
+
143
+
|--parallel-recovery[=true\|false]
144
+
| Allow multiple threads to apply pulled transactions to a backup in parallel. For some databases and workloads, this may reduce backup times significantly.
145
+
Note: this is an EXPERIMENTAL option. Consult Neo4j support before use.
146
+
|false
159
147
160
-
| <database>
148
+
|--to-path=<path>
149
+
|Directory to place backup in (required unless `--inspect-path` is used).
161
150
|
162
-
| Name of the remote database to back up.
163
151
164
-
The value can contain `*` and `?` for globbing, in which cases all matching databases are backed up.
152
+
|--type=<type>
153
+
|Type of backup to perform. Possible values are: `FULL`, `DIFF`, `AUTO`.
154
+
|AUTO
165
155
166
-
[TIP]
167
-
====
168
-
With a single `*` as a value, you can back up all the databases of the DBMS.
0 commit comments