Skip to content

Commit ac8af0d

Browse files
Update planning.adoc
1 parent d7d6249 commit ac8af0d

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -187,22 +187,23 @@ However, _restoring_ a database in a cluster is different since it is not known
187187
This method relies on the seed already existing on one of the servers.
188188
The recommended way to restore a database in a cluster is to xref::database-administration/standard-databases/seed-from-uri.adoc[seed from URI].
189189

190+
[NOTE]
191+
====
192+
For backing up a clustered database, it is recommended to use the `--include-metadata=all` option.
193+
This option includes metadata in the backup file, retaining not only `users` and `roles` but also the cluster topology.
194+
The cluster topology in the `system` database details which servers exist and their modes.
195+
====
190196

191197
[[backup-planning-databases]]
192-
== Databases to backup
198+
== Databases to back up
193199

194200
A Neo4j DBMS can host multiple databases.
195-
Both Neo4j Community and Enterprise Editions have a default user database, called `neo4j`, and a `system` database, which contains configurations, e.g., operational states of databases, security configuration, schema definitions, login credentials, and roles.
201+
Both Neo4j Community and Enterprise Editions have a default user database named `neo4j` and a `system` database.
202+
The `system` database contains configurations, e.g., operational states of databases, security configuration, schema definitions, login credentials, and roles.
196203

197204
In the Enterprise Edition, you can also create multiple user databases.
198205
Each of these databases is backed up independently of one another.
199206

200-
[NOTE]
201-
====
202-
Backing up the `system` database, it is recommended to use the `--include-metadata=all` option.
203-
This restores the user databases to the new `system` database retaining not only `users` and `roles` but also the cluster topology.
204-
====
205-
206207
It is very important to store a recent backup of your databases, including the `system` database, in a safe location.
207208

208209

@@ -224,4 +225,4 @@ If you have a cluster, you should back up these files for each cluster member.
224225

225226
For any backup, it is important that you store your data separately from the production system, where there are no common dependencies, and preferably off-site.
226227
If you are running Neo4j in the cloud, you may use a different availability zone or even a separate cloud provider.
227-
Since backups are kept for a long time, the longevity of archival storage should be considered as part of backup planning.
228+
Since backups are kept for a long time, the longevity of archival storage should be considered as part of backup planning.

0 commit comments

Comments
 (0)