@supabase/pg-delta 1.0.0-alpha.3 → 1.0.0-alpha.5

package/src/core/objects/aggregate/changes/aggregate.comment.test.ts

@@ -0,0 +1,89 @@
+import { describe, expect, test } from "bun:test";
+import { assertValidSql } from "../../../test-utils/assert-valid-sql.ts";
+import { stableId } from "../../utils.ts";
+import { Aggregate } from "../aggregate.model.ts";
+import {
+  CreateCommentOnAggregate,
+  DropCommentOnAggregate,
+} from "./aggregate.comment.ts";
+
+type AggregateProps = ConstructorParameters<typeof Aggregate>[0];
+
+const base: AggregateProps = {
+  schema: "public",
+  name: "agg_sum",
+  identity_arguments: "integer",
+  kind: "a",
+  aggkind: "n",
+  num_direct_args: 0,
+  return_type: "integer",
+  return_type_schema: "pg_catalog",
+  parallel_safety: "u",
+  is_strict: false,
+  transition_function: "pg_catalog.int4pl(integer,integer)",
+  state_data_type: "integer",
+  state_data_type_schema: "pg_catalog",
+  state_data_space: 0,
+  final_function: null,
+  final_function_extra_args: false,
+  final_function_modify: null,
+  combine_function: null,
+  serial_function: null,
+  deserial_function: null,
+  initial_condition: null,
+  moving_transition_function: null,
+  moving_inverse_function: null,
+  moving_state_data_type: null,
+  moving_state_data_type_schema: null,
+  moving_state_data_space: null,
+  moving_final_function: null,
+  moving_final_function_extra_args: false,
+  moving_final_function_modify: null,
+  moving_initial_condition: null,
+  sort_operator: null,
+  argument_count: 1,
+  argument_default_count: 0,
+  argument_names: null,
+  argument_types: ["integer"],
+  all_argument_types: null,
+  argument_modes: null,
+  argument_defaults: null,
+  owner: "owner1",
+  comment: null,
+  privileges: [],
+};
+
+const makeAggregate = (override: Partial<AggregateProps> = {}) =>
+  new Aggregate({
+    ...base,
+    ...override,
+  });
+
+describe("aggregate.comment", () => {
+  test("create comment serializes and tracks dependencies", async () => {
+    const aggregate = makeAggregate({ comment: "aggregate's total" });
+    const change = new CreateCommentOnAggregate({ aggregate });
+
+    expect(change.creates).toEqual([stableId.comment(aggregate.stableId)]);
+    expect(change.requires).toEqual([aggregate.stableId]);
+    await assertValidSql(change.serialize());
+    expect(change.serialize()).toBe(
+      "COMMENT ON AGGREGATE public.agg_sum(integer) IS 'aggregate''s total'",
+    );
+  });
+
+  test("drop comment serializes and tracks dependencies", async () => {
+    const aggregate = makeAggregate({ comment: "some comment" });
+    const change = new DropCommentOnAggregate({ aggregate });
+
+    expect(change.drops).toEqual([stableId.comment(aggregate.stableId)]);
+    expect(change.requires).toEqual([
+      stableId.comment(aggregate.stableId),
+      aggregate.stableId,
+    ]);
+    await assertValidSql(change.serialize());
+    expect(change.serialize()).toBe(
+      "COMMENT ON AGGREGATE public.agg_sum(integer) IS NULL",
+    );
+  });
+});

package/src/core/objects/aggregate/changes/aggregate.comment.ts

