Update unique job example to be a little more realistic #11
Conversation
This file contains 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-update-unique-example
branch
from
a5f6b5d
to
9a544b2
Compare
brandur
force-pushed
the
brandur-update-unique-example
branch
from
9a544b2
to
c99533b
Compare
bgentry
approved these changes
Nov 11, 2023
example_unique_job_test.go
Outdated
| @@ -14,44 +14,47 @@ import ( | |||
| "github.com/riverqueue/river/riverdriver/riverpgxv5" | |||
| ) | |||
|
|
|||
| // Account represents a minimal account containing a unique identifier, recent | |||
| // expenditures, and a remaining total. | |||
| // Account represents a minimal account recent expenditures and remaining total. | |||
There was a problem hiding this comment.
typo or missing words in here I think? "account recent expenditures"
There was a problem hiding this comment.
Ah dammit. Last second change and of course I messed it up. Thanks, fixed.
As I was writing the docs for unique jobs, I found that I wanted to have an example that was a little more elaborate than what we already had which demonstrated the use of uniqueness along multiple properties instead of just duration. Here, update the unique opts example so that the job becomes reconciling a single account that should run every 24 hours, so jobs for account 1 and account 2 are inserted separately, and we show that a duplicate for account 1 isn't allowed. I suspect that this change makes the example a little more realistic along the lines of what users will want to do so it has that benefit in addition to being more conducive for the docs.
brandur
force-pushed
the
brandur-update-unique-example
branch
from
c99533b
to
7cd5ccf
Compare
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.
As I was writing the docs for unique jobs, I found that I wanted to have
an example that was a little more elaborate than what we already had
which demonstrated the use of uniqueness along multiple properties
instead of just duration.
Here, update the unique opts example so that the job becomes reconciling
a single account that should run every 24 hours, so jobs for account 1
and account 2 are inserted separately, and we show that a duplicate for
account 1 isn't allowed. I suspect that this change makes the example a
little more realistic along the lines of what users will want to do so
it has that benefit in addition to being more conducive for the docs.