docs: document array payload merging behavior with job_key #569
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.
Summary
Documents the undocumented array payload merging behavior when using
job_keyto update existing jobs.When both the existing job's payload and the new payload are JSON arrays, Graphile Worker concatenates them rather than replacing. This enables powerful batching patterns, especially when combined with
preserve_run_atfor fixed batching windows.Changes
job-key.mdwith SQL exampletasks.mdbatch jobs sectionContext
I discovered this behavior while implementing a batching system using database triggers. The feature is implemented in
add_jobs():This is genuinely useful but hard to discover without reading the source code.
🤖 Generated with Claude Code
Note that the above is AI generated and I might be misunderstanding things, apologies if this is noise and thank you for this project!