pg-boss 10.3.3 → 10.4.1

package/dist/migrationStore.d.ts

@@ -0,0 +1,7 @@
+import * as types from './types.ts';
+declare function rollback(schema: string, version: number, migrations?: types.Migration[]): string;
+declare function next(schema: string, version: number, migrations: types.Migration[] | undefined): string;
+declare function migrate(schema: string, version: number, migrations?: types.Migration[]): string;
+declare function getAll(schema: string): types.Migration[];
+export { rollback, next, migrate, getAll, };
+//# sourceMappingURL=migrationStore.d.ts.map

package/dist/migrationStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrationStore.d.ts","sourceRoot":"","sources":["../src/migrationStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AASnC,iBAAS,QAAQ,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,UAQjF;AAED,iBAAS,IAAI,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,SAAS,EAAE,GAAG,SAAS,UAQxF;AAED,iBAAS,OAAO,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,UAuBhF;AAED,iBAAS,MAAM,CAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAkYlD;AAED,OAAO,EACL,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,MAAM,GACP,CAAA"}

package/dist/migrationStore.js

@@ -0,0 +1,425 @@
+import assert from 'node:assert';
+import * as plans from "./plans.js";
+import * as types from "./types.js";
+function flatten(schema, commands, version) {
+    commands.unshift(plans.assertMigration(schema, version));
+    commands.push(plans.setVersion(schema, version));
+    return plans.locked(schema, commands);
+}
+function rollback(schema, version, migrations) {
+    migrations = migrations || getAll(schema);
+    const result = migrations.find(i => i.version === version);
+    assert(result, `Version ${version} not found.`);
+    return flatten(schema, result.uninstall || [], result.previous);
+}
+function next(schema, version, migrations) {
+    migrations = migrations || getAll(schema);
+    const result = migrations.find(i => i.previous === version);
+    assert(result, `Version ${version} not found.`);
+    return flatten(schema, result.install, result.version);
+}
+function migrate(schema, version, migrations) {
+    migrations = migrations || getAll(schema);
+    const result = migrations
+        .filter(i => i.previous >= version)
+        .sort((a, b) => a.version - b.version)
+        .reduce((acc, migration) => {
+        acc.install = acc.install.concat(migration.install);
+        if (migration.async) {
+            const bamCommands = migration.async.map(cmd => cmd.replace(/\$VERSION\$/g, String(migration.version)));
+            acc.install = acc.install.concat(bamCommands);
+        }
+        acc.version = migration.version;
+        return acc;
+    }, { install: [], version });
+    assert(result.install.length > 0, `Version ${version} not found.`);
+    return flatten(schema, result.install, result.version);
+}
+function getAll(schema) {
+    return [
+        {
+            release: '11.1.0',
+            version: 26,
+            previous: 25,
+            install: [
+                `
+        CREATE OR REPLACE FUNCTION ${schema}.create_queue(queue_name text, options jsonb)
+        RETURNS VOID AS
+        $$
+        DECLARE
+          tablename varchar := CASE WHEN options->>'partition' = 'true'
+                                THEN 'j' || encode(sha224(queue_name::bytea), 'hex')
+                                ELSE 'job_common'
+                                END;
+          queue_created_on timestamptz;
+        BEGIN
+
+          WITH q as (
+            INSERT INTO ${schema}.queue (
+              name,
+              policy,
+              retry_limit,
+              retry_delay,
+              retry_backoff,
+              retry_delay_max,
+              expire_seconds,
+              retention_seconds,
+              deletion_seconds,
+              warning_queued,
+              dead_letter,
+              partition,
+              table_name
+            )
+            VALUES (
+              queue_name,
+              options->>'policy',
+              COALESCE((options->>'retryLimit')::int, 2),
+              COALESCE((options->>'retryDelay')::int, 0),
+              COALESCE((options->>'retryBackoff')::bool, false),
+              (options->>'retryDelayMax')::int,
+              COALESCE((options->>'expireInSeconds')::int, 900),
+              COALESCE((options->>'retentionSeconds')::int, 1209600),
+              COALESCE((options->>'deleteAfterSeconds')::int, 604800),
+              COALESCE((options->>'warningQueueSize')::int, 0),
+              options->>'deadLetter',
+              COALESCE((options->>'partition')::bool, false),
+              tablename
+            )
+            ON CONFLICT DO NOTHING
+            RETURNING created_on
+          )
+          SELECT created_on into queue_created_on from q;
+
+          IF queue_created_on IS NULL OR options->>'partition' IS DISTINCT FROM 'true' THEN
+            RETURN;
+          END IF;
+
+          EXECUTE format('CREATE TABLE ${schema}.%I (LIKE ${schema}.job INCLUDING DEFAULTS)', tablename);
+
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD PRIMARY KEY (name, id)', tablename);
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD CONSTRAINT q_fkey FOREIGN KEY (name) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED', tablename);
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD CONSTRAINT dlq_fkey FOREIGN KEY (dead_letter) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED', tablename);
+
+          EXECUTE format('CREATE INDEX %1$s_i5 ON ${schema}.%1$I (name, start_after) INCLUDE (priority, created_on, id) WHERE state < ''active''', tablename);
+          EXECUTE format('CREATE UNIQUE INDEX %1$s_i4 ON ${schema}.%1$I (name, singleton_on, COALESCE(singleton_key, '''')) WHERE state <> ''cancelled'' AND singleton_on IS NOT NULL', tablename);
+
+          IF options->>'policy' = 'short' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i1 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state = ''created'' AND policy = ''short''', tablename);
+          ELSIF options->>'policy' = 'singleton' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i2 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state = ''active'' AND policy = ''singleton''', tablename);
+          ELSIF options->>'policy' = 'stately' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i3 ON ${schema}.%1$I (name, state, COALESCE(singleton_key, '''')) WHERE state <= ''active'' AND policy = ''stately''', tablename);
+          ELSIF options->>'policy' = 'exclusive' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i6 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state <= ''active'' AND policy = ''exclusive''', tablename);
+          END IF;
+
+          EXECUTE format('ALTER TABLE ${schema}.%I ADD CONSTRAINT cjc CHECK (name=%L)', tablename, queue_name);
+          EXECUTE format('ALTER TABLE ${schema}.job ATTACH PARTITION ${schema}.%I FOR VALUES IN (%L)', tablename, queue_name);
+        END;
+        $$
+        LANGUAGE plpgsql;
+        `,
+                `CREATE UNIQUE INDEX job_i6 ON ${schema}.job_common (name, COALESCE(singleton_key, '')) WHERE state <= 'active' AND policy = 'exclusive'`
+            ],
+            uninstall: [
+                `DROP INDEX ${schema}.job_i6`
+            ]
+        },
+        {
+            release: '12.6.0',
+            version: 27,
+            previous: 26,
+            install: [
+                `ALTER TABLE ${schema}.version ADD COLUMN IF NOT EXISTS bam_on timestamp with time zone`,
+                `
+        CREATE TABLE IF NOT EXISTS ${schema}.bam (
+          id uuid PRIMARY KEY default gen_random_uuid(),
+          name text NOT NULL,
+          version int NOT NULL,
+          status text NOT NULL DEFAULT 'pending',
+          queue text,
+          table_name text NOT NULL,
+          command text NOT NULL,
+          error text,
+          created_on timestamp with time zone NOT NULL DEFAULT now(),
+          started_on timestamp with time zone,
+          completed_on timestamp with time zone
+        )
+        `,
+                `CREATE FUNCTION ${schema}.job_table_format(command text, table_name text)
+          RETURNS text AS
+          $$
+            SELECT format(
+              replace(
+                replace(command, '.job', '.%1$I'),
+                'job_i', '%1$s_i'
+              ),
+              table_name
+            );
+          $$
+          LANGUAGE sql IMMUTABLE;
+        `,
+                `
+        CREATE OR REPLACE FUNCTION ${schema}.job_table_run_async(command_name text, version int, command text, tbl_name text DEFAULT NULL, queue_name text DEFAULT NULL)
+        RETURNS VOID AS
+        $$
+        BEGIN
+          IF queue_name IS NOT NULL THEN
+            SELECT table_name INTO tbl_name FROM ${schema}.queue WHERE name = queue_name;
+          END IF;
+
+          IF tbl_name IS NOT NULL THEN
+            INSERT INTO ${schema}.bam (name, version, status, queue, table_name, command)
+            VALUES (
+              command_name,
+              version,
+              'pending',
+              queue_name,
+              tbl_name,
+              ${schema}.job_table_format(command, tbl_name)
+            );
+            RETURN;
+          END IF;
+
+          INSERT INTO ${schema}.bam (name, version, status, queue, table_name, command)
+          SELECT
+            command_name,
+            version,
+            'pending',
+            NULL,
+            'job_common',
+            ${schema}.job_table_format(command, 'job_common')
+          UNION ALL
+          SELECT
+            command_name,
+            version,
+            'pending',
+            queue.name,
+            queue.table_name,
+            ${schema}.job_table_format(command, queue.table_name)
+          FROM ${schema}.queue
+          WHERE partition = true;
+        END;
+        $$
+        LANGUAGE plpgsql;
+        `,
+                `
+        CREATE OR REPLACE FUNCTION ${schema}.job_table_run(command text, tbl_name text DEFAULT NULL, queue_name text DEFAULT NULL)
+        RETURNS VOID AS
+        $$
+        DECLARE
+          tbl RECORD;
+        BEGIN
+          IF queue_name IS NOT NULL THEN
+            SELECT table_name INTO tbl_name FROM ${schema}.queue WHERE name = queue_name;
+          END IF;
+
+          IF tbl_name IS NOT NULL THEN
+            EXECUTE ${schema}.job_table_format(command, tbl_name);
+            RETURN;
+          END IF;
+
+          EXECUTE ${schema}.job_table_format(command, 'job_common');
+
+          FOR tbl IN SELECT table_name FROM ${schema}.queue WHERE partition = true
+          LOOP
+            EXECUTE ${schema}.job_table_format(command, tbl.table_name);
+          END LOOP;
+        END;
+        $$
+        LANGUAGE plpgsql;
+        `,
+                `ALTER TABLE ${schema}.job ADD COLUMN IF NOT EXISTS group_id text`,
+                `ALTER TABLE ${schema}.job ADD COLUMN IF NOT EXISTS group_tier text`,
+                `
+        CREATE OR REPLACE FUNCTION ${schema}.create_queue(queue_name text, options jsonb)
+        RETURNS VOID AS
+        $$
+        DECLARE
+          tablename varchar := CASE WHEN options->>'partition' = 'true'
+                                THEN 'j' || encode(sha224(queue_name::bytea), 'hex')
+                                ELSE 'job_common'
+                                END;
+          queue_created_on timestamptz;
+        BEGIN
+
+          WITH q as (
+            INSERT INTO ${schema}.queue (
+              name,
+              policy,
+              retry_limit,
+              retry_delay,
+              retry_backoff,
+              retry_delay_max,
+              expire_seconds,
+              retention_seconds,
+              deletion_seconds,
+              warning_queued,
+              dead_letter,
+              partition,
+              table_name
+            )
+            VALUES (
+              queue_name,
+              options->>'policy',
+              COALESCE((options->>'retryLimit')::int, 2),
+              COALESCE((options->>'retryDelay')::int, 0),
+              COALESCE((options->>'retryBackoff')::bool, false),
+              (options->>'retryDelayMax')::int,
+              COALESCE((options->>'expireInSeconds')::int, 900),
+              COALESCE((options->>'retentionSeconds')::int, 1209600),
+              COALESCE((options->>'deleteAfterSeconds')::int, 604800),
+              COALESCE((options->>'warningQueueSize')::int, 0),
+              options->>'deadLetter',
+              COALESCE((options->>'partition')::bool, false),
+              tablename
+            )
+            ON CONFLICT DO NOTHING
+            RETURNING created_on
+          )
+          SELECT created_on into queue_created_on from q;
+
+          IF queue_created_on IS NULL OR options->>'partition' IS DISTINCT FROM 'true' THEN
+            RETURN;
+          END IF;
+
+          EXECUTE format('CREATE TABLE ${schema}.%I (LIKE ${schema}.job INCLUDING DEFAULTS)', tablename);
+
+          EXECUTE ${schema}.job_table_format($cmd$ALTER TABLE ${schema}.job ADD PRIMARY KEY (name, id)$cmd$, tablename);
+          EXECUTE ${schema}.job_table_format($cmd$ALTER TABLE ${schema}.job ADD CONSTRAINT q_fkey FOREIGN KEY (name) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED$cmd$, tablename);
+          EXECUTE ${schema}.job_table_format($cmd$ALTER TABLE ${schema}.job ADD CONSTRAINT dlq_fkey FOREIGN KEY (dead_letter) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED$cmd$, tablename);
+
+          EXECUTE ${schema}.job_table_format($cmd$CREATE INDEX job_i5 ON ${schema}.job (name, start_after) INCLUDE (priority, created_on, id) WHERE state < 'active'$cmd$, tablename);
+          EXECUTE ${schema}.job_table_format($cmd$CREATE UNIQUE INDEX job_i4 ON ${schema}.job (name, singleton_on, COALESCE(singleton_key, '')) WHERE state <> 'cancelled' AND singleton_on IS NOT NULL$cmd$, tablename);
+          EXECUTE ${schema}.job_table_format($cmd$CREATE INDEX job_i7 ON ${schema}.job (name, group_id) WHERE state = 'active' AND group_id IS NOT NULL$cmd$, tablename);
+
+          IF options->>'policy' = 'short' THEN
+            EXECUTE ${schema}.job_table_format($cmd$CREATE UNIQUE INDEX job_i1 ON ${schema}.job (name, COALESCE(singleton_key, '')) WHERE state = 'created' AND policy = 'short'$cmd$, tablename);
+          ELSIF options->>'policy' = 'singleton' THEN
+            EXECUTE ${schema}.job_table_format($cmd$CREATE UNIQUE INDEX job_i2 ON ${schema}.job (name, COALESCE(singleton_key, '')) WHERE state = 'active' AND policy = 'singleton'$cmd$, tablename);
+          ELSIF options->>'policy' = 'stately' THEN
+            EXECUTE ${schema}.job_table_format($cmd$CREATE UNIQUE INDEX job_i3 ON ${schema}.job (name, state, COALESCE(singleton_key, '')) WHERE state <= 'active' AND policy = 'stately'$cmd$, tablename);
+          ELSIF options->>'policy' = 'exclusive' THEN
+            EXECUTE ${schema}.job_table_format($cmd$CREATE UNIQUE INDEX job_i6 ON ${schema}.job (name, COALESCE(singleton_key, '')) WHERE state <= 'active' AND policy = 'exclusive'$cmd$, tablename);
+          END IF;
+
+          EXECUTE format('ALTER TABLE ${schema}.%I ADD CONSTRAINT cjc CHECK (name=%L)', tablename, queue_name);
+          EXECUTE format('ALTER TABLE ${schema}.job ATTACH PARTITION ${schema}.%I FOR VALUES IN (%L)', tablename, queue_name);
+        END;
+        $$
+        LANGUAGE plpgsql;
+        `,
+                `ALTER INDEX IF EXISTS ${schema}.job_i1 RENAME TO job_common_i1`,
+                `ALTER INDEX IF EXISTS ${schema}.job_i2 RENAME TO job_common_i2`,
+                `ALTER INDEX IF EXISTS ${schema}.job_i3 RENAME TO job_common_i3`,
+                `ALTER INDEX IF EXISTS ${schema}.job_i4 RENAME TO job_common_i4`,
+                `ALTER INDEX IF EXISTS ${schema}.job_i5 RENAME TO job_common_i5`,
+                `ALTER INDEX IF EXISTS ${schema}.job_i6 RENAME TO job_common_i6`,
+                `ALTER INDEX IF EXISTS ${schema}.job_i7 RENAME TO job_common_i7`
+            ],
+            async: [
+                `SELECT ${schema}.job_table_run_async(
+          'group_concurency_index',
+          $VERSION$,
+          $$
+          CREATE INDEX CONCURRENTLY job_i7 ON ${schema}.job (name, group_id) WHERE state = 'active' AND group_id IS NOT NULL
+          $$
+        )`
+            ],
+            uninstall: [
+                `ALTER INDEX ${schema}.job_common_i6 RENAME TO job_i6`,
+                `ALTER INDEX ${schema}.job_common_i5 RENAME TO job_i5`,
+                `ALTER INDEX ${schema}.job_common_i4 RENAME TO job_i4`,
+                `ALTER INDEX ${schema}.job_common_i3 RENAME TO job_i3`,
+                `ALTER INDEX ${schema}.job_common_i2 RENAME TO job_i2`,
+                `ALTER INDEX ${schema}.job_common_i1 RENAME TO job_i1`,
+                `SELECT ${schema}.job_table_run('DROP INDEX ${schema}.job_i7')`,
+                `
+        CREATE OR REPLACE FUNCTION ${schema}.create_queue(queue_name text, options jsonb)
+        RETURNS VOID AS
+        $$
+        DECLARE
+          tablename varchar := CASE WHEN options->>'partition' = 'true'
+                                THEN 'j' || encode(sha224(queue_name::bytea), 'hex')
+                                ELSE 'job_common'
+                                END;
+          queue_created_on timestamptz;
+        BEGIN
+
+          WITH q as (
+            INSERT INTO ${schema}.queue (
+              name,
+              policy,
+              retry_limit,
+              retry_delay,
+              retry_backoff,
+              retry_delay_max,
+              expire_seconds,
+              retention_seconds,
+              deletion_seconds,
+              warning_queued,
+              dead_letter,
+              partition,
+              table_name
+            )
+            VALUES (
+              queue_name,
+              options->>'policy',
+              COALESCE((options->>'retryLimit')::int, 2),
+              COALESCE((options->>'retryDelay')::int, 0),
+              COALESCE((options->>'retryBackoff')::bool, false),
+              (options->>'retryDelayMax')::int,
+              COALESCE((options->>'expireInSeconds')::int, 900),
+              COALESCE((options->>'retentionSeconds')::int, 1209600),
+              COALESCE((options->>'deleteAfterSeconds')::int, 604800),
+              COALESCE((options->>'warningQueueSize')::int, 0),
+              options->>'deadLetter',
+              COALESCE((options->>'partition')::bool, false),
+              tablename
+            )
+            ON CONFLICT DO NOTHING
+            RETURNING created_on
+          )
+          SELECT created_on into queue_created_on from q;
+
+          IF queue_created_on IS NULL OR options->>'partition' IS DISTINCT FROM 'true' THEN
+            RETURN;
+          END IF;
+
+          EXECUTE format('CREATE TABLE ${schema}.%I (LIKE ${schema}.job INCLUDING DEFAULTS)', tablename);
+
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD PRIMARY KEY (name, id)', tablename);
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD CONSTRAINT q_fkey FOREIGN KEY (name) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED', tablename);
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD CONSTRAINT dlq_fkey FOREIGN KEY (dead_letter) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED', tablename);
+
+          EXECUTE format('CREATE INDEX %1$s_i5 ON ${schema}.%1$I (name, start_after) INCLUDE (priority, created_on, id) WHERE state < ''active''', tablename);
+          EXECUTE format('CREATE UNIQUE INDEX %1$s_i4 ON ${schema}.%1$I (name, singleton_on, COALESCE(singleton_key, '''')) WHERE state <> ''cancelled'' AND singleton_on IS NOT NULL', tablename);
+
+          IF options->>'policy' = 'short' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i1 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state = ''created'' AND policy = ''short''', tablename);
+          ELSIF options->>'policy' = 'singleton' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i2 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state = ''active'' AND policy = ''singleton''', tablename);
+          ELSIF options->>'policy' = 'stately' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i3 ON ${schema}.%1$I (name, state, COALESCE(singleton_key, '''')) WHERE state <= ''active'' AND policy = ''stately''', tablename);
+          ELSIF options->>'policy' = 'exclusive' THEN
+            EXECUTE format('CREATE UNIQUE INDEX %1$s_i6 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state <= ''active'' AND policy = ''exclusive''', tablename);
+          END IF;
+
+          EXECUTE format('ALTER TABLE ${schema}.%I ADD CONSTRAINT cjc CHECK (name=%L)', tablename, queue_name);
+          EXECUTE format('ALTER TABLE ${schema}.job ATTACH PARTITION ${schema}.%I FOR VALUES IN (%L)', tablename, queue_name);
+        END;
+        $$
+        LANGUAGE plpgsql;
+        `,
+                `DROP FUNCTION ${schema}.job_table_run(text, text, text)`,
+                `DROP FUNCTION ${schema}.job_table_run_async(text, int, text, text, text)`,
+                `DROP FUNCTION ${schema}.job_table_format(text, text)`,
+                `DROP TABLE ${schema}.bam`,
+                `ALTER TABLE ${schema}.version DROP COLUMN bam_on`,
+                `ALTER TABLE ${schema}.job DROP COLUMN group_tier`,
+                `ALTER TABLE ${schema}.job DROP COLUMN group_id`
+            ]
+        }
+    ];
+}
+export { rollback, next, migrate, getAll, };

