@pidgeyjs/postgres

PostgreSQL adapter for Pidgey.

Installation

pnpm add @pidgeyjs/postgres @pidgeyjs/core pg

Usage

Configuration

import { PidgeyClient } from '@pidgeyjs/core';
import { PostgresQueueAdapter } from '@pidgeyjs/postgres';

const client = new PidgeyClient(
  new PostgresQueueAdapter({
    connectionString: process.env.DATABASE_URL,
    // Optional: schema name (default: public)
    schema: 'my_schema',
  })
);

Migrations

This adapter requires database tables to be created. You can use the Pidgey CLI to manage migrations.

# Create a new migration
pnpm exec pidgey-devkit create-migration

Or you can manually run the SQL files found in node_modules/@pidgeyjs/postgres/dist/migrations.

License

MIT