Document suspend and resume commands (#2068)

* Document suspend and resume commands

* Title case title

* Modify docs
This commit is contained in:
Jack Kinsella 2024-05-01 09:18:02 +02:00 committed by GitHub
parent fbd9858f3c
commit 0b31edc6da
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 0 deletions

View File

@ -471,6 +471,31 @@ To learn about workers, see the [workers][w] documentation.
[w]: {{site.baseurl}}workers/
## Suspending and Resuming
Sometimes you may want to suspend RQ to prevent it from processing new jobs.
A classic example is during the initial phase of a deployment script or in advance
of putting your site into maintenance mode. This is particularly helpful when
you have jobs that are relatively long-running and might otherwise be forcibly
killed during the deploy.
The `suspend` command stops workers on _all_ queues (in a single Redis database)
from picking up new jobs. However currently running jobs will continue until
completion.
```bash
# Suspend indefinitely
rq suspend
# Suspend for a specific duration (in seconds) then automatically
# resume work again.
rq suspend --duration 300
# Resume work again.
rq resume
```
## Considerations for jobs
Technically, you can put any Python function call on a queue, but that does not