@@ -0,0 +1,62 @@
+import { quoteLiteral } from "../../base.change.ts";
+import { stableId } from "../../utils.ts";
+import type { Aggregate } from "../aggregate.model.ts";
+import {
+  CreateAggregateChange,
+  DropAggregateChange,
+} from "./aggregate.base.ts";
+
+export type CommentAggregate =
+  | CreateCommentOnAggregate
+  | DropCommentOnAggregate;
+
+export class CreateCommentOnAggregate extends CreateAggregateChange {
+  public readonly aggregate: Aggregate;
+  public readonly scope = "comment" as const;
+
+  constructor(props: { aggregate: Aggregate }) {
+    super();
+    this.aggregate = props.aggregate;
+  }
+
+  get creates() {
+    return [stableId.comment(this.aggregate.stableId)];
+  }
+
+  get requires() {
+    return [this.aggregate.stableId];
+  }
+
+  serialize(): string {
+    const signature = this.aggregate.identityArguments;
+    const qualifiedName = `${this.aggregate.schema}.${this.aggregate.name}`;
+    const withArgs = signature.length > 0 ? `(${signature})` : "()";
+    // biome-ignore lint/style/noNonNullAssertion: aggregate comment is non-null in this branch
+    return `COMMENT ON AGGREGATE ${qualifiedName}${withArgs} IS ${quoteLiteral(this.aggregate.comment!)}`;
+  }
+}
+
+export class DropCommentOnAggregate extends DropAggregateChange {
+  public readonly aggregate: Aggregate;
+  public readonly scope = "comment" as const;
+
+  constructor(props: { aggregate: Aggregate }) {
+    super();
+    this.aggregate = props.aggregate;
+  }
+
+  get drops() {
+    return [stableId.comment(this.aggregate.stableId)];
+  }
+
+  get requires() {
+    return [stableId.comment(this.aggregate.stableId), this.aggregate.stableId];
+  }
+
+  serialize(): string {
+    const signature = this.aggregate.identityArguments;
+    const qualifiedName = `${this.aggregate.schema}.${this.aggregate.name}`;
+    const withArgs = signature.length > 0 ? `(${signature})` : "()";
+    return `COMMENT ON AGGREGATE ${qualifiedName}${withArgs} IS NULL`;
+  }
+}

package/src/core/objects/aggregate/changes/aggregate.create.test.ts

@@ -0,0 +1,104 @@
+import { describe, expect, test } from "bun:test";
+import { assertValidSql } from "../../../test-utils/assert-valid-sql.ts";
+import { Aggregate } from "../aggregate.model.ts";
+import { CreateAggregate } from "./aggregate.create.ts";
+
+type AggregateProps = ConstructorParameters<typeof Aggregate>[0];
+
+const base: AggregateProps = {
+  schema: "public",
+  name: "agg_sum",
+  identity_arguments: "integer",
+  kind: "a",
+  aggkind: "n",
+  num_direct_args: 0,
+  return_type: "integer",
+  return_type_schema: "pg_catalog",
+  parallel_safety: "u",
+  is_strict: false,
+  transition_function: "pg_catalog.int4pl(integer,integer)",
+  state_data_type: "integer",
+  state_data_type_schema: "pg_catalog",
+  state_data_space: 0,
+  final_function: null,
+  final_function_extra_args: false,
+  final_function_modify: null,
+  combine_function: null,
+  serial_function: null,
+  deserial_function: null,
+  initial_condition: null,
+  moving_transition_function: null,
+  moving_inverse_function: null,
+  moving_state_data_type: null,
+  moving_state_data_type_schema: null,
+  moving_state_data_space: null,
+  moving_final_function: null,
+  moving_final_function_extra_args: false,
+  moving_final_function_modify: null,
+  moving_initial_condition: null,
+  sort_operator: null,
+  argument_count: 1,
+  argument_default_count: 0,
+  argument_names: null,
+  argument_types: ["integer"],
+  all_argument_types: null,
+  argument_modes: null,
+  argument_defaults: null,
+  owner: "owner1",
+  comment: null,
+  privileges: [],
+};
+
+const makeAggregate = (override: Partial<AggregateProps> = {}) =>
+  new Aggregate({
+    ...base,
+    ...override,
+  });
+
+describe("aggregate.create", () => {
+  test("serialize minimal aggregate", async () => {
+    const aggregate = makeAggregate();
+    const change = new CreateAggregate({ aggregate });
+
+    expect(change.creates).toEqual([aggregate.stableId]);
+    await assertValidSql(change.serialize());
+    expect(change.serialize()).toMatchInlineSnapshot(
+      `"CREATE AGGREGATE public.agg_sum(integer) (SFUNC = pg_catalog.int4pl, STYPE = integer)"`,
+    );
+  });
+
+  test("serialize aggregate with optional clauses and or replace", async () => {
+    const aggregate = makeAggregate({
+      name: "agg_full",
+      transition_function: "public.sum_int8(bigint,bigint)",
+      state_data_type: "bigint",
+      state_data_space: 8,
+      final_function: "public.finalize(bigint)",
+      final_function_extra_args: true,
+      final_function_modify: "w",
+      combine_function: "public.combine(bigint,bigint)",
+      serial_function: "public.serialize_state(internal)",
+      deserial_function: "public.deserialize_state(bytea,internal)",
+      initial_condition: "0",
+      moving_transition_function: "public.msum(bigint,bigint)",
+      moving_inverse_function: "public.minv(bigint,bigint)",
+      moving_state_data_type: "pg_catalog.bigint",
+      moving_state_data_space: 16,
+      moving_final_function: "public.mfinal(bigint)",
+      moving_final_function_extra_args: true,
+      moving_final_function_modify: "s",
+      moving_initial_condition: "0",
+      sort_operator: "pg_catalog.<(integer,integer)",
+      parallel_safety: "s",
+      is_strict: true,
+      aggkind: "h",
+    });
+
+    const change = new CreateAggregate({ aggregate, orReplace: true });
+
+    await assertValidSql(change.serialize());
+    expect(change.serialize()).toMatchInlineSnapshot(
+      `"CREATE OR REPLACE AGGREGATE public.agg_full(integer) (SFUNC = public.sum_int8, STYPE = bigint, SSPACE = 8, FINALFUNC = public.finalize, FINALFUNC_EXTRA, FINALFUNC_MODIFY = READ_WRITE, COMBINEFUNC = public.combine, SERIALFUNC = public.serialize_state, DESERIALFUNC = public.deserialize_state, INITCOND = '0', MSFUNC = public.msum, MINVFUNC = public.minv, MSTYPE = pg_catalog.bigint, MSSPACE = 16, MFINALFUNC = public.mfinal, MFINALFUNC_EXTRA, MFINALFUNC_MODIFY = SHAREABLE, MINITCOND = '0', SORTOP = OPERATOR(pg_catalog.<), PARALLEL = SAFE, STRICT, HYPOTHETICAL)"`,
+    );
+  });
+});

