Skip to content

Commit

Permalink
Document rq worker command arguments.
Browse files Browse the repository at this point in the history
  • Loading branch information
selwin committed Apr 6, 2018
1 parent 487ef72 commit 0ec8030
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/docs/workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://:[email protected]: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
Expand Down

0 comments on commit 0ec8030

Please sign in to comment.