frg-data-diff 2.0.0 → 2.1.0

package/dist/diff/pg-views-diff.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePgViewsDiffSql = generatePgViewsDiffSql;
+const pg_views_1 = require("../db/pg-views");
+const identifiers_1 = require("../shared/identifiers");
+async function generatePgViewsDiffSql(sourcePool, destPool, options) {
+    reportProgress(options.onProgress, "PostgreSQL views: resolving view patterns");
+    const { views } = await (0, pg_views_1.resolvePgViewPatterns)(sourcePool, destPool, options.schema, options.views, options.excludeViews);
+    reportProgress(options.onProgress, `PostgreSQL views: comparing ${views.length} view(s)`);
+    const sourceClient = await sourcePool.connect();
+    const destClient = await destPool.connect();
+    let sql = `-- PostgreSQL Views Diff\n`;
+    sql += `-- Generated automatically\n\n`;
+    try {
+        reportProgress(options.onProgress, "PostgreSQL views: fetching view definitions from source");
+        const sourceViews = await (0, pg_views_1.fetchPgViews)(sourceClient, options.schema, views, {
+            onViewStart: (viewName, viewPosition, totalViews) => {
+                reportProgress(options.onProgress, `[pg-views source ${viewPosition}/${totalViews}] ${options.schema}.${viewName}: fetching definition`);
+            },
+        });
+        reportProgress(options.onProgress, "PostgreSQL views: fetching view definitions from destination");
+        const destViews = await (0, pg_views_1.fetchPgViews)(destClient, options.schema, views, {
+            onViewStart: (viewName, viewPosition, totalViews) => {
+                reportProgress(options.onProgress, `[pg-views dest ${viewPosition}/${totalViews}] ${options.schema}.${viewName}: fetching definition`);
+            },
+        });
+        const sourceViewsMap = new Map(sourceViews.map((view) => [view.viewName, view]));
+        const destViewsMap = new Map(destViews.map((view) => [view.viewName, view]));
+        const work = buildPgViewDiffWork(views, sourceViewsMap, destViewsMap, options);
+        if (work.viewsToDrop.length === 0 && work.viewsToCreate.length === 0) {
+            reportProgress(options.onProgress, "PostgreSQL views: no differences found");
+            sql += `-- No differences found.\n`;
+            return sql;
+        }
+        reportProgress(options.onProgress, "PostgreSQL views: generating SQL script");
+        if (work.viewsToDrop.length > 0) {
+            sql += `-- Drop removed or incompatible views\n`;
+            for (const view of work.viewsToDrop) {
+                sql += `${buildDropViewStatement(view)}\n`;
+            }
+            sql += `\n`;
+        }
+        if (work.viewsToCreate.length > 0) {
+            sql += `-- Create or replace source views\n`;
+            for (const view of work.viewsToCreate) {
+                sql += `${buildCreateViewStatement(view)}\n\n`;
+            }
+        }
+    }
+    finally {
+        sourceClient.release();
+        destClient.release();
+    }
+    return sql;
+}
+function buildPgViewDiffWork(views, sourceViewsMap, destViewsMap, options) {
+    const viewsToDrop = [];
+    const viewsToCreate = [];
+    for (const [viewIndex, viewName] of views.entries()) {
+        const progressLabel = formatPgViewsProgressLabel(viewIndex + 1, views.length, options.schema, viewName);
+        const sourceView = sourceViewsMap.get(viewName);
+        const destView = destViewsMap.get(viewName);
+        reportProgress(options.onProgress, `${progressLabel}: comparing view`);
+        if (sourceView && !destView) {
+            viewsToCreate.push(sourceView);
+            reportProgress(options.onProgress, `${progressLabel}: view to create`);
+            continue;
+        }
+        if (!sourceView && destView) {
+            viewsToDrop.push(destView);
+            reportProgress(options.onProgress, `${progressLabel}: view to drop`);
+            continue;
+        }
+        if (!sourceView || !destView) {
+            reportProgress(options.onProgress, `${progressLabel}: no view metadata`);
+            continue;
+        }
+        if (pgViewsAreEqual(sourceView, destView)) {
+            reportProgress(options.onProgress, `${progressLabel}: no changes`);
+            continue;
+        }
+        if (requiresDropBeforeCreate(sourceView, destView)) {
+            viewsToDrop.push(destView);
+        }
+        viewsToCreate.push(sourceView);
+        reportProgress(options.onProgress, `${progressLabel}: view definition changed`);
+    }
+    return { viewsToDrop, viewsToCreate };
+}
+function pgViewsAreEqual(sourceView, destView) {
+    if (sourceView.viewType !== destView.viewType) {
+        return false;
+    }
+    return (normalizeViewDefinition(sourceView.viewDefinition) ===
+        normalizeViewDefinition(destView.viewDefinition));
+}
+function requiresDropBeforeCreate(sourceView, destView) {
+    if (sourceView.viewType !== destView.viewType) {
+        return true;
+    }
+    return sourceView.viewType === "materialized_view";
+}
+function buildDropViewStatement(view) {
+    return `DROP ${buildViewObjectKeyword(view)} IF EXISTS ${quoteQualifiedView(view)};`;
+}
+function buildCreateViewStatement(view) {
+    const definition = normalizeViewDefinition(view.viewDefinition);
+    if (view.viewType === "materialized_view") {
+        return `CREATE MATERIALIZED VIEW ${quoteQualifiedView(view)} AS\n${definition};`;
+    }
+    return `CREATE OR REPLACE VIEW ${quoteQualifiedView(view)} AS\n${definition};`;
+}
+function buildViewObjectKeyword(view) {
+    if (view.viewType === "materialized_view") {
+        return "MATERIALIZED VIEW";
+    }
+    return "VIEW";
+}
+function quoteQualifiedView(view) {
+    return `${(0, identifiers_1.quoteIdentifier)(view.viewSchema)}.${(0, identifiers_1.quoteIdentifier)(view.viewName)}`;
+}
+function normalizeViewDefinition(definition) {
+    return definition.trim().replace(/;+$/, "").trim();
+}
+function formatPgViewsProgressLabel(viewPosition, totalViews, schema, viewName) {
+    return `[pg-views ${viewPosition}/${totalViews}] ${schema}.${viewName}`;
+}
+function reportProgress(callback, message) {
+    if (callback) {
+        callback(message);
+    }
+}
+//# sourceMappingURL=pg-views-diff.js.map

