Merge pull request #4 from constructive-io/feat/cli-5.20

feat: pgpm 5.20 — linear SQL delta projection (--emit-sql) + acceptance lane

Author: pyramation

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  PGPM_VERSION: 5.19.1
+  PGPM_VERSION: 5.20.0
 
 jobs:
   acceptance:

README.md

@@ -103,9 +103,18 @@ deploys on top of `shop-app`.
 
 ```sh
 pgpm import sources/shop.v2.sql --pkg shop-v2 --out /tmp/v2mod
-pgpm diff packages/shop /tmp/v2mod/shop-v2 --emit-migration packages --pkg shop-v1-to-v2 --verify
+pgpm diff packages/shop /tmp/v2mod/shop-v2 --emit-migration packages --pkg shop-v1-to-v2 \
+  --emit-sql sources/shop.v1-to-v2.sql --verify
 ```
 
+The delta is one model and every `--emit-*` flag is a projection of it: the
+pgpm module lands in `packages/shop-v1-to-v2`, and the same delta deparsed as
+a single linear SQL script lands in
+[`sources/shop.v1-to-v2.sql`](sources/shop.v1-to-v2.sql)
+(`--emit-bundle` would additionally produce a content-addressed
+`.bundle.tar.gz`). `pgpm diff --append-module <dir>` can instead append the
+delta as new changes into an existing module.
+
 Identity-keyed semantic diff between the v1 module and the v2 schema. Tables
 are compared column-by-column and constraint-by-constraint, so the delta is
 `ALTER TABLE`, not a rebuild. The delta is emitted as a normal pgpm module you

packages/shop-v1-to-v2/shop-v1-to-v2.control

@@ -1,5 +1,5 @@
 # shop-v1-to-v2 extension
-comment = 'shop-v1-to-v2 migration (generated by pgpm diff)'
+comment = 'shop-v1-to-v2 extension'
 default_version = '0.0.1'
 relocatable = false
 superuser = false

scripts/acceptance.sh

@@ -169,6 +169,17 @@ if [ -d packages/shop-v1-to-v2 ] && [ -d packages/shop ]; then
   $PSQL -d shop_v2_fresh -f sources/shop.v2.sql
 
   assert_same_catalog shop_migrated shop_v2_fresh "v1 + migration vs v2 fresh"
+
+  # the --emit-sql projection of the same delta, applied as plain SQL
+  if [ -f sources/shop.v1-to-v2.sql ]; then
+    note "load v1 dump + linear delta SQL -> shop_sql_migrated"
+    $PSQL -d postgres -c 'CREATE DATABASE shop_sql_migrated'
+    $PSQL -d shop_sql_migrated -v ON_ERROR_STOP=1 -f sources/shop.v1.sql
+    $PSQL -d shop_sql_migrated -v ON_ERROR_STOP=1 -f sources/shop.v1-to-v2.sql
+    assert_same_catalog shop_sql_migrated shop_v2_fresh "linear SQL delta vs v2 fresh"
+  else
+    skip "linear SQL delta check (sources/shop.v1-to-v2.sql)"
+  fi
 else
   skip "v1 -> v2 migration check (packages/shop-v1-to-v2)"
 fi

sources/shop.v1-to-v2.sql

@@ -0,0 +1,72 @@
+DROP INDEX shop.idx_orders_placed_at;
+
+CREATE TABLE shop.product_reviews (
+  id uuid DEFAULT gen_random_uuid() NOT NULL,
+  product_id uuid NOT NULL,
+  customer_id uuid NOT NULL,
+  rating int NOT NULL,
+  body text,
+  created_at timestamptz DEFAULT now() NOT NULL,
+  CONSTRAINT product_reviews_pkey PRIMARY KEY (id),
+  CONSTRAINT product_reviews_rating_check 
+    CHECK (
+    rating >= 1
+      AND rating <= 5
+  )
+);
+
+GRANT SELECT, INSERT ON shop.product_reviews TO app_user;
+
+ALTER TABLE ONLY shop.product_reviews 
+  ADD CONSTRAINT product_reviews_product_id_fkey
+    FOREIGN KEY(product_id)
+    REFERENCES shop.products (id)
+    ON DELETE CASCADE;
+
+ALTER TABLE ONLY shop.product_reviews 
+  ADD CONSTRAINT product_reviews_customer_id_fkey
+    FOREIGN KEY(customer_id)
+    REFERENCES shop.customers (id);
+
+COMMENT ON TABLE shop.product_reviews IS 'Customer product reviews, 1-5 stars.';
+
+CREATE INDEX idx_product_reviews_product_id ON shop.product_reviews (product_id);
+
+CREATE POLICY orders_insert_own
+  ON shop.orders
+  AS PERMISSIVE
+  FOR INSERT
+  TO PUBLIC
+  WITH CHECK (
+    customer_id = (current_setting('app.current_customer_id', true))::uuid
+  );
+
+ALTER TABLE shop.customers 
+  ADD COLUMN marketing_opt_in boolean
+    DEFAULT false
+    NOT NULL;
+
+ALTER TABLE shop.customers 
+  DROP COLUMN phone RESTRICT;
+
+ALTER TABLE shop.orders 
+  DROP CONSTRAINT orders_status_check RESTRICT;
+
+ALTER TABLE shop.orders 
+  ADD CONSTRAINT orders_status_check 
+    CHECK (status IN ('pending', 'paid', 'shipped', 'cancelled', 'refunded'));
+
+COMMENT ON FUNCTION shop.order_total(p_order_id uuid) IS NULL;
+
+DROP FUNCTION shop.order_total(uuid);
+
+CREATE FUNCTION shop.order_total(
+  p_order_id uuid
+) RETURNS int LANGUAGE sql STABLE AS $EOFCODE$
+  SELECT COALESCE(SUM(quantity * unit_price_cents), 0)::integer
+  FROM shop.order_items
+  WHERE order_id = p_order_id
+    AND quantity > 0;
+$EOFCODE$;
+
+COMMENT ON FUNCTION shop.order_total(p_order_id uuid) IS 'Sum of line totals for an order, in cents.';