Purging Central resources via CLI

Open
#1,868 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
cli, documentation

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.

Description

Central

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.

Dominant language
Python
Stars
58
Forks
161
Avg merge
20h 51m
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getodk/docs

All issues in getodk/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.