package/dist/schema-diff/generate-schema-diff.js

@@ -68,7 +68,7 @@ async function generateSchemaDiff(sourcePool, destPool, options) {
         destClient.release();
     }
     return {
-        format: "postgres-schema-diff-json/v1",
+        format: "frg-schema-diff-json/v1",
         generatedAt: new Date().toISOString(),
         source: { schema: options.schema },
         dest: { schema: options.schema },

package/dist/schema-diff/schema-diff-schema.d.ts

@@ -518,7 +518,7 @@ declare const schemaTableDiffSchema: z.ZodObject<{
     } | null;
 }>;
 export declare const schemaDiffJsonSchema: z.ZodObject<{
-    format: z.ZodLiteral<"postgres-schema-diff-json/v1">;
+    format: z.ZodLiteral<"frg-schema-diff-json/v1">;
     generatedAt: z.ZodString;
     source: z.ZodObject<{
         schema: z.ZodString;
@@ -911,7 +911,7 @@ export declare const schemaDiffJsonSchema: z.ZodObject<{
         tables: string[];
         excludedTables: string[];
     };
-    format: "postgres-schema-diff-json/v1";
+    format: "frg-schema-diff-json/v1";
     generatedAt: string;
     source: {
         schema: string;
@@ -996,7 +996,7 @@ export declare const schemaDiffJsonSchema: z.ZodObject<{
         tables: string[];
         excludedTables: string[];
     };
-    format: "postgres-schema-diff-json/v1";
+    format: "frg-schema-diff-json/v1";
     generatedAt: string;
     source: {
         schema: string;

package/dist/schema-diff/schema-diff-schema.js

@@ -48,7 +48,7 @@ const schemaDiffSummarySchema = zod_1.z.object({
     primaryKeysToChange: zod_1.z.number().int(),
 });
 exports.schemaDiffJsonSchema = zod_1.z.object({
-    format: zod_1.z.literal("postgres-schema-diff-json/v1"),
+    format: zod_1.z.literal("frg-schema-diff-json/v1"),
     generatedAt: zod_1.z.string(),
     source: zod_1.z.object({ schema: zod_1.z.string() }),
     dest: zod_1.z.object({ schema: zod_1.z.string() }),

package/dist/shared/generator-wizard.js

@@ -83,6 +83,11 @@ async function promptForGeneratorOptions(defaults, promptFn, dependencies = {})
         const pgTriggersOutput = await promptConfigString("PostgreSQL triggers output file", defaults.pgTriggersOutput, ask, env, envrcPath, {}, onEnvrcWrite);
         const generatePgTriggers = await promptBoolean("Generate a PostgreSQL triggers and functions diff? (SQL script)", defaults.generatePgTriggers ?? true, ask, env, envrcPath, onEnvrcWrite);
         console.log("");
+        const pgViews = await promptOptionalList('PostgreSQL views to compare (comma-separated, "*" supported; blank for all)', defaults.pgViews, ask, env, envrcPath, onEnvrcWrite);
+        const pgViewsExclude = await promptOptionalList('PostgreSQL views to exclude (comma-separated, "*" supported)', defaults.pgViewsExclude, ask, env, envrcPath, onEnvrcWrite);
+        const pgViewsOutput = await promptConfigString("PostgreSQL views output file", defaults.pgViewsOutput, ask, env, envrcPath, {}, onEnvrcWrite);
+        const generatePgViews = await promptBoolean("Generate a PostgreSQL views diff? (SQL script)", defaults.generatePgViews ?? true, ask, env, envrcPath, onEnvrcWrite);
+        console.log("");
         const pretty = await promptBoolean("Pretty-print JSON", defaults.pretty, ask, env, envrcPath, onEnvrcWrite);
         return {
             sourcePgHost,
@@ -104,15 +109,19 @@ async function promptForGeneratorOptions(defaults, promptFn, dependencies = {})
             schemaDiffExcludeTables,
             pgTriggersTables,
             pgTriggersExcludeTables,
+            pgViews,
+            pgViewsExclude,
             ignoreColumns,
             includeDeletes,
             skipMissingPk,
             output,
             schemaDiffOutput,
             pgTriggersOutput,
+            pgViewsOutput,
             pretty,
             generateSql,
             generatePgTriggers,
+            generatePgViews,
         };
     }
     finally {

package/frg-triggers-diff.sql

@@ -0,0 +1,4 @@
+-- PostgreSQL Triggers and Functions Diff
+-- Generated automatically
+
+-- No differences found.

package/frg-views-diff.sql

@@ -0,0 +1,4 @@
+-- PostgreSQL Views Diff
+-- Generated automatically
+
+-- No differences found.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "frg-data-diff",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Safe PostgreSQL data diff and apply tooling. Compare data between two PostgreSQL databases and apply changes safely.",
   "bin": "./dist/cli/root.js",
   "scripts": {