From 0ec8030d285b827c4e2ed62754d6b41a3a7730b9 Mon Sep 17 00:00:00 2001 From: Selwin Ong Date: Fri, 6 Apr 2018 07:51:28 +0700 Subject: [PATCH] Document rq worker command arguments. --- docs/docs/workers.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/docs/workers.md b/docs/docs/workers.md index 7ce595e..aacaa8c 100644 --- a/docs/docs/workers.md +++ b/docs/docs/workers.md @@ -50,6 +50,19 @@ This can be useful for batch work that needs to be processed periodically, or just to scale up your workers temporarily during peak periods. +### Worker arguments + +In addition to `--burst`, `rq worker` also accepts these arguments: + +* `--url` or `-u`: URL describing Redis connection details (e.g `rq worker --url redis://:secrets@example.com:1234/9`) +* `--path` or `-P`: multiple import paths are supported (e.g `rq worker --path foo --path bar`) +* `--config` or `-c`: path to module containing RQ settings. +* `--worker-class` or `-w`: RQ Worker class to use (e.g `rq worker --worker-class 'foo.bar.MyWorker'`) +* `--job-class` or `-j`: RQ Job class to use. +* `--queue-class`: RQ Queue class to use. +* `--connection-class`: Redis connection class to use, defaults to `redis.StrictRedis`. + + ## Inside the worker ### The worker life-cycle