@webda/postgres 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/postgresqueue.service.d.ts

@@ -0,0 +1,144 @@
+import { MessageReceipt, Queue, QueueParameters } from "@webda/core";
+import pg, { ClientConfig, PoolConfig } from "pg";
+/**
+ * Configuration for {@link PostgresQueueService}.
+ */
+export declare class PostgresQueueParameters extends QueueParameters {
+    /**
+     * Table name backing the queue. Auto-created on init if missing.
+     *
+     * @default "webda_queue"
+     * @pattern /^[a-zA-Z_][a-zA-Z0-9_]*$/
+     * @example "myapp_queue"
+     * @example "user_notifications"
+     * @example "cache_invalidation"
+     * @example "orders"
+     */
+    table?: string;
+    /**
+     * Visibility timeout in seconds — how long a locked-but-undeleted
+     * message stays invisible to other consumers before being eligible for
+     * redelivery. Workers that crash mid-process without acking will see
+     * their messages reappear after this window.
+     *
+     * @default 30
+     */
+    visibilityTimeout?: number;
+    /**
+     * Max number of messages pulled per `receiveMessage` call. The queue
+     * worker calls receiveMessage in a loop, so this is also the parallel
+     * batch size.
+     *
+     * @default 10
+     */
+    batchSize?: number;
+    /**
+     * Whether to use a `pg.Pool` (recommended for shared workloads) or a
+     * single `pg.Client`.
+     *
+     * @default true
+     */
+    usePool?: boolean;
+    /**
+     * Connection settings forwarded to the chosen pg client/pool. Defaults
+     * to PG* environment variables.
+     */
+    postgresqlServer?: ClientConfig | PoolConfig;
+    /**
+     * Whether to auto-create the queue table on init.
+     *
+     * @default true
+     */
+    autoCreateTable?: boolean;
+    /**
+     * @override
+     * @param params - the input parameters
+     * @returns this
+     */
+    load(params?: any): this;
+}
+/**
+ * Postgres-backed FIFO queue using `SELECT … FOR UPDATE SKIP LOCKED` (PG
+ * 9.5+) for atomic multi-worker pulls. A schema-managed table holds
+ * pending and locked rows; receive locks a batch atomically, delete (or
+ * the visibility-timeout sweep) clears them. No extra infrastructure
+ * needed beyond a Postgres connection — reuses the same DB you're
+ * already running for the store.
+ *
+ * Wire format: payload column is `jsonb` so messages survive
+ * round-tripping with their structure intact and can be queried directly
+ * if you ever need to inspect the queue.
+ *
+ * @WebdaModda PostgresQueue
+ */
+export default class PostgresQueueService<T = any, K extends PostgresQueueParameters = PostgresQueueParameters> extends Queue<T, K> {
+    /**
+     * Backing pg client or pool. Pools are preferred under load — receive
+     * locks rotate across connections and benefit from concurrency.
+     */
+    protected client?: pg.Client | pg.Pool;
+    /**
+     * True when {@link client} is a shared pool acquired from the registry.
+     * Drives the matching {@link releasePool} call in {@link stop}.
+     */
+    protected ownsPool: boolean;
+    /**
+     * Resolved table identifier. Validated at init to keep the table name
+     * out of any literal SQL paths that aren't parameterizable.
+     * @returns the table name
+     */
+    protected get table(): string;
+    /**
+     * @override
+     * @returns this service
+     */
+    init(): Promise<this>;
+    /**
+     * Create the queue table and the index that supports the SKIP LOCKED
+     * receive query, if they're missing.
+     */
+    protected ensureTable(): Promise<void>;
+    /**
+     * @override
+     * @param event - the event to enqueue
+     */
+    sendMessage(event: T): Promise<void>;
+    /**
+     * @override
+     * @returns count of messages currently visible (pending or expired-lock)
+     */
+    size(): Promise<number>;
+    /**
+     * @override
+     * @param proto - optional prototype to rehydrate the payload into
+     * @returns the locked batch
+     */
+    receiveMessage<L>(proto?: {
+        new (): L;
+    }): Promise<MessageReceipt<L>[]>;
+    /**
+     * @override
+     * @param id - the receipt handle returned by {@link receiveMessage}
+     */
+    deleteMessage(id: string): Promise<void>;
+    /**
+     * Override the queue's per-receive parallelism: receiveMessage already
+     * pulls a batch, so the consumer-spawning loop only needs one parent
+     * worker per `batchSize`.
+     *
+     * @override
+     * @returns the result number
+     */
+    getMaxConsumers(): number;
+    /**
+     * Convenience: drop and recreate the queue table. Used by tests; not
+     * for production. Mirrors the `__clean` hook on FileQueue.
+     */
+    __clean(): Promise<void>;
+    /**
+     * @override
+     */
+    stop(): Promise<void>;
+}
+export { PostgresQueueService };
+//# sourceMappingURL=postgresqueue.service.d.ts.map

