Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Clarify when it is okay to delete state groups #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify when it is okay to delete state groups #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Expand Up @@ -8,10 +8,12 @@ such unreferenced groups.
**CAUTION**: While synapse is running and processing events there is a delay
between the state groups and the events being persisted. As such this tool may
pick up recent state groups that *will in future* get referenced by events that
are still getting processed.

Do *not* blindly delete all the state groups that are returned by this tool.
are still getting processed. If you ran `rust-synapse-find-unreferenced-state-groups`,
while Synapse was running, do *not* blindly delete all the state groups that
were returned.

If you stop Synapse before running `rust-synapse-find-unreferenced-state-groups`,
it is safe to delete all the state groups that are returned.

## Usage

Expand Down