Skip to content

PostgresDeadLetterTransport

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:76

DeadLetterStore backed by Postgres (pg): inserts each dead letter as a row and keeps it, so it can be listed, redriven with DeadLetterRedriver, and resolved. Create the table once with createDeadLetterTableSql.

The table name is validated as a plain SQL identifier (it is interpolated, not parameterized); all values are bound parameters.

await pool.query(createDeadLetterTableSql());
const store = new PostgresDeadLetterTransport(pool);
const open = await store.list({ status: 'open' });

new PostgresDeadLetterTransport(db, options?): PostgresDeadLetterTransport

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:79

PostgresQueryableLike

PostgresDeadLetterTransportOptions = {}

PostgresDeadLetterTransport

claim(id, leaseMs): Promise<boolean>

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:134

Takes the open record for one redrive, in one atomic step, so that two redrives of one record cannot both dispatch it. The claim ends with recordAttempt or markResolved, or after leaseMs, which frees the record of a process that stopped during the handling.

string

number

How long the claim holds, in milliseconds.

Promise<boolean>

false when the record is absent, resolved or claimed.

DeadLetterStore.claim


get(id): Promise<DeadLetterRecord | undefined>

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:110

The record with this id, or undefined.

string

Promise<DeadLetterRecord | undefined>

DeadLetterStore.get


list(filter?): Promise<DeadLetterRecord[]>

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:117

Records matching the filter, oldest first.

DeadLetterListFilter = {}

Promise<DeadLetterRecord[]>

DeadLetterStore.list


markResolved(id): Promise<void>

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:153

Closes the record.

string

Promise<void>

DeadLetterStore.markResolved


recordAttempt(id, error): Promise<void>

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:146

Counts one failed redrive attempt, keeps its error and ends the claim.

string

DeadLetterError

Promise<void>

DeadLetterStore.recordAttempt


send(record): Promise<void>

Defined in: packages/pipeline-deadletter/src/transports/postgres.transport.ts:86

Persist / publish a single dead-letter record.

Implementations should be resilient and fast; a throw here is caught by the behavior and logged, but never masks the original handler error.

DeadLetterRecord

The failed request snapshot to forward.

Promise<void>

DeadLetterStore.send