package/src/core/objects/aggregate/changes/aggregate.create.ts

@@ -0,0 +1,329 @@
+import { quoteLiteral } from "../../base.change.ts";
+import {
+  parseProcedureReference,
+  parseTypeString,
+  stableId,
+} from "../../utils.ts";
+import type { Aggregate } from "../aggregate.model.ts";
+import { CreateAggregateChange } from "./aggregate.base.ts";
+
+/**
+ * Create an aggregate.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-createaggregate.html
+ */
+export class CreateAggregate extends CreateAggregateChange {
+  public readonly aggregate: Aggregate;
+  public readonly orReplace: boolean;
+  public readonly scope = "object" as const;
+
+  constructor(props: { aggregate: Aggregate; orReplace?: boolean }) {
+    super();
+    this.aggregate = props.aggregate;
+    this.orReplace = props.orReplace ?? false;
+  }
+
+  get creates() {
+    return [this.aggregate.stableId];
+  }
+
+  get requires() {
+    const dependencies = new Set<string>();
+
+    // Schema dependency
+    dependencies.add(stableId.schema(this.aggregate.schema));
+
+    // Owner dependency
+    dependencies.add(stableId.role(this.aggregate.owner));
+
+    // Transition function dependency
+    const transProc = parseProcedureReference(
+      this.aggregate.transition_function,
+    );
+    if (transProc) {
+      dependencies.add(stableId.procedure(transProc.schema, transProc.name));
+    }
+
+    // State data type dependency (if user-defined)
+    const stateType = parseTypeString(this.aggregate.state_data_type);
+    if (stateType) {
+      dependencies.add(stableId.type(stateType.schema, stateType.name));
+    }
+
+    // Final function dependency
+    if (this.aggregate.final_function) {
+      const finalProc = parseProcedureReference(this.aggregate.final_function);
+      if (finalProc) {
+        dependencies.add(stableId.procedure(finalProc.schema, finalProc.name));
+      }
+    }
+
+    // Combine function dependency
+    if (this.aggregate.combine_function) {
+      const combineProc = parseProcedureReference(
+        this.aggregate.combine_function,
+      );
+      if (combineProc) {
+        dependencies.add(
+          stableId.procedure(combineProc.schema, combineProc.name),
+        );
+      }
+    }
+
+    // Serial function dependency
+    if (this.aggregate.serial_function) {
+      const serialProc = parseProcedureReference(
+        this.aggregate.serial_function,
+      );
+      if (serialProc) {
+        dependencies.add(
+          stableId.procedure(serialProc.schema, serialProc.name),
+        );
+      }
+    }
+
+    // Deserial function dependency
+    if (this.aggregate.deserial_function) {
+      const deserialProc = parseProcedureReference(
+        this.aggregate.deserial_function,
+      );
+      if (deserialProc) {
+        dependencies.add(
+          stableId.procedure(deserialProc.schema, deserialProc.name),
+        );
+      }
+    }
+
+    // Moving transition function dependency
+    if (this.aggregate.moving_transition_function) {
+      const movingTransProc = parseProcedureReference(
+        this.aggregate.moving_transition_function,
+      );
+      if (movingTransProc) {
+        dependencies.add(
+          stableId.procedure(movingTransProc.schema, movingTransProc.name),
+        );
+      }
+    }
+
+    // Moving inverse function dependency
+    if (this.aggregate.moving_inverse_function) {
+      const movingInvProc = parseProcedureReference(
+        this.aggregate.moving_inverse_function,
+      );
+      if (movingInvProc) {
+        dependencies.add(
+          stableId.procedure(movingInvProc.schema, movingInvProc.name),
+        );
+      }
+    }
+
+    // Moving state data type dependency (if user-defined)
+    if (this.aggregate.moving_state_data_type) {
+      const movingStateType = parseTypeString(
+        this.aggregate.moving_state_data_type,
+      );
+      if (movingStateType) {
+        dependencies.add(
+          stableId.type(movingStateType.schema, movingStateType.name),
+        );
+      }
+    }
+
+    // Moving final function dependency
+    if (this.aggregate.moving_final_function) {
+      const movingFinalProc = parseProcedureReference(
+        this.aggregate.moving_final_function,
+      );
+      if (movingFinalProc) {
+        dependencies.add(
+          stableId.procedure(movingFinalProc.schema, movingFinalProc.name),
+        );
+      }
+    }
+
+    // Return type dependency (if user-defined)
+    if (this.aggregate.return_type_schema) {
+      const returnType = parseTypeString(this.aggregate.return_type);
+      if (returnType) {
+        dependencies.add(stableId.type(returnType.schema, returnType.name));
+      }
+    }
+
+    // Argument type dependencies (if user-defined)
+    if (this.aggregate.argument_types) {
+      for (const argType of this.aggregate.argument_types) {
+        const parsedType = parseTypeString(argType);
+        if (parsedType) {
+          dependencies.add(stableId.type(parsedType.schema, parsedType.name));
+        }
+      }
+    }
+
+    // Note: Sort operator dependencies are complex (they reference operators which
+    // may reference types/functions). For now, we rely on pg_depend for these.
+
+    return Array.from(dependencies);
+  }
+
+  serialize(): string {
+    const signature = this.aggregate.identityArguments;
+    const qualifiedName = `${this.aggregate.schema}.${this.aggregate.name}`;
+    const head = [
+      "CREATE",
+      this.orReplace ? "OR REPLACE" : null,
+      "AGGREGATE",
+      `${qualifiedName}${signature ? `(${signature})` : "()"}`,
+    ]
+      .filter(Boolean)
+      .join(" ");
+
+    const clauses: string[] = [];
+
+    clauses.push(`SFUNC = ${formatProc(this.aggregate.transition_function)}`);
+    clauses.push(`STYPE = ${this.aggregate.state_data_type}`);
+
+    if (this.aggregate.state_data_space > 0) {
+      clauses.push(`SSPACE = ${this.aggregate.state_data_space}`);
+    }
+
+    if (this.aggregate.final_function) {
+      clauses.push(`FINALFUNC = ${formatProc(this.aggregate.final_function)}`);
+    }
+    if (this.aggregate.final_function_extra_args) {
+      clauses.push("FINALFUNC_EXTRA");
+    }
+    // Only include FINALFUNC_MODIFY if it's explicitly set to a non-default value
+    // PostgreSQL defaults to 'r' (READ_ONLY) when not specified
+    if (
+      this.aggregate.final_function_modify &&
+      this.aggregate.final_function_modify !== "r"
+    ) {
+      clauses.push(
+        `FINALFUNC_MODIFY = ${formatModify(this.aggregate.final_function_modify)}`,
+      );
+    }
+
+    if (this.aggregate.combine_function) {
+      clauses.push(
+        `COMBINEFUNC = ${formatProc(this.aggregate.combine_function)}`,
+      );
+    }
+    if (this.aggregate.serial_function) {
+      clauses.push(
+        `SERIALFUNC = ${formatProc(this.aggregate.serial_function)}`,
+      );
+    }
+    if (this.aggregate.deserial_function) {
+      clauses.push(
+        `DESERIALFUNC = ${formatProc(this.aggregate.deserial_function)}`,
+      );
+    }
+
+    if (this.aggregate.initial_condition !== null) {
+      clauses.push(
+        `INITCOND = ${quoteLiteral(this.aggregate.initial_condition)}`,
+      );
+    }
+
+    if (this.aggregate.moving_transition_function) {
+      clauses.push(
+        `MSFUNC = ${formatProc(this.aggregate.moving_transition_function)}`,
+      );
+    }
+    if (this.aggregate.moving_inverse_function) {
+      clauses.push(
+        `MINVFUNC = ${formatProc(this.aggregate.moving_inverse_function)}`,
+      );
+    }
+    if (this.aggregate.moving_state_data_type) {
+      clauses.push(`MSTYPE = ${this.aggregate.moving_state_data_type}`);
+    }
+    if (
+      this.aggregate.moving_state_data_space &&
+      this.aggregate.moving_state_data_space > 0
+    ) {
+      clauses.push(`MSSPACE = ${this.aggregate.moving_state_data_space}`);
+    }
+    if (this.aggregate.moving_final_function) {
+      clauses.push(
+        `MFINALFUNC = ${formatProc(this.aggregate.moving_final_function)}`,
+      );
+    }
+    if (this.aggregate.moving_final_function_extra_args) {
+      clauses.push("MFINALFUNC_EXTRA");
+    }
+    // Only include MFINALFUNC_MODIFY if it's explicitly set to a non-default value
+    // PostgreSQL defaults to 'r' (READ_ONLY) when not specified
+    if (
+      this.aggregate.moving_final_function_modify &&
+      this.aggregate.moving_final_function_modify !== "r"
+    ) {
+      clauses.push(
+        `MFINALFUNC_MODIFY = ${formatModify(this.aggregate.moving_final_function_modify)}`,
+      );
+    }
+    if (this.aggregate.moving_initial_condition !== null) {
+      clauses.push(
+        `MINITCOND = ${quoteLiteral(this.aggregate.moving_initial_condition)}`,
+      );
+    }
+
+    if (this.aggregate.sort_operator) {
+      clauses.push(`SORTOP = ${formatOperator(this.aggregate.sort_operator)}`);
+    }
+
+    if (this.aggregate.parallel_safety !== "u") {
+      clauses.push(
+        `PARALLEL = ${formatParallel(this.aggregate.parallel_safety)}`,
+      );
+    }
+
+    if (this.aggregate.is_strict) {
+      clauses.push("STRICT");
+    }
+
+    if (this.aggregate.aggkind === "h") {
+      clauses.push("HYPOTHETICAL");
+    }
+
+    const body = clauses.length ? `(${clauses.join(", ")})` : "()";
+
+    return `${head} ${body}`;
+  }
+}
+
+function formatProc(proc: string): string {
+  const idx = proc.indexOf("(");
+  return idx === -1 ? proc : proc.slice(0, idx);
+}
+
+function formatOperator(op: string): string {
+  const idx = op.indexOf("(");
+  const qualified = idx === -1 ? op : op.slice(0, idx);
+  return `OPERATOR(${qualified})`;
+}
+
+function formatModify(code: string): string {
+  switch (code) {
+    case "r":
+      return "READ_ONLY";
+    case "s":
+      return "SHAREABLE";
+    case "w":
+      return "READ_WRITE";
+    default:
+      return code;
+  }
+}
+
+function formatParallel(code: string): string {
+  switch (code) {
+    case "s":
+      return "SAFE";
+    case "r":
+      return "RESTRICTED";
+    default:
+      return "UNSAFE";
+  }
+}

