@supabase/pg-delta 0.0.0 → 1.0.0-alpha.0

package/dist/core/objects/subscription/utils.js

@@ -0,0 +1,112 @@
+// src/objects/subscription/utils.ts
+import { quoteLiteral } from "../base.change.js";
+/**
+ * Resolve the textual value we should emit for a given subscription option.
+ *
+ * Each branch encodes the quirks we already normalize in the model. For example,
+ * `slot_name` collapses to `NONE` when the subscription was extracted without an
+ * associated logical slot, while `streaming` stays free-form because PG 17+ allows
+ * enumerated values (`on`/`off`/`parallel`).
+ */
+function getSubscriptionOptionValue(subscription, option) {
+    switch (option) {
+        case "slot_name": {
+            if (subscription.slot_is_none)
+                return "NONE";
+            if (subscription.slot_name)
+                return quoteLiteral(subscription.slot_name);
+            return quoteLiteral(subscription.raw_name);
+        }
+        case "binary":
+            return subscription.binary ? "true" : "false";
+        case "streaming":
+            return quoteLiteral(subscription.streaming);
+        case "synchronous_commit":
+            return quoteLiteral(subscription.synchronous_commit);
+        case "disable_on_error":
+            return subscription.disable_on_error ? "true" : "false";
+        case "password_required":
+            return subscription.password_required ? "true" : "false";
+        case "run_as_owner":
+            return subscription.run_as_owner ? "true" : "false";
+        case "origin":
+            return quoteLiteral(subscription.origin);
+        case "failover":
+            return subscription.failover ? "true" : "false";
+        default: {
+            const _exhaustive = option;
+            return _exhaustive;
+        }
+    }
+}
+/**
+ * Convenience helper used by ALTER change classes. It stitches the option key/value
+ * into the canonical `"key = value"` form that PostgreSQL expects.
+ */
+export function formatSubscriptionOption(subscription, option) {
+    return `${option} = ${getSubscriptionOptionValue(subscription, option)}`;
+}
+/**
+ * Collect all options that should accompany a CREATE/ALTER statement.
+ *
+ * This routine encapsulates the nuanced logic around default slot handling and
+ * version-dependent fields:
+ *  - When `includeEnabled` is true we emit `enabled = false` for disabled subs so that
+ *    recreating them does not inadvertently enable replication.
+ *  - When we know no replication slot exists we force `slot_name = NONE`, plus
+ *    `connect = false` / `create_slot = false` in the caller.
+ *  - Optional flags (`streaming`, `password_required`, `origin`, etc.) are emitted only
+ *    when their value deviates from the PostgreSQL defaults.
+ *
+ * Callers can toggle `includeTwoPhase` / `includeEnabled` to opt-in to those
+ * adjustments depending on which statement is being generated.
+ */
+export function collectSubscriptionOptions(subscription, { includeEnabled = false, includeTwoPhase = false } = {}) {
+    const entries = [];
+    if (includeEnabled && !subscription.enabled) {
+        entries.push({ key: "enabled", value: "false" });
+    }
+    if (subscription.slot_is_none) {
+        entries.push({ key: "slot_name", value: "NONE" });
+    }
+    else if (subscription.slot_name) {
+        entries.push({
+            key: "slot_name",
+            value: quoteLiteral(subscription.slot_name),
+        });
+    }
+    if (subscription.binary) {
+        entries.push({ key: "binary", value: "true" });
+    }
+    if (subscription.streaming !== "off") {
+        entries.push({
+            key: "streaming",
+            value: quoteLiteral(subscription.streaming),
+        });
+    }
+    if (subscription.synchronous_commit !== "off") {
+        entries.push({
+            key: "synchronous_commit",
+            value: quoteLiteral(subscription.synchronous_commit),
+        });
+    }
+    if (includeTwoPhase && subscription.two_phase) {
+        entries.push({ key: "two_phase", value: "true" });
+    }
+    if (subscription.disable_on_error) {
+        entries.push({ key: "disable_on_error", value: "true" });
+    }
+    if (!subscription.password_required) {
+        entries.push({ key: "password_required", value: "false" });
+    }
+    if (subscription.run_as_owner) {
+        entries.push({ key: "run_as_owner", value: "true" });
+    }
+    if (subscription.origin === "none") {
+        entries.push({ key: "origin", value: quoteLiteral("none") });
+    }
+    if (subscription.failover) {
+        entries.push({ key: "failover", value: "true" });
+    }
+    return entries;
+}

package/dist/core/objects/table/changes/table.alter.d.ts