package/lib/postgresqueue.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgresqueue.service.d.ts","sourceRoot":"","sources":["../src/postgresqueue.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGrE,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAGlD;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,eAAe;IAC1D;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;IAC7C;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAQ3B;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAoB,CACvC,CAAC,GAAG,GAAG,EACP,CAAC,SAAS,uBAAuB,GAAG,uBAAuB,CAC3D,SAAQ,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC;IACvC;;;OAGG;IACH,SAAS,CAAC,QAAQ,UAAS;IAE3B;;;;OAIG;IACH,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAgB1B;IAED;;;OAGG;IACH,UAAgB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAoB3C;IAED;;;OAGG;IACG,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAIzC;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAM5B;IAED;;;;OAIG;IACG,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CA2B3E;IAED;;;OAGG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG7C;IAED;;;;;;;OAOG;IACH,eAAe,IAAI,MAAM,CAExB;IAED;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAO7B;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAe1B;CACF;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/lib/postgresqueue.service.js

@@ -0,0 +1,210 @@
+import { Queue, QueueParameters } from "@webda/core";
+import { JSONUtils } from "@webda/utils";
+import { useLog } from "@webda/workout";
+import pg from "pg";
+import { acquirePool, releasePool } from "./pgpool.js";
+/**
+ * Configuration for {@link PostgresQueueService}.
+ */
+export class PostgresQueueParameters extends QueueParameters {
+    /**
+     * @override
+     * @param params - the input parameters
+     * @returns this
+     */
+    load(params = {}) {
+        super.load(params);
+        this.table ?? (this.table = "webda_queue");
+        this.visibilityTimeout ?? (this.visibilityTimeout = 30);
+        this.batchSize ?? (this.batchSize = 10);
+        this.usePool ?? (this.usePool = true);
+        this.autoCreateTable ?? (this.autoCreateTable = true);
+        return this;
+    }
+}
+/**
+ * Postgres-backed FIFO queue using `SELECT … FOR UPDATE SKIP LOCKED` (PG
+ * 9.5+) for atomic multi-worker pulls. A schema-managed table holds
+ * pending and locked rows; receive locks a batch atomically, delete (or
+ * the visibility-timeout sweep) clears them. No extra infrastructure
+ * needed beyond a Postgres connection — reuses the same DB you're
+ * already running for the store.
+ *
+ * Wire format: payload column is `jsonb` so messages survive
+ * round-tripping with their structure intact and can be queried directly
+ * if you ever need to inspect the queue.
+ *
+ * @WebdaModda PostgresQueue
+ */
+export default class PostgresQueueService extends Queue {
+    constructor() {
+        super(...arguments);
+        /**
+         * True when {@link client} is a shared pool acquired from the registry.
+         * Drives the matching {@link releasePool} call in {@link stop}.
+         */
+        this.ownsPool = false;
+    }
+    /**
+     * Resolved table identifier. Validated at init to keep the table name
+     * out of any literal SQL paths that aren't parameterizable.
+     * @returns the table name
+     */
+    get table() {
+        return this.parameters.table;
+    }
+    /**
+     * @override
+     * @returns this service
+     */
+    async init() {
+        await super.init();
+        if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(this.table)) {
+            throw new Error(`Invalid table name "${this.table}" — must match /^[a-zA-Z_][a-zA-Z0-9_]*$/`);
+        }
+        if (this.parameters.usePool) {
+            this.client = acquirePool(this.parameters.postgresqlServer);
+            this.ownsPool = true;
+        }
+        else {
+            this.client = new pg.Client(this.parameters.postgresqlServer);
+            await this.client.connect();
+        }
+        if (this.parameters.autoCreateTable) {
+            await this.ensureTable();
+        }
+        return this;
+    }
+    /**
+     * Create the queue table and the index that supports the SKIP LOCKED
+     * receive query, if they're missing.
+     */
+    async ensureTable() {
+        await this.client.query(`
+      CREATE TABLE IF NOT EXISTS ${this.table} (
+        id BIGSERIAL PRIMARY KEY,
+        payload JSONB NOT NULL,
+        created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
+        locked_until TIMESTAMPTZ
+      )
+    `);
+        // PG rejects STABLE functions like now() in index predicates ("functions
+        // in index predicate must be marked IMMUTABLE"), so the partial index
+        // covers only the unlocked half. Expired locks fall back to the
+        // sequential `locked_until < now()` filter at query time, which scans
+        // the (small) set of currently-locked rows. Pending rows — the hot path
+        // for healthy receive loops — get the index.
+        await this.client.query(`
+      CREATE INDEX IF NOT EXISTS ${this.table}_pending_idx
+      ON ${this.table} (id)
+      WHERE locked_until IS NULL
+    `);
+    }
+    /**
+     * @override
+     * @param event - the event to enqueue
+     */
+    async sendMessage(event) {
+        if (!this.client)
+            throw new Error("PostgresQueue not connected");
+        this.metrics?.messages_sent?.inc();
+        await this.client.query(`INSERT INTO ${this.table} (payload) VALUES ($1::jsonb)`, [JSONUtils.stringify(event)]);
+    }
+    /**
+     * @override
+     * @returns count of messages currently visible (pending or expired-lock)
+     */
+    async size() {
+        if (!this.client)
+            return 0;
+        const res = await this.client.query(`SELECT COUNT(*)::text AS count FROM ${this.table} WHERE locked_until IS NULL OR locked_until < now()`);
+        return Number.parseInt(res.rows[0].count, 10);
+    }
+    /**
+     * @override
+     * @param proto - optional prototype to rehydrate the payload into
+     * @returns the locked batch
+     */
+    async receiveMessage(proto) {
+        if (!this.client)
+            throw new Error("PostgresQueue not connected");
+        // Atomically lock a batch: lock_until is set to now() + visibilityTimeout
+        // for rows whose previous lock has expired (or that are pending). Other
+        // workers running this same query in parallel get the SKIP LOCKED
+        // semantics from the inner SELECT, so each row goes to exactly one
+        // worker per visibility window.
+        const visibilityMs = this.parameters.visibilityTimeout * 1000;
+        const res = await this.client.query(`
+      UPDATE ${this.table}
+      SET locked_until = now() + ($1::bigint || ' milliseconds')::interval
+      WHERE id IN (
+        SELECT id FROM ${this.table}
+        WHERE locked_until IS NULL OR locked_until < now()
+        ORDER BY id
+        FOR UPDATE SKIP LOCKED
+        LIMIT $2
+      )
+      RETURNING id, payload
+      `, [visibilityMs, this.parameters.batchSize]);
+        return res.rows.map(row => ({
+            ReceiptHandle: row.id,
+            Message: proto ? Object.assign(new proto(), row.payload) : row.payload
+        }));
+    }
+    /**
+     * @override
+     * @param id - the receipt handle returned by {@link receiveMessage}
+     */
+    async deleteMessage(id) {
+        if (!this.client)
+            throw new Error("PostgresQueue not connected");
+        await this.client.query(`DELETE FROM ${this.table} WHERE id = $1::bigint`, [id]);
+    }
+    /**
+     * Override the queue's per-receive parallelism: receiveMessage already
+     * pulls a batch, so the consumer-spawning loop only needs one parent
+     * worker per `batchSize`.
+     *
+     * @override
+     * @returns the result number
+     */
+    getMaxConsumers() {
+        return Math.max(1, Math.floor(this.parameters.maxConsumers / Math.max(this.parameters.batchSize, 1)));
+    }
+    /**
+     * Convenience: drop and recreate the queue table. Used by tests; not
+     * for production. Mirrors the `__clean` hook on FileQueue.
+     */
+    async __clean() {
+        if (!this.client)
+            return;
+        try {
+            await this.client.query(`TRUNCATE TABLE ${this.table} RESTART IDENTITY`);
+        }
+        catch (err) {
+            useLog("WARN", `PostgresQueue truncate failed: ${err.message}`);
+        }
+    }
+    /**
+     * @override
+     */
+    async stop() {
+        if (this.client) {
+            const client = this.client;
+            const owned = this.ownsPool;
+            this.client = undefined;
+            this.ownsPool = false;
+            if (owned) {
+                await releasePool(this.parameters.postgresqlServer);
+            }
+            else {
+                await client.end().catch(() => {
+                    /* already ended */
+                });
+            }
+        }
+        await super.stop();
+    }
+}
+export { PostgresQueueService };
+//# sourceMappingURL=postgresqueue.service.js.map

