Skip to content

Clarify backup/restore strategy regarding system db #2521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

NataliaIvakina
Copy link
Collaborator

No description provided.

@NataliaIvakina NataliaIvakina force-pushed the dev-backup-planning-improvement branch from a8d7711 to e1e30f3 Compare August 18, 2025 09:09
@neo4j-docops-agent
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-operations-2521.surge.sh

Updated pages:

See xref:clustering/monitoring/show-databases-monitoring.adoc#show-databases-monitoring-listing-single[Listing a single database] for more information.

However, _restoring_ a database in a cluster is different since it is not known in advance how a database is going to be allocated to the servers in a cluster.
This method relies on the seed already existing on one of the servers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like it's not totally clear what 'this method' refers to, and I'm a little confused by the 'existing on one of the servers' now I look at it.

Perhaps something like:

Restoring from the command line involves putting a copy of the database on disk on each server that will need it.
That can be awkward to achieve.

Comment on lines +192 to +195
When backing up a clustered database, be aware that the xref:clustering/introduction.adoc#clustering-introduction-operational[cluster topology] metadata is not included in the backup.
The cluster topology is stored in the `system` database and describes how the copies of a database should be spread across the servers in a cluster.

Because this metadata is excluded from backups, restoring to a new cluster environment requires manual reconfiguration of servers modes and database allocations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems a bit negative about the topology not being backed up. I think it's actually a positive. Perhaps something more along the lines of:

Backing up a database only includes the database contents, and the RBAC associated with the database if you include the metadata.
This means you specify the desired topology when you restore the backup, allowing you to restore with a different topology than was present when backed up.
The database will be allocated to servers that are present at restore time to fulfil that topology.

I wouldn't mention that the topology is stored in system, that's effectively an implementation detail.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Be positive 🙂 You're right, I'll rewrite it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants