Allow retention periods to be configured to -1 so they're retained indefinitely #990
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brandur
force-pushed
the
brandur-retain-indefinitely
branch
2 times, most recently
from
d059eee to
851693c
Compare
…definitely Here, let each of the job cleaner's configured retention periods (`CancelledJobRetentionPeriod`, `CompletedJobRetentionPeriod`, `DiscardedJobRetentionPeriod`) accept the special value of -1 so that the cleaner will maintain that type of job indefinitely, effectively disabling it. This probably won't be of much use day-to-day for most users, but does enable us to augment cleaning functionality with special overrides.
brandur
force-pushed
the
brandur-retain-indefinitely
branch
from
851693c to
c46081a
Compare
bgentry
approved these changes
Jul 27, 2025
| @@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
| - **Breaking change:** The `HookWorkEnd` interface's `WorkEnd` function now receives a `JobRow` parameter in addition to the `error` it received before. Having a `JobRow` to work with is fairly crucial to most functionality that a hook would implement, and its previous omission was entirely an error. [PR #970](https://github.com/riverqueue/river/pull/970). | |||
| - Add maximum bound to each job's `attempted_by` array so that in degenerate cases where a job is run many, many times (say it's snoozed hundreds of times), it doesn't grow to unlimited bounds. [PR #974](https://github.com/riverqueue/river/pull/974). | |||
| - A logger passed in via `river.Config` now overrides the default test-based logger when using `rivertest.NewWorker`. [PR #980](https://github.com/riverqueue/river/pull/980). | |||
| - Cleaner retention periods (`CancelledJobRetentionPeriod`, `CompletedJobRetentionPeriod`, `DiscardedJobRetentionPeriod`) can be configured to -1 to disable them so that the corresponding type of job is retained indefinitely. [PR #990](https://github.com/riverqueue/river/pull/990). | |||
There was a problem hiding this comment.
This probably warrants a doc addition to https://riverqueue.com/docs/maintenance-services#cleaner
There was a problem hiding this comment.
I'll make a note of it for when we do a release.
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here, let each of the job cleaner's configured retention periods
(
CancelledJobRetentionPeriod,CompletedJobRetentionPeriod,DiscardedJobRetentionPeriod) accept the special value of -1 so thatthe cleaner will maintain that type of job indefinitely, effectively
disabling it.
This probably won't be of much use day-to-day for most users, but does
enable us to augment cleaning functionality with special overrides.