package/lib/postgresqueue.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgresqueue.service.js","sourceRoot":"","sources":["../src/postgresqueue.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAgC,MAAM,IAAI,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAgD1D;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAQ,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,aAAa,EAAC;QAC7B,IAAI,CAAC,iBAAiB,KAAtB,IAAI,CAAC,iBAAiB,GAAK,EAAE,EAAC;QAC9B,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,EAAE,EAAC;QACtB,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,EAAC;QACtB,IAAI,CAAC,eAAe,KAApB,IAAI,CAAC,eAAe,GAAK,IAAI,EAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,OAAO,oBAGnB,SAAQ,KAAW;IAHrB;;QASE;;;WAGG;QACO,aAAQ,GAAG,KAAK,CAAC;IAwK7B,CAAC;IAtKC;;;;OAIG;IACH,IAAc,KAAK;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAM,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,KAAK,2CAA2C,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,gBAA8B,CAAC,CAAC;YAC1E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgC,CAAC,CAAC;YAC9E,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YACpC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,WAAW;QACzB,MAAM,IAAI,CAAC,MAAO,CAAC,KAAK,CAAC;mCACM,IAAI,CAAC,KAAK;;;;;;KAMxC,CAAC,CAAC;QACH,yEAAyE;QACzE,sEAAsE;QACtE,gEAAgE;QAChE,sEAAsE;QACtE,wEAAwE;QACxE,6CAA6C;QAC7C,MAAM,IAAI,CAAC,MAAO,CAAC,KAAK,CAAC;mCACM,IAAI,CAAC,KAAK;WAClC,IAAI,CAAC,KAAK;;KAEhB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,KAAQ;QACxB,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjE,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC;QACnC,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,+BAA+B,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,CAAC;QAC3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACjC,uCAAuC,IAAI,CAAC,KAAK,qDAAqD,CACvG,CAAC;QACF,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAI,KAAqB;QAC3C,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjE,0EAA0E;QAC1E,wEAAwE;QACxE,kEAAkE;QAClE,mEAAmE;QACnE,gCAAgC;QAChC,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAkB,GAAG,IAAI,CAAC;QAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACjC;eACS,IAAI,CAAC,KAAK;;;yBAGA,IAAI,CAAC,KAAK;;;;;;;OAO5B,EACD,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAC1C,CAAC;QACF,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC1B,aAAa,EAAE,GAAG,CAAC,EAAE;YACrB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,OAAa;SAC9E,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,wBAAwB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;OAOG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,SAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO;QACzB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,IAAI,CAAC,KAAK,mBAAmB,CAAC,CAAC;QAC3E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,MAAM,EAAE,kCAAmC,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,gBAA8B,CAAC,CAAC;YACpE,CAAC;iBAAM,CAAC;gBACN,MAAO,MAAoB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;oBAC3C,mBAAmB;gBACrB,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IACrB,CAAC;CACF;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/lib/postgresstore.service.d.ts