package/src/core/objects/aggregate/changes/aggregate.drop.test.ts

@@ -0,0 +1,82 @@
+import { describe, expect, test } from "bun:test";
+import { assertValidSql } from "../../../test-utils/assert-valid-sql.ts";
+import { Aggregate } from "../aggregate.model.ts";
+import { DropAggregate } from "./aggregate.drop.ts";
+
+type AggregateProps = ConstructorParameters<typeof Aggregate>[0];
+
+const base: AggregateProps = {
+  schema: "public",
+  name: "agg_sum",
+  identity_arguments: "integer",
+  kind: "a",
+  aggkind: "n",
+  num_direct_args: 0,
+  return_type: "integer",
+  return_type_schema: "pg_catalog",
+  parallel_safety: "u",
+  is_strict: false,
+  transition_function: "pg_catalog.int4pl(integer,integer)",
+  state_data_type: "integer",
+  state_data_type_schema: "pg_catalog",
+  state_data_space: 0,
+  final_function: null,
+  final_function_extra_args: false,
+  final_function_modify: null,
+  combine_function: null,
+  serial_function: null,
+  deserial_function: null,
+  initial_condition: null,
+  moving_transition_function: null,
+  moving_inverse_function: null,
+  moving_state_data_type: null,
+  moving_state_data_type_schema: null,
+  moving_state_data_space: null,
+  moving_final_function: null,
+  moving_final_function_extra_args: false,
+  moving_final_function_modify: null,
+  moving_initial_condition: null,
+  sort_operator: null,
+  argument_count: 1,
+  argument_default_count: 0,
+  argument_names: null,
+  argument_types: ["integer"],
+  all_argument_types: null,
+  argument_modes: null,
+  argument_defaults: null,
+  owner: "owner1",
+  comment: null,
+  privileges: [],
+};
+
+const makeAggregate = (override: Partial<AggregateProps> = {}) =>
+  new Aggregate({
+    ...base,
+    ...override,
+  });
+
+describe("aggregate.drop", () => {
+  test("serialize drop for aggregate with arguments", async () => {
+    const aggregate = makeAggregate();
+    const change = new DropAggregate({ aggregate });
+
+    expect(change.drops).toEqual([aggregate.stableId]);
+    expect(change.requires).toEqual([aggregate.stableId]);
+    await assertValidSql(change.serialize());
+    expect(change.serialize()).toBe("DROP AGGREGATE public.agg_sum(integer)");
+  });
+
+  test("serialize drop for aggregate without arguments", async () => {
+    const aggregate = makeAggregate({
+      name: "agg_no_args",
+      identity_arguments: "",
+      argument_count: 0,
+      argument_types: [],
+    });
+    const change = new DropAggregate({ aggregate });
+
+    await assertValidSql(change.serialize());
+
+    expect(change.serialize()).toBe("DROP AGGREGATE public.agg_no_args(*)");
+  });
+});

package/src/core/objects/aggregate/changes/aggregate.drop.ts

@@ -0,0 +1,32 @@
+import type { Aggregate } from "../aggregate.model.ts";
+import { DropAggregateChange } from "./aggregate.base.ts";
+
+/**
+ * Drop an aggregate.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-dropaggregate.html
+ */
+export class DropAggregate extends DropAggregateChange {
+  public readonly aggregate: Aggregate;
+  public readonly scope = "object" as const;
+
+  constructor(props: { aggregate: Aggregate }) {
+    super();
+    this.aggregate = props.aggregate;
+  }
+
+  get drops() {
+    return [this.aggregate.stableId];
+  }
+
+  get requires() {
+    return [this.aggregate.stableId];
+  }
+
+  serialize(): string {
+    const signature = this.aggregate.identityArguments;
+    const qualifiedName = `${this.aggregate.schema}.${this.aggregate.name}`;
+    const withArgs = signature.length > 0 ? `(${signature})` : "(*)";
+    return `DROP AGGREGATE ${qualifiedName}${withArgs}`;
+  }
+}