Purging Central resources via CLI
- Dominant language
- Python
- Stars
- 58
- Forks
- 160
- Avg merge
- 5d 11h
- Merged PRs (30d)
- 12
Description
Currently, it's possible in Central to purge forms and submissions that have been soft-deleted. Purging is done via a command-line script that's automatically run once a day. By default, a form or submission is purged 30 days after it's deleted. However, if manually run with the correct flag, the command-line script can be used to purge deleted resources immediately (not waiting for the 30 days). It's also possible use the script to immediately purge only a subset of deleted resources (e.g., a single form).
This issue is to document this command-line script for users. The goal is to give server admins a way to immediately purge resources if that's needed. We talked about adding an endpoint for purging (see getodk/central-backend#739). However, our currently thinking is that we don't want to make immediate purging too easy. Yet we still want to make it possible for server admins, which is why we want to document this command-line script.
Contributor guide
Research direction
Start by locating the existing Central command-line script that purges soft-deleted forms and submissions. Document its daily schedule, 30-day default, flag for immediate purging, and how to target a subset such as one form. Done means server administrators can follow the documentation to purge resources immediately when needed.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100