package/dist/plans.d.ts

@@ -0,0 +1,102 @@
+import type { UpdateQueueOptions } from './types.ts';
+export interface SqlQuery {
+    text: string;
+    values: unknown[];
+}
+declare const DEFAULT_SCHEMA = "pgboss";
+declare const MIGRATE_RACE_MESSAGE = "division by zero";
+declare const CREATE_RACE_MESSAGE = "already exists";
+declare const JOB_STATES: Readonly<{
+    created: "created";
+    retry: "retry";
+    active: "active";
+    completed: "completed";
+    cancelled: "cancelled";
+    failed: "failed";
+}>;
+declare const QUEUE_POLICIES: Readonly<{
+    standard: "standard";
+    short: "short";
+    singleton: "singleton";
+    stately: "stately";
+    exclusive: "exclusive";
+}>;
+declare function create(schema: string, version: number, options?: {
+    createSchema?: boolean;
+}): string;
+declare function createQueue(schema: string, name: string, options: unknown): string;
+declare function deleteQueue(schema: string, name: string): string;
+declare function trySetQueueMonitorTime(schema: string, queues: string[], seconds: number): SqlQuery;
+declare function trySetQueueDeletionTime(schema: string, queues: string[], seconds: number): SqlQuery;
+declare function trySetCronTime(schema: string, seconds: number): string;
+declare function trySetBamTime(schema: string, seconds: number): string;
+declare function updateQueue(schema: string, { deadLetter }?: UpdateQueueOptions): string;
+declare function getQueues(schema: string, names?: string[]): SqlQuery;
+declare function deleteJobsById(schema: string, table: string): string;
+declare function deleteQueuedJobs(schema: string, table: string): string;
+declare function deleteStoredJobs(schema: string, table: string): string;
+declare function truncateTable(schema: string, table: string): string;
+declare function deleteAllJobs(schema: string, table: string): string;
+declare function getSchedules(schema: string): string;
+declare function getSchedulesByQueue(schema: string): string;
+declare function schedule(schema: string): string;
+declare function unschedule(schema: string): string;
+declare function subscribe(schema: string): string;
+declare function unsubscribe(schema: string): string;
+declare function getQueuesForEvent(schema: string): string;
+declare function getTime(): string;
+declare function getVersion(schema: string): string;
+declare function setVersion(schema: string, version: number): string;
+declare function versionTableExists(schema: string): string;
+declare function insertVersion(schema: string, version: number): string;
+interface GroupConcurrencyConfig {
+    default: number;
+    tiers?: Record<string, number>;
+}
+interface FetchJobOptions {
+    schema: string;
+    table: string;
+    name: string;
+    policy: string | undefined;
+    limit: number;
+    includeMetadata?: boolean;
+    priority?: boolean;
+    orderByCreatedOn?: boolean;
+    ignoreStartAfter?: boolean;
+    ignoreSingletons: string[] | null;
+    ignoreGroups?: string[] | null;
+    groupConcurrency?: number | GroupConcurrencyConfig;
+}
+declare function fetchNextJob(options: FetchJobOptions): SqlQuery;
+declare function completeJobs(schema: string, table: string): string;
+declare function cancelJobs(schema: string, table: string): string;
+declare function resumeJobs(schema: string, table: string): string;
+declare function restoreJobs(schema: string, table: string): string;
+interface InsertJobsOptions {
+    table: string;
+    name: string;
+    returnId?: boolean;
+}
+declare function insertJobs(schema: string, { table, name, returnId }: InsertJobsOptions): string;
+declare function failJobsById(schema: string, table: string): string;
+declare function failJobsByTimeout(schema: string, table: string, queues: string[]): string;
+declare function deletion(schema: string, table: string, queues: string[]): string;
+declare function retryJobs(schema: string, table: string): string;
+declare function getQueueStats(schema: string, table: string, queues: string[]): SqlQuery;
+declare function cacheQueueStats(schema: string, table: string, queues: string[]): string;
+declare function locked(schema: string, query: string | string[], key?: string): string;
+declare function assertMigration(schema: string, version: number): string;
+declare function findJobs(schema: string, table: string, options: {
+    queued: boolean;
+    byKey: boolean;
+    byData: boolean;
+    byId: boolean;
+}): string;
+declare function getJobById(schema: string, table: string): string;
+declare function getNextBamCommand(schema: string): string;
+declare function setBamCompleted(schema: string, id: string): string;
+declare function setBamFailed(schema: string, id: string, error: string): string;
+declare function getBamStatus(schema: string): string;
+declare function getBamEntries(schema: string): string;
+export { create, insertVersion, getVersion, setVersion, versionTableExists, fetchNextJob, completeJobs, cancelJobs, resumeJobs, restoreJobs, retryJobs, findJobs, deleteJobsById, deleteAllJobs, deleteQueuedJobs, deleteStoredJobs, truncateTable, failJobsById, failJobsByTimeout, insertJobs, getTime, getSchedules, getSchedulesByQueue, schedule, unschedule, subscribe, unsubscribe, getQueuesForEvent, deletion, cacheQueueStats, updateQueue, createQueue, deleteQueue, getQueues, getQueueStats, trySetQueueMonitorTime, trySetQueueDeletionTime, trySetCronTime, trySetBamTime, locked, assertMigration, getJobById, getNextBamCommand, setBamCompleted, setBamFailed, getBamStatus, getBamEntries, QUEUE_POLICIES, JOB_STATES, MIGRATE_RACE_MESSAGE, CREATE_RACE_MESSAGE, DEFAULT_SCHEMA, };
+//# sourceMappingURL=plans.d.ts.map

