pg-dump-parser 1.0.0

package/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2024, Gajus Kuizinas (https://gajus.com/)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Gajus Kuizinas (https://gajus.com/) nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL GAJUS KUIZINAS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,63 @@
+# pg-dump-parser
+
+Parses PostgreSQL dump files into an array of schema objects.
+
+## Motivation
+
+This allows to submit a PostgreSQL schema dump to version control in a way that enables easy diffing.
+
+## Usage
+
+```ts
+import { parsePgDump } from 'pg-dump-parser';
+
+const dump = await readFile('dump.sql', 'utf8');
+
+const schemaObjects = parsePgDump(dump);
+
+for (const schemaObject of schemaObjects) {
+  console.log(schemaObject);
+}
+```
+
+> [!NOTE]
+> The expected input is a PostgreSQL dump file created with `pg_dump --schema-only`.
+
+The output is an array of objects, each representing a schema object in the dump file and the corresponding header, e.g.,
+
+```json
+[
+  {
+      "header": {
+          "Name": "bar",
+          "Owner": "postgres",
+          "Schema": "public",
+          "Type": "TABLE"
+      },
+      "sql": "CREATE TABLE public.bar (\n    id integer NOT NULL,\n    uid text NOT NULL,\n    foo_id integer\n);"
+  },
+  {
+      "header": {
+          "Name": "bar",
+          "Owner": "postgres",
+          "Schema": "public",
+          "Type": "TABLE"
+      },
+      "sql": "ALTER TABLE public.bar OWNER TO postgres;"
+  },
+  {
+      "header": {
+          "Name": "bar_id_seq",
+          "Owner": "postgres",
+          "Schema": "public",
+          "Type": "SEQUENCE"
+      },
+      "sql": "ALTER TABLE public.bar ALTER COLUMN id ADD GENERATED ALWAYS AS IDENTITY (\n    SEQUENCE NAME public.bar_id_seq\n    START WITH 1\n    INCREMENT BY 1\n    NO MINVALUE\n    NO MAXVALUE\n    CACHE 1\n);"
+  }
+]
+```
+
+## Alternatives
+
+* https://github.com/omniti-labs/pg_extractor
+  * Prior to writing pg-dump-parser, I used this tool to extract the schema. It works well, but it's slow. It was taking a whole minute to parse our dump file. We needed something that implements equivalent functionality, but is faster. `pg-dump-parser` processes the same dump with in a few seconds.

package/dist/parsePgDump.d.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+declare const HeaderZodSchema: z.ZodUnion<[z.ZodObject<{
+    Title: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    Title: string;
+}, {
+    Title: string;
+}>, z.ZodObject<{
+    Name: z.ZodString;
+    Owner: z.ZodNullable<z.ZodString>;
+    Schema: z.ZodNullable<z.ZodString>;
+    Type: z.ZodEnum<["ACL", "AGGREGATE", "CAST", "COMMENT", "CONSTRAINT", "DEFAULT", "EXTENSION", "FK CONSTRAINT", "FUNCTION", "INDEX", "MATERIALIZED VIEW", "PROCEDURE", "PUBLICATION", "SCHEMA", "SEQUENCE OWNED BY", "SEQUENCE", "TABLE", "TEXT SEARCH CONFIGURATION", "TEXT SEARCH DICTIONARY", "TRIGGER", "TYPE", "VIEW"]>;
+}, "strip", z.ZodTypeAny, {
+    Name: string;
+    Owner: string | null;
+    Schema: string | null;
+    Type: "ACL" | "AGGREGATE" | "CAST" | "COMMENT" | "CONSTRAINT" | "DEFAULT" | "EXTENSION" | "FK CONSTRAINT" | "FUNCTION" | "INDEX" | "MATERIALIZED VIEW" | "PROCEDURE" | "PUBLICATION" | "SCHEMA" | "SEQUENCE OWNED BY" | "SEQUENCE" | "TABLE" | "TEXT SEARCH CONFIGURATION" | "TEXT SEARCH DICTIONARY" | "TRIGGER" | "TYPE" | "VIEW";
+}, {
+    Name: string;
+    Owner: string | null;
+    Schema: string | null;
+    Type: "ACL" | "AGGREGATE" | "CAST" | "COMMENT" | "CONSTRAINT" | "DEFAULT" | "EXTENSION" | "FK CONSTRAINT" | "FUNCTION" | "INDEX" | "MATERIALIZED VIEW" | "PROCEDURE" | "PUBLICATION" | "SCHEMA" | "SEQUENCE OWNED BY" | "SEQUENCE" | "TABLE" | "TEXT SEARCH CONFIGURATION" | "TEXT SEARCH DICTIONARY" | "TRIGGER" | "TYPE" | "VIEW";
+}>]>;
+type Header = z.infer<typeof HeaderZodSchema>;
+type Table = {
+    name: string;
+    schema: string;
+};
+type SchemaObject = {
+    header: Header;
+    sql: string;
+    table?: Table;
+};
+export declare const parsePgDump: (dump: string) => SchemaObject[];
+export {};
+//# sourceMappingURL=parsePgDump.d.ts.map

package/dist/parsePgDump.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsePgDump.d.ts","sourceRoot":"","sources":["../src/parsePgDump.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;IAyCnB,CAAC;AAEH,KAAK,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAyD9C,KAAK,KAAK,GAAG;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,YAAY,GAAG;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,eAAO,MAAM,WAAW,SAAU,MAAM,mBA6BvC,CAAC"}

package/dist/parsePgDump.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePgDump = void 0;
+const zod_1 = require("zod");
+const HeaderZodSchema = zod_1.z.union([
+    // These are the attribute less headers, e.g.
+    // --
+    // -- PostgreSQL database dump
+    // --
+    zod_1.z.object({
+        Title: zod_1.z.string(),
+    }),
+    // These are the objects with attributes, e.g.
+    // --
+    // -- Name: citext; Type: EXTENSION; Schema: -; Owner: -
+    // --
+    zod_1.z.object({
+        Name: zod_1.z.string(),
+        Owner: zod_1.z.string().nullable(),
+        Schema: zod_1.z.string().nullable(),
+        Type: zod_1.z.enum([
+            'ACL',
+            'AGGREGATE',
+            'CAST',
+            'COMMENT',
+            'CONSTRAINT',
+            'DEFAULT',
+            'EXTENSION',
+            'FK CONSTRAINT',
+            'FUNCTION',
+            'INDEX',
+            'MATERIALIZED VIEW',
+            'PROCEDURE',
+            'PUBLICATION',
+            'SCHEMA',
+            'SEQUENCE OWNED BY',
+            'SEQUENCE',
+            'TABLE',
+            'TEXT SEARCH CONFIGURATION',
+            'TEXT SEARCH DICTIONARY',
+            'TRIGGER',
+            'TYPE',
+            'VIEW',
+        ]),
+    }),
+]);
+const isHeader = (fragment) => {
+    return fragment.startsWith('--\n--');
+};
+const parseValue = (value) => {
+    if (value === '-' || value === '' || value === undefined) {
+        return null;
+    }
+    return value;
+};
+const parseAttribute = (attribute) => {
+    const [name, value] = attribute.split(':');
+    return [name, parseValue(value.trim())];
+};
+// --
+// -- Name: TABLE user_survey; Type: ACL; Schema: public; Owner: postgres
+// --
+const parseHeader = (fragment) => {
+    const lines = fragment.split('\n');
+    if (lines.length !== 3) {
+        throw new Error('Invalid header');
+    }
+    const contentLine = lines[1].slice(3);
+    if (contentLine === 'PostgreSQL database dump' ||
+        contentLine === 'PostgreSQL database dump complete') {
+        return HeaderZodSchema.parse({
+            Title: contentLine,
+        });
+    }
+    const content = Object.fromEntries(contentLine.split('; ').map((attribute) => {
+        return parseAttribute(attribute);
+    }));
+    const result = HeaderZodSchema.safeParse(content);
+    if (!result.success) {
+        throw new Error('Invalid header');
+    }
+    return result.data;
+};
+const parsePgDump = (dump) => {
+    const schemaObjects = [];
+    const fragments = dump.trim().split(/(--\n-- .*\n--)/u);
+    let lastHeader = null;
+    for (const fragment of fragments.map((chunk) => chunk.trim())) {
+        if (fragment === '') {
+            continue;
+        }
+        if (isHeader(fragment)) {
+            lastHeader = parseHeader(fragment);
+        }
+        else if (lastHeader) {
+            const subFragments = fragment.split('\n\n\n');
+            for (const subFragment of subFragments) {
+                schemaObjects.push({
+                    header: lastHeader,
+                    sql: subFragment,
+                });
+            }
+        }
+        else {
+            throw new Error('No header');
+        }
+    }
+    return schemaObjects;
+};
+exports.parsePgDump = parsePgDump;
+//# sourceMappingURL=parsePgDump.js.map

package/dist/parsePgDump.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsePgDump.js","sourceRoot":"","sources":["../src/parsePgDump.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,MAAM,eAAe,GAAG,OAAC,CAAC,KAAK,CAAC;IAC9B,6CAA6C;IAC7C,KAAK;IACL,8BAA8B;IAC9B,KAAK;IACL,OAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;KAClB,CAAC;IACF,8CAA8C;IAC9C,KAAK;IACL,wDAAwD;IACxD,KAAK;IACL,OAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC;YACX,KAAK;YACL,WAAW;YACX,MAAM;YACN,SAAS;YACT,YAAY;YACZ,SAAS;YACT,WAAW;YACX,eAAe;YACf,UAAU;YACV,OAAO;YACP,mBAAmB;YACnB,WAAW;YACX,aAAa;YACb,QAAQ;YACR,mBAAmB;YACnB,UAAU;YACV,OAAO;YACP,2BAA2B;YAC3B,wBAAwB;YACxB,SAAS;YACT,MAAM;YACN,MAAM;SACP,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAIH,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAAW,EAAE;IAC7C,OAAO,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IACnC,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,SAAS,EAAE;QACxD,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,SAAiB,EAA2B,EAAE;IACpE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE3C,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,KAAK;AACL,yEAAyE;AACzE,KAAK;AAEL,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,EAAE;IACvC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACnC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEtC,IACE,WAAW,KAAK,0BAA0B;QAC1C,WAAW,KAAK,mCAAmC,EACnD;QACA,OAAO,eAAe,CAAC,KAAK,CAAC;YAC3B,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;KACJ;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QACxC,OAAO,cAAc,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC,CAAC,CACH,CAAC;IAEF,MAAM,MAAM,GAAG,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAElD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACnC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC,CAAC;AAaK,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE;IAC1C,MAAM,aAAa,GAAmB,EAAE,CAAC;IAEzC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAExD,IAAI,UAAU,GAAkB,IAAI,CAAC;IAErC,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE;QAC7D,IAAI,QAAQ,KAAK,EAAE,EAAE;YACnB,SAAS;SACV;QAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACtB,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;SACpC;aAAM,IAAI,UAAU,EAAE;YACrB,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAE9C,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;gBACtC,aAAa,CAAC,IAAI,CAAC;oBACjB,MAAM,EAAE,UAAU;oBAClB,GAAG,EAAE,WAAW;iBACjB,CAAC,CAAC;aACJ;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;SAC9B;KACF;IAED,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AA7BW,QAAA,WAAW,eA6BtB"}

package/dist/parsePgDump.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=parsePgDump.test.d.ts.map

package/dist/parsePgDump.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsePgDump.test.d.ts","sourceRoot":"","sources":["../src/parsePgDump.test.ts"],"names":[],"mappings":""}