Skip to content

Commit

Permalink
Document running clear_finished_in_batches
Browse files Browse the repository at this point in the history
  • Loading branch information
ksylvest committed Oct 18, 2024
1 parent 4c817ff commit 5c5ef45
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ There are several settings that control how Solid Queue works that you can set a
- `silence_polling`: whether to silence Active Record logs emitted when polling for both workers and dispatchers—defaults to `true`.
- `supervisor_pidfile`: path to a pidfile that the supervisor will create when booting to prevent running more than one supervisor in the same host, or in case you want to use it for a health check. It's `nil` by default.
- `preserve_finished_jobs`: whether to keep finished jobs in the `solid_queue_jobs` table—defaults to `true`.
- `clear_finished_jobs_after`: period to keep finished jobs around, in case `preserve_finished_jobs` is truedefaults to 1 day. **Note:** Right now, there's no automatic cleanup of finished jobs. You'd need to do this by periodically invoking `SolidQueue::Job.clear_finished_in_batches`, but this will happen automatically in the near future.
- `clear_finished_jobs_after`: period to keep finished jobs around, in case `preserve_finished_jobs` is `true`-defaults to 1 day. Ensure recurring.yml runs the command `SolidQueue::Job.clear_finished_in_batches` at an approriate cadence (e.g. hourly) to automatically trigger the cleanup.
- `default_concurrency_control_period`: the value to be used as the default for the `duration` parameter in [concurrency controls](#concurrency-controls). It defaults to 3 minutes.

## Errors when enqueuing
Expand Down

0 comments on commit 5c5ef45

Please sign in to comment.