Skip to content

docs: update database-jobs README for v2 API#63

Merged
pyramation merged 1 commit intomainfrom
docs/jobs-v2-readme
May 3, 2026
Merged

docs: update database-jobs README for v2 API#63
pyramation merged 1 commit intomainfrom
docs/jobs-v2-readme

Conversation

@pyramation
Copy link
Copy Markdown
Contributor

Summary

Updates the database-jobs README to reflect the v2 API changes merged in #61 and #62:

  • Removed db_id parameter from all add_job and add_scheduled_job examples (now read from JWT claims internally)
  • Added actor_id and is_available to the Jobs Table field list
  • Updated queue_name default from "random UUID" to NULL
  • Added Performance section documenting partial covering indexes
  • Updated add_job and add_scheduled_job parameter lists (no more db_id)
  • Added remove_job and force_unlock_workers to function reference
  • Updated trigger documentation (statement-level NOTIFY)

Review & Testing Checklist for Human

Risk: green (documentation only)

  • Verify the add_job parameter list matches the actual function signature in deploy/schemas/app_jobs/procedures/add_job.sql
  • Confirm the index names and definitions in the Performance section match the actual SQL

Notes

Link to Devin session: https://app.devin.ai/sessions/88b82416d018482791c791cdc91118de
Requested by: @pyramation

@devin-ai-integration
Copy link
Copy Markdown

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit 4b0cf17 into main May 3, 2026
24 checks passed
@pyramation pyramation deleted the docs/jobs-v2-readme branch May 3, 2026 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant