Skip to content

Interface: PGBossAdapterConfiguration

Configuration for the PGBoss adapter.

See

PGBoss constructor documentation

Properties

PropertyTypeDescription
applicationName?stringThe name of the application using PGBoss. Defaults to 'pg-boss'.
connection| `postgres://${string}` | PostgreSQLConnectionObjectThe connection to the PostgreSQL database. It can be either a connection string or an object with connection options.
enforceEnqueueSequence?booleanWhether to enforce the sequence of job enqueueing. If set to true, jobs will be enqueued in the order they are provided. Defaults to false.
expirationOptions?PostgreSQLExpirationOptionsExpiration options for active jobs in PGBoss.
jobPollingOptions?PostgreSQLJobPollingOptionsJob polling options for the PGBoss instance.
maintenanceOptions?PostgreSQLMaintenanceOptionsMaintenance options for the PGBoss instance.
maxConnections?numberMaximum number of connections that will be shared by all operations in this instance. If not specified, it defaults to 10.
queueOptions?PostgreSQLQueueOptionsConnection-level options for queues
retentionOptions?PostgreSQLRetentionOptionsRetention options for PGBoss jobs.
retryOptions?PostgreSQLRetryOptionsRetry options for PGBoss jobs.
schedulingOptions?PostgreSQLSchedulingOptionsScheduling options for the PGBoss instance.
schema?stringThe schema to use for the PGBoss tables. If not specified, it defaults to 'pgboss'.