https://github.com/mgcrea/prisma-queue
Minimalist postgresql job queue for Prisma
https://github.com/mgcrea/prisma-queue
job postgresql prisma queue worker
Last synced: 3 months ago
JSON representation
Minimalist postgresql job queue for Prisma
- Host: GitHub
- URL: https://github.com/mgcrea/prisma-queue
- Owner: mgcrea
- License: mit
- Created: 2022-02-17T21:51:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T13:49:05.000Z (11 months ago)
- Last Synced: 2025-06-09T06:08:01.340Z (4 months ago)
- Topics: job, postgresql, prisma, queue, worker
- Language: TypeScript
- Homepage:
- Size: 437 KB
- Stars: 55
- Watchers: 4
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Prisma Queue
## Features
Simple, reliable and efficient concurrent work queue for [Prisma](https://prisma.io) + [PostgreSQL](https://www.postgresql.org/)
- Leverages PostgreSQL [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-select-skip-locked-for-in-postgresql-9-5/) feature to reliably dequeue jobs
- Supports [crontab](https://crontab.guru) syntax for complex scheduled jobs
- Written in [TypeScript](https://www.typescriptlang.org/) for static type checking with exported types along the library.
- Built by [tsup](https://tsup.egoist.dev) to provide both CommonJS and ESM packages.
## Install
```bash
npm install @mgcrea/prisma-queue --save
# or
pnpm add @mgcrea/prisma-queue
```
## Quickstart
1. If you use an old version of Prisma ranging from 2.29.0 to 4.6.1 (included), you must first add `"interactiveTransactions"` to your `schema.prisma` client configuration:
```prisma
generator client {
provider = "prisma-client-js"
previewFeatures = ["interactiveTransactions"]
}
```
1. Append the [`QueueJob` model](./prisma/schema.prisma) to your `schema.prisma` file
1. Create your queue
```ts
type JobPayload = { email: string };
type JobResult = { status: number };
export const emailQueue = createQueue({ name: "email" }, async (job, client) => {
const { id, payload } = job;
console.log(`Processing job#${id} with payload=${JSON.stringify(payload)})`);
// await someAsyncMethod();
await job.progress(50);
const status = 200;
if (Math.random() > 0.5) {
throw new Error(`Failed for some unknown reason`);
}
console.log(`Finished job#${id} with status=${status}`);
return { status };
});
```
- Queue a job
```ts
import { emailQueue } from "./emailQueue";
const main = async () => {
const job = await emailQueue.enqueue({ email: "foo@bar.com" });
};
main();
```
- Schedule a recurring job
```ts
import { emailQueue } from "./emailQueue";
const main = async () => {
const nextJob = await queue.schedule(
{ key: "email-schedule", cron: "5 5 * * *" },
{ email: "foo@bar.com" },
);
};
main();
```
- Start queue processing (usually in another process)
```ts
import { emailQueue } from "./emailQueue";
const main = async () => {
await queue.start();
};
main();
```
## Authors
- [Olivier Louvignes](https://github.com/mgcrea) <>
## Credits
Inspired by
- [pg-queue](https://github.com/OrKoN/pg-queue) by
[Alex Rudenko](https://github.com/OrKoN)
## License
```txt
The MIT License
Copyright (c) 2022 Olivier Louvignes
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```