@@ -0,0 +1,132 @@
+import type { ModelClass, Repository } from "@webda/core";
+import pg, { ClientConfig, PoolConfig } from "pg";
+import { PostgresRepository, SQLStore, SQLStoreParameters } from "./sqlstore.js";
+/**
+ *
+ */
+export declare class PostgresParameters extends SQLStoreParameters {
+    /**
+     * @default false
+     */
+    usePool?: boolean;
+    /**
+     * By default use environment variables
+     */
+    postgresqlServer?: ClientConfig | PoolConfig;
+    /**
+     * Auto create table if not exists
+     * @default true
+     */
+    autoCreateTable?: boolean;
+    /**
+     * View name prefix
+     * @default ""
+     * @pattern /^[a-zA-Z_][a-zA-Z0-9_]*$/
+     * @example "app_"
+     * @example "v_"
+     * @example "view_"
+     */
+    viewPrefix?: string;
+    /**
+     * Regexp patterns of model identifiers to include when generating views
+     *
+     * @default [".*"]
+     */
+    views?: string[];
+    /**
+     * Per-model table name overrides.
+     * Maps a model identifier (e.g. "Webda/User") to a custom table name.
+     * When not specified, defaults are: primary model → `table`, others → identifier lowercased with "/" → "_".
+     */
+    tables?: {
+        [modelIdentifier: string]: string;
+    };
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params: any): this;
+}
+/**
+ * Store data within PostgreSQL with JSONB
+ *
+ * The table should be created before with
+ *
+ * ```sql
+ * CREATE TABLE IF NOT EXISTS ${tableName}
+ * (
+ *   uuid uuid NOT NULL,
+ *   data jsonb,
+ *   CONSTRAINT ${tableName}_pkey PRIMARY KEY (uuid)
+ * );
+ * ```
+ *
+ * @WebdaModda
+ */
+export declare class PostgresStore<K extends PostgresParameters = PostgresParameters> extends SQLStore<K> {
+    client: pg.Client | pg.Pool;
+    /**
+     * True when {@link client} is a shared pool acquired from the registry.
+     * Tracked so {@link stop} only releases pools it took a refcount on.
+     */
+    protected ownsPool: boolean;
+    /**
+     * @override
+     */
+    init(): Promise<this>;
+    /**
+     * @override
+     */
+    stop(): Promise<void>;
+    /**
+     * Resolve the table name for a given model class.
+     *
+     * Resolution order:
+     * 1. `parameters.tables[meta.Identifier]` — explicit per-model override
+     * 2. Single-model back-compat: when only one model is configured, `parameters.table` maps to it
+     * 3. Default — model identifier lowercased with "/" replaced by "_"
+     *
+     * @param model - the model class to resolve the table for
+     * @returns the table name
+     */
+    resolveTable(model: ModelClass): string;
+    /**
+     * Ensure all managed model tables exist (one per model in the hierarchy).
+     * When `autoCreateTable` is false, this is a no-op.
+     */
+    checkTable(): Promise<void>;
+    /**
+     * Return the postgresql client
+     * @returns the pg client or pool
+     */
+    getClient(): import("pg").Client | import("pg").Pool;
+    /**
+     * Build and return a PostgresRepository for the given model, using the
+     * per-model table name resolved by `resolveTable`.
+     *
+     * The result is cached per model class via `@InstanceCache`.
+     * @param model - the model class
+     * @returns a repository backed by this store's pg connection
+     */
+    getRepository<T extends ModelClass>(model: T): Repository<T>;
+    /**
+     * Return the underlying PostgresRepository for each model this store manages,
+     * unwrapping the EventRepository produced by {@link getRepository}.
+     * @returns the per-model PostgresRepository instances
+     */
+    getRepositories(): PostgresRepository<any>[];
+    /**
+     * Create views for each model that is stored in a PostgresStore.
+     *
+     * Creates one SQL VIEW per model (or model subclass) that maps the JSONB
+     * `data` column to typed columns based on the model's stored JSON schema.
+     */
+    createViews(): Promise<void>;
+    /**
+     * Delete all rows from all managed tables (used in tests).
+     */
+    __clean(): Promise<void>;
+}
+export default PostgresStore;
+//# sourceMappingURL=postgresstore.service.d.ts.map

package/lib/postgresstore.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgresstore.service.d.ts","sourceRoot":"","sources":["../src/postgresstore.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAElD,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAcjF;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,kBAAkB;IACxD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;IAC7C;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE/C;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAQtB;CACF;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,CAAE,SAAQ,QAAQ,CAAC,CAAC,CAAC;IAC/F,MAAM,EAAE,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC;IAC5B;;;OAGG;IACH,SAAS,CAAC,QAAQ,UAAS;IAE3B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAiB1B;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAW1B;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAetC;IAED;;;OAGG;IACG,UAAU,kBAef;IAED;;;OAGG;IACH,SAAS,4CAER;IAED;;;;;;;OAOG;IAEH,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAO3D;IAED;;;;OAIG;IACH,eAAe,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAgB3C;IAED;;;;;OAKG;IACG,WAAW,kBA2DhB;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAe7B;CACF;eAEc,aAAa"}