package/dist/plans.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../src/plans.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,EAAE,CAAA;CAClB;AAED,QAAA,MAAM,cAAc,WAAW,CAAA;AAC/B,QAAA,MAAM,oBAAoB,qBAAqB,CAAA;AAC/C,QAAA,MAAM,mBAAmB,mBAAmB,CAAA;AAM5C,QAAA,MAAM,UAAU;;;;;;;EAOd,CAAA;AAEF,QAAA,MAAM,cAAc;;;;;;EAMlB,CAAA;AAeF,iBAAS,MAAM,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,UA2BrF;AA4XD,iBAAS,WAAW,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,UAGnE;AAED,iBAAS,WAAW,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAGjD;AA0CD,iBAAS,sBAAsB,CAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,QAAQ,CAE5F;AAED,iBAAS,uBAAuB,CAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,QAAQ,CAE7F;AAED,iBAAS,cAAc,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAEvD;AAED,iBAAS,aAAa,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAEtD;AAwBD,iBAAS,WAAW,CAAE,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,GAAE,kBAAuB,UAuB5E;AAED,iBAAS,SAAS,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,QAAQ,CA8B9D;AAED,iBAAS,cAAc,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAUrD;AAED,iBAAS,gBAAgB,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAEvD;AAED,iBAAS,gBAAgB,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAEvD;AAED,iBAAS,aAAa,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAEpD;AAED,iBAAS,aAAa,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAEpD;AAED,iBAAS,YAAY,CAAE,MAAM,EAAE,MAAM,UAEpC;AAED,iBAAS,mBAAmB,CAAE,MAAM,EAAE,MAAM,UAE3C;AAED,iBAAS,QAAQ,CAAE,MAAM,EAAE,MAAM,UAWhC;AAED,iBAAS,UAAU,CAAE,MAAM,EAAE,MAAM,UAMlC;AAED,iBAAS,SAAS,CAAE,MAAM,EAAE,MAAM,UASjC;AAED,iBAAS,WAAW,CAAE,MAAM,EAAE,MAAM,UAKnC;AAED,iBAAS,iBAAiB,CAAE,MAAM,EAAE,MAAM,UAKzC;AAED,iBAAS,OAAO,WAEf;AAED,iBAAS,UAAU,CAAE,MAAM,EAAE,MAAM,UAElC;AAED,iBAAS,UAAU,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAEnD;AAED,iBAAS,kBAAkB,CAAE,MAAM,EAAE,MAAM,UAE1C;AAED,iBAAS,aAAa,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAEtD;AAED,UAAU,sBAAsB;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED,UAAU,eAAe;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,gBAAgB,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAA;CACnD;AAsDD,iBAAS,YAAY,CAAE,OAAO,EAAE,eAAe,GAAG,QAAQ,CAqGzD;AAED,iBAAS,YAAY,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAcnD;AAED,iBAAS,UAAU,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAajD;AAED,iBAAS,UAAU,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAajD;AAED,iBAAS,WAAW,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAOlD;AAED,UAAU,iBAAiB;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,iBAAS,UAAU,CAAE,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,QAAe,EAAE,EAAE,iBAAiB,UA2EvF;AAED,iBAAS,YAAY,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAKnD;AAED,iBAAS,iBAAiB,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAQnF;AA6JD,iBAAS,QAAQ,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAa1E;AAED,iBAAS,SAAS,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAahD;AAED,iBAAS,aAAa,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAgBjF;AAED,iBAAS,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CA0BjF;AAQD,iBAAS,MAAM,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAW/E;AAQD,iBAAS,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAGxD;AAED,iBAAS,QAAQ,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,UA+B7H;AAED,iBAAS,UAAU,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAOjD;AAED,iBAAS,iBAAiB,CAAE,MAAM,EAAE,MAAM,UAczC;AAED,iBAAS,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAMnD;AAED,iBAAS,YAAY,CAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAO/D;AAED,iBAAS,YAAY,CAAE,MAAM,EAAE,MAAM,UAMpC;AAED,iBAAS,aAAa,CAAE,MAAM,EAAE,MAAM,UAOrC;AAED,OAAO,EACL,MAAM,EACN,aAAa,EACb,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,UAAU,EACV,WAAW,EACX,SAAS,EACT,QAAQ,EACR,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,UAAU,EACV,OAAO,EACP,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,UAAU,EACV,SAAS,EACT,WAAW,EACX,iBAAiB,EACjB,QAAQ,EACR,eAAe,EACf,WAAW,EACX,WAAW,EACX,WAAW,EACX,SAAS,EACT,aAAa,EACb,sBAAsB,EACtB,uBAAuB,EACvB,cAAc,EACd,aAAa,EACb,MAAM,EACN,eAAe,EACf,UAAU,EACV,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,cAAc,EACd,UAAU,EACV,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,GACf,CAAA"}