@@ -0,0 +1,357 @@
+import type { ColumnProps } from "../../base.model.ts";
+import type { Table, TableConstraintProps } from "../table.model.ts";
+import { AlterTableChange } from "./table.base.ts";
+/**
+ * Alter a table.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-altertable.html
+ *
+ * Synopsis
+ * ```sql
+ * ALTER TABLE [ IF EXISTS ] [ ONLY ] name [ * ]
+ *     action [, ... ]
+ * where action is one of:
+ *     ADD [ COLUMN ] [ IF NOT EXISTS ] column_name data_type [ COLLATE collation ] [ column_constraint [ ... ] ]
+ *     DROP [ COLUMN ] [ IF EXISTS ] column_name [ RESTRICT | CASCADE ]
+ *     ALTER [ COLUMN ] column_name [ SET DATA ] TYPE data_type [ COLLATE collation ] [ USING expression ]
+ *     ALTER [ COLUMN ] column_name SET DEFAULT expression
+ *     ALTER [ COLUMN ] column_name DROP DEFAULT
+ *     ALTER [ COLUMN ] column_name { SET | DROP } NOT NULL
+ *     ALTER [ COLUMN ] column_name SET STATISTICS integer
+ *     ALTER [ COLUMN ] column_name SET ( attribute_option = value [, ... ] )
+ *     ALTER [ COLUMN ] column_name RESET ( attribute_option [, ... ] )
+ *     ALTER [ COLUMN ] column_name SET STORAGE { PLAIN | EXTERNAL | EXTENDED | MAIN }
+ *     ALTER [ COLUMN ] column_name SET COMPRESSION compression_method
+ *     ADD table_constraint [ NOT VALID ]
+ *     ADD table_constraint_using_index
+ *     ALTER CONSTRAINT constraint_name [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
+ *     VALIDATE CONSTRAINT constraint_name
+ *     DROP CONSTRAINT [ IF EXISTS ]  constraint_name [ RESTRICT | CASCADE ]
+ *     DISABLE TRIGGER [ trigger_name | ALL | USER ]
+ *     ENABLE TRIGGER [ trigger_name | ALL | USER ]
+ *     ENABLE REPLICA TRIGGER trigger_name
+ *     ENABLE ALWAYS TRIGGER trigger_name
+ *     DISABLE RULE rewrite_rule_name
+ *     ENABLE RULE rewrite_rule_name
+ *     ENABLE REPLICA RULE rewrite_rule_name
+ *     ENABLE ALWAYS RULE rewrite_rule_name
+ *     CLUSTER ON index_name
+ *     SET WITHOUT CLUSTER
+ *     SET WITH OIDS
+ *     SET WITHOUT OIDS
+ *     SET ( storage_parameter [= value] [, ... ] )
+ *     RESET ( storage_parameter [, ... ] )
+ *     INHERIT parent_table
+ *     NO INHERIT parent_table
+ *     OF type_name
+ *     NOT OF
+ *     OWNER TO { new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
+ *     SET TABLESPACE new_tablespace
+ *     SET { LOGGED | UNLOGGED }
+ *     SET ACCESS METHOD new_access_method
+ *     REFRESH MATERIALIZED VIEW [ CONCURRENTLY ] [ WITH [ NO ] DATA ]
+ *     ATTACH PARTITION partition_name { FOR VALUES partition_bound_spec | DEFAULT }
+ *     DETACH PARTITION partition_name [ CONCURRENTLY | FINALIZE ]
+ * ```
+ */
+export type AlterTable = AlterTableAddColumn | AlterTableAddConstraint | AlterTableAlterColumnDropDefault | AlterTableAlterColumnDropNotNull | AlterTableAlterColumnSetDefault | AlterTableAlterColumnSetNotNull | AlterTableAlterColumnType | AlterTableAttachPartition | AlterTableChangeOwner | AlterTableDetachPartition | AlterTableDisableRowLevelSecurity | AlterTableDropColumn | AlterTableDropConstraint | AlterTableEnableRowLevelSecurity | AlterTableForceRowLevelSecurity | AlterTableNoForceRowLevelSecurity | AlterTableResetStorageParams | AlterTableSetLogged | AlterTableSetReplicaIdentity | AlterTableSetStorageParams | AlterTableSetUnlogged | AlterTableValidateConstraint;
+/**
+ * ALTER TABLE ... OWNER TO ...
+ */
+export declare class AlterTableChangeOwner extends AlterTableChange {
+    readonly table: Table;
+    readonly owner: string;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        owner: string;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... SET LOGGED
+ */
+export declare class AlterTableSetLogged extends AlterTableChange {
+    readonly table: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... SET UNLOGGED
+ */
+export declare class AlterTableSetUnlogged extends AlterTableChange {
+    readonly table: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ENABLE ROW LEVEL SECURITY
+ */
+export declare class AlterTableEnableRowLevelSecurity extends AlterTableChange {
+    readonly table: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... DISABLE ROW LEVEL SECURITY
+ */
+export declare class AlterTableDisableRowLevelSecurity extends AlterTableChange {
+    readonly table: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... FORCE ROW LEVEL SECURITY
+ */
+export declare class AlterTableForceRowLevelSecurity extends AlterTableChange {
+    readonly table: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... NO FORCE ROW LEVEL SECURITY
+ */
+export declare class AlterTableNoForceRowLevelSecurity extends AlterTableChange {
+    readonly table: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... SET ( storage_parameter = value [, ... ] )
+ */
+export declare class AlterTableSetStorageParams extends AlterTableChange {
+    readonly table: Table;
+    readonly options: string[];
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        options: string[];
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... RESET ( storage_parameter [, ... ] )
+ */
+export declare class AlterTableResetStorageParams extends AlterTableChange {
+    readonly table: Table;
+    readonly params: string[];
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        params: string[];
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ADD CONSTRAINT ...
+ */
+export declare class AlterTableAddConstraint extends AlterTableChange {
+    readonly table: Table;
+    readonly constraint: TableConstraintProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        constraint: TableConstraintProps;
+    });
+    get creates(): `constraint:${string}.${string}.${string}`[];
+    get requires(): string[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... DROP CONSTRAINT ...
+ */
+export declare class AlterTableDropConstraint extends AlterTableChange {
+    readonly table: Table;
+    readonly constraint: TableConstraintProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        constraint: TableConstraintProps;
+    });
+    get drops(): `constraint:${string}.${string}.${string}`[];
+    get requires(): (`constraint:${string}.${string}.${string}` | `table:${string}`)[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... VALIDATE CONSTRAINT ...
+ */
+export declare class AlterTableValidateConstraint extends AlterTableChange {
+    readonly table: Table;
+    readonly constraint: TableConstraintProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        constraint: TableConstraintProps;
+    });
+    get requires(): (`constraint:${string}.${string}.${string}` | `table:${string}`)[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... REPLICA IDENTITY ...
+ */
+export declare class AlterTableSetReplicaIdentity extends AlterTableChange {
+    readonly table: Table;
+    readonly mode: "d" | "n" | "f" | "i";
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        mode: "d" | "n" | "f" | "i";
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ADD COLUMN ...
+ */
+export declare class AlterTableAddColumn extends AlterTableChange {
+    readonly table: Table;
+    readonly column: ColumnProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        column: ColumnProps;
+    });
+    get creates(): `column:${string}.${string}.${string}`[];
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... DROP COLUMN ...
+ */
+export declare class AlterTableDropColumn extends AlterTableChange {
+    readonly table: Table;
+    readonly column: ColumnProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        column: ColumnProps;
+    });
+    get drops(): `column:${string}.${string}.${string}`[];
+    get requires(): (`column:${string}.${string}.${string}` | `table:${string}`)[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ALTER COLUMN ... TYPE ...
+ */
+export declare class AlterTableAlterColumnType extends AlterTableChange {
+    readonly table: Table;
+    readonly column: ColumnProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        column: ColumnProps;
+    });
+    get requires(): `column:${string}.${string}.${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ...
+ */
+export declare class AlterTableAlterColumnSetDefault extends AlterTableChange {
+    readonly table: Table;
+    readonly column: ColumnProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        column: ColumnProps;
+    });
+    get requires(): `column:${string}.${string}.${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ALTER COLUMN ... DROP DEFAULT
+ */
+export declare class AlterTableAlterColumnDropDefault extends AlterTableChange {
+    readonly table: Table;
+    readonly column: ColumnProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        column: ColumnProps;
+    });
+    get requires(): `column:${string}.${string}.${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ALTER COLUMN ... SET NOT NULL
+ */
+export declare class AlterTableAlterColumnSetNotNull extends AlterTableChange {
+    readonly table: Table;
+    readonly column: ColumnProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        column: ColumnProps;
+    });
+    get requires(): `column:${string}.${string}.${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ALTER COLUMN ... DROP NOT NULL
+ */
+export declare class AlterTableAlterColumnDropNotNull extends AlterTableChange {
+    readonly table: Table;
+    readonly column: ColumnProps;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        column: ColumnProps;
+    });
+    get requires(): `column:${string}.${string}.${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... ATTACH PARTITION ...
+ */
+export declare class AlterTableAttachPartition extends AlterTableChange {
+    readonly table: Table;
+    readonly partition: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        partition: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}
+/**
+ * ALTER TABLE ... DETACH PARTITION ...
+ */
+export declare class AlterTableDetachPartition extends AlterTableChange {
+    readonly table: Table;
+    readonly partition: Table;
+    readonly scope: "object";
+    constructor(props: {
+        table: Table;
+        partition: Table;
+    });
+    get requires(): `table:${string}`[];
+    serialize(): string;
+}