@prairielearn/postgres-tools 1.0.0

package/dist/bin/pg-describe.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/pg-describe.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const async_1 = __importDefault(require("async"));
+const chalk_1 = __importDefault(require("chalk"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const lodash_1 = __importDefault(require("lodash"));
+const path_1 = __importDefault(require("path"));
+const yargs_1 = __importDefault(require("yargs"));
+const describe_1 = require("../describe");
+const args = yargs_1.default
+    .usage('Usage: $0 <database name> [options]')
+    .demandCommand(1)
+    .option('output', {
+    alias: 'o',
+    nargs: 1,
+    string: true,
+    description: 'Specify a directory to output files to',
+})
+    .option('ignore-tables', {
+    array: true,
+    description: 'a list of tables to ignore',
+})
+    .option('ignore-enums', {
+    array: true,
+    description: 'a list of enums to ignore',
+})
+    .option('ignore-columns', {
+    array: true,
+    description: 'a list of columns to ignore, formatted like [table].[column]',
+})
+    .help('h')
+    .alias('h', 'help')
+    .example('$0 postgres', 'Describe the "postgres" database')
+    .example('$0 userdb -o db_description --ignore-tables a b --ignore-columns a.col1 a.col2', 'Describe the "userdb" database; ignore specific tables and columns')
+    .strict();
+const argv = args.parseSync();
+if (argv._.length !== 1) {
+    args.showHelp();
+    process.exit(1);
+}
+// Disable color if we're not attached to a tty
+const coloredOutput = !argv.output && process.stdout.isTTY;
+const options = {
+    ignoreTables: (argv['ignore-tables'] ?? []).map((table) => table.toString()),
+    ignoreEnums: (argv['ignore-enums'] ?? []).map((enumName) => enumName.toString()),
+    ignoreColumns: (argv['ignore-columns'] ?? []).map((column) => column.toString()),
+};
+function formatText(text, formatter) {
+    if (!argv.output && coloredOutput) {
+        return formatter(text);
+    }
+    return text;
+}
+(0, describe_1.describeDatabase)(argv._[0].toString(), options).then(async (description) => {
+    if (argv.output) {
+        await writeDescriptionToDisk(description, argv.output);
+    }
+    else {
+        printDescription(description);
+    }
+    process.exit(0);
+}, (err) => {
+    console.error(err);
+    process.exit(1);
+});
+function printDescription(description) {
+    const formattedDescription = (0, describe_1.formatDatabaseDescription)(description, { coloredOutput });
+    lodash_1.default.forEach(lodash_1.default.sortBy(lodash_1.default.keys(formattedDescription.tables)), (tableName) => {
+        process.stdout.write(formatText(`[table] ${tableName}\n`, chalk_1.default.bold));
+        process.stdout.write(formattedDescription.tables[tableName]);
+        process.stdout.write('\n\n');
+    });
+    lodash_1.default.forEach(lodash_1.default.sortBy(lodash_1.default.keys(formattedDescription.enums)), (enumName) => {
+        process.stdout.write(formatText(`[enum] ${enumName}\n`, chalk_1.default.bold));
+        process.stdout.write(formattedDescription.enums[enumName]);
+        process.stdout.write('\n\n');
+    });
+}
+async function writeDescriptionToDisk(description, dir) {
+    const formattedDescription = (0, describe_1.formatDatabaseDescription)(description, { coloredOutput: false });
+    await fs_extra_1.default.emptyDir(dir);
+    await fs_extra_1.default.mkdir(path_1.default.join(dir, 'tables'));
+    await fs_extra_1.default.mkdir(path_1.default.join(dir, 'enums'));
+    await async_1.default.eachOf(formattedDescription.tables, async (value, key) => {
+        await fs_extra_1.default.writeFile(path_1.default.join(dir, 'tables', `${key}.pg`), value);
+    });
+    await async_1.default.eachOf(formattedDescription.enums, async (value, key) => {
+        await fs_extra_1.default.writeFile(path_1.default.join(dir, 'enums', `${key}.pg`), value);
+    });
+}
+//# sourceMappingURL=pg-describe.js.map

package/dist/bin/pg-describe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pg-describe.js","sourceRoot":"","sources":["../../src/bin/pg-describe.ts"],"names":[],"mappings":";;;;;;AAEA,kDAA0B;AAC1B,kDAA0B;AAC1B,wDAA0B;AAC1B,oDAAuB;AACvB,gDAAwB;AACxB,kDAA0B;AAE1B,0CAA+F;AAE/F,MAAM,IAAI,GAAG,eAAK;KACf,KAAK,CAAC,qCAAqC,CAAC;KAC5C,aAAa,CAAC,CAAC,CAAC;KAChB,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,KAAK,EAAE,CAAC;IACR,MAAM,EAAE,IAAI;IACZ,WAAW,EAAE,wCAAwC;CACtD,CAAC;KACD,MAAM,CAAC,eAAe,EAAE;IACvB,KAAK,EAAE,IAAI;IACX,WAAW,EAAE,4BAA4B;CAC1C,CAAC;KACD,MAAM,CAAC,cAAc,EAAE;IACtB,KAAK,EAAE,IAAI;IACX,WAAW,EAAE,2BAA2B;CACzC,CAAC;KACD,MAAM,CAAC,gBAAgB,EAAE;IACxB,KAAK,EAAE,IAAI;IACX,WAAW,EAAE,8DAA8D;CAC5E,CAAC;KACD,IAAI,CAAC,GAAG,CAAC;KACT,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;KAClB,OAAO,CAAC,aAAa,EAAE,kCAAkC,CAAC;KAC1D,OAAO,CACN,gFAAgF,EAChF,oEAAoE,CACrE;KACA,MAAM,EAAE,CAAC;AAEZ,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;AAE9B,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;IACvB,IAAI,CAAC,QAAQ,EAAE,CAAC;IAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB;AAED,+CAA+C;AAC/C,MAAM,aAAa,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;AAE3D,MAAM,OAAO,GAAG;IACd,YAAY,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC5E,WAAW,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAChF,aAAa,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;CACjF,CAAC;AAEF,SAAS,UAAU,CAAC,IAAY,EAAE,SAAmC;IACnE,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,aAAa,EAAE;QACjC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;KACxB;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,IAAA,2BAAgB,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC,IAAI,CAClD,KAAK,EAAE,WAAW,EAAE,EAAE;IACpB,IAAI,IAAI,CAAC,MAAM,EAAE;QACf,MAAM,sBAAsB,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;KACxD;SAAM;QACL,gBAAgB,CAAC,WAAW,CAAC,CAAC;KAC/B;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,EACD,CAAC,GAAG,EAAE,EAAE;IACN,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CACF,CAAC;AAEF,SAAS,gBAAgB,CAAC,WAAgC;IACxD,MAAM,oBAAoB,GAAG,IAAA,oCAAyB,EAAC,WAAW,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;IACvF,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,MAAM,CAAC,gBAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE;QACrE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,SAAS,IAAI,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,MAAM,CAAC,gBAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,QAAQ,IAAI,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,sBAAsB,CAAC,WAAgC,EAAE,GAAW;IACjF,MAAM,oBAAoB,GAAG,IAAA,oCAAyB,EAAC,WAAW,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,MAAM,kBAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACvB,MAAM,kBAAE,CAAC,KAAK,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;IACzC,MAAM,kBAAE,CAAC,KAAK,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IACxC,MAAM,eAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACnE,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,GAAG,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IACH,MAAM,eAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAClE,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,GAAG,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/bin/pg-diff.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/pg-diff.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_1 = __importDefault(require("yargs"));
+const diff_1 = require("../diff");
+const args = yargs_1.default
+    .usage('Usage: $0 [options]')
+    .option('db', {
+    description: 'reads a description from the named database',
+})
+    .option('dir', {
+    description: "reads a description from a directory that's been generated by pg-describe",
+})
+    .help('h')
+    .alias('h', 'help')
+    .example('$0 --db postgres --dir db_dump', 'Diffs the database "postgres" with the description in the directory "db_dump"')
+    .example('$0 --db postgres --db old_restore', 'Diffs the database "postgres" with the database "old_restore"')
+    .strict();
+const argv = args.parseSync();
+const options = {
+    outputFormat: 'string',
+    coloredOutput: process.stdout.isTTY,
+};
+if (argv.db && typeof argv.db === 'string' && argv.dir && typeof argv.dir === 'string') {
+    // Ensure correct ordering for the sake of diffs
+    if (process.argv.indexOf('--db') < process.argv.indexOf('--dir')) {
+        (0, diff_1.diffDatabaseAndDirectory)(argv.db, argv.dir, options).then(handleResults, handleError);
+    }
+    else {
+        (0, diff_1.diffDirectoryAndDatabase)(argv.dir, argv.db, options).then(handleResults, handleError);
+    }
+}
+else if (argv.db && Array.isArray(argv.db) && argv.db.length === 2 && !argv.dir) {
+    (0, diff_1.diffDatabases)(argv.db[0], argv.db[1], options).then(handleResults, handleError);
+}
+else if (argv.dir && Array.isArray(argv.dir) && argv.dir.length === 2 && !argv.db) {
+    (0, diff_1.diffDirectories)(argv.dir[0], argv.dir[1], options).then(handleResults, handleError);
+}
+else {
+    args.showHelp();
+    process.exit(1);
+}
+function handleResults(results) {
+    process.stdout.write(results);
+    process.exit(0);
+}
+function handleError(err) {
+    console.error(err);
+    process.exit(1);
+}
+//# sourceMappingURL=pg-diff.js.map

package/dist/bin/pg-diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pg-diff.js","sourceRoot":"","sources":["../../src/bin/pg-diff.ts"],"names":[],"mappings":";;;;;;AAEA,kDAA0B;AAE1B,kCAKiB;AAEjB,MAAM,IAAI,GAAG,eAAK;KACf,KAAK,CAAC,qBAAqB,CAAC;KAC5B,MAAM,CAAC,IAAI,EAAE;IACZ,WAAW,EAAE,6CAA6C;CAC3D,CAAC;KACD,MAAM,CAAC,KAAK,EAAE;IACb,WAAW,EAAE,2EAA2E;CACzF,CAAC;KACD,IAAI,CAAC,GAAG,CAAC;KACT,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;KAClB,OAAO,CACN,gCAAgC,EAChC,+EAA+E,CAChF;KACA,OAAO,CACN,mCAAmC,EACnC,+DAA+D,CAChE;KACA,MAAM,EAAE,CAAC;AAEZ,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;AAE9B,MAAM,OAAO,GAAG;IACd,YAAY,EAAE,QAAQ;IACtB,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK;CACpC,CAAC;AAEF,IAAI,IAAI,CAAC,EAAE,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC,GAAG,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,EAAE;IACtF,gDAAgD;IAChD,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAChE,IAAA,+BAAwB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;KACvF;SAAM;QACL,IAAA,+BAAwB,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;KACvF;CACF;KAAM,IAAI,IAAI,CAAC,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;IACjF,IAAA,oBAAa,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;CACjF;KAAM,IAAI,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;IACnF,IAAA,sBAAe,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;CACrF;KAAM;IACL,IAAI,CAAC,QAAQ,EAAE,CAAC;IAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB;AAED,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,SAAS,WAAW,CAAC,GAAQ;IAC3B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC"}

package/dist/describe.d.ts

@@ -0,0 +1,55 @@
+interface ColumnDescription {
+    name: string;
+    type: string;
+    notnull: boolean;
+    default: any;
+}
+interface IndexDescription {
+    name: string;
+    isprimary: boolean;
+    isunique: boolean;
+    indexdef: string;
+    constraintdef: string;
+    contype: string;
+}
+interface ForeignKeyConstraintDescription {
+    name: string;
+    def: string;
+}
+interface ReferenceDescription {
+    name: string;
+    table: string;
+    condef: string;
+}
+interface CheckConstraintDescription {
+    name: string;
+    def: string;
+}
+interface TableDescription {
+    columns: ColumnDescription[];
+    indexes: IndexDescription[];
+    foreignKeyConstraints: ForeignKeyConstraintDescription[];
+    references: ReferenceDescription[];
+    checkConstraints: CheckConstraintDescription[];
+}
+export interface DatabaseDescription {
+    tables: Record<string, TableDescription>;
+    enums: Record<string, string[]>;
+}
+interface DescribeOptions {
+    ignoreTables?: string[];
+    ignoreColumns?: string[];
+    ignoreEnums?: string[];
+}
+/**
+ * Will produce a description of a given database's schema. This will include
+ * information about tables, enums, constraints, indices, etc.
+ */
+export declare function describeDatabase(databaseName: string, options?: DescribeOptions): Promise<DatabaseDescription>;
+export declare function formatDatabaseDescription(description: DatabaseDescription, options?: {
+    coloredOutput: boolean;
+}): {
+    tables: Record<string, string>;
+    enums: Record<string, string>;
+};
+export {};

package/dist/describe.js

@@ -0,0 +1,236 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDatabaseDescription = exports.describeDatabase = void 0;
+// @ts-check
+const pg_1 = __importDefault(require("pg"));
+const chalk_1 = __importDefault(require("chalk"));
+const postgres_1 = require("@prairielearn/postgres");
+const sql = (0, postgres_1.loadSqlEquiv)(__filename);
+const pgArray = pg_1.default.types.arrayParser;
+function parsePostgresArray(arr) {
+    // @ts-expect-error -- Incorrect type definitions in `pg-types`.
+    return pgArray.create(arr, String).parse();
+}
+async function describeWithPool(pool, options) {
+    const ignoreTables = options?.ignoreTables || [];
+    const ignoreEnums = options?.ignoreEnums || [];
+    let ignoreColumns = {};
+    const output = {
+        tables: {},
+        enums: {},
+    };
+    // Get the names of the tables and filter out any ignored tables
+    const tablesRes = await pool.queryAsync(sql.get_tables, []);
+    const tables = tablesRes.rows.filter((table) => ignoreTables.indexOf(table.name) === -1);
+    // Transform ignored columns into a map from table names to arrays
+    // of column names
+    if (options.ignoreColumns && Array.isArray(options.ignoreColumns)) {
+        ignoreColumns = options.ignoreColumns
+            .filter((ignore) => {
+            return /^[^\s.]*\.[^\s.]*$/.test(ignore);
+        })
+            .reduce((result, value) => {
+            const res = /^(([^\s.]*)\.([^\s.]*))$/.exec(value);
+            if (!res) {
+                throw new Error(`Invalid ignore column: ${value}`);
+            }
+            const table = res[2];
+            const column = res[3];
+            (result[table] || (result[table] = [])).push(column);
+            return result;
+        }, {});
+    }
+    // Get column info for each table
+    for (const table of tables) {
+        const columnResults = await pool.queryAsync(sql.get_columns_for_table, {
+            oid: table.oid,
+        });
+        const columns = columnResults.rows.filter((row) => {
+            return (ignoreColumns[table.name] || []).indexOf(row.name) === -1;
+        });
+        const indexResults = await pool.queryAsync(sql.get_indexes_for_table, {
+            oid: table.oid,
+        });
+        const foreignKeyConstraintResults = await pool.queryAsync(sql.get_foreign_key_constraints_for_table, {
+            oid: table.oid,
+        });
+        const referenceResults = await pool.queryAsync(sql.get_references_for_table, {
+            oid: table.oid,
+        });
+        // Filter out references from ignored tables
+        const references = referenceResults.rows.filter((row) => {
+            return ignoreTables.indexOf(row.table) === -1;
+        });
+        const checkConstraintResults = await pool.queryAsync(sql.get_check_constraints_for_table, {
+            oid: table.oid,
+        });
+        output.tables[table.name] = {
+            columns: columns,
+            indexes: indexResults.rows,
+            foreignKeyConstraints: foreignKeyConstraintResults.rows,
+            references: references,
+            checkConstraints: checkConstraintResults.rows,
+        };
+    }
+    // Get all enums
+    const enumsRes = await pool.queryAsync(sql.get_enums, []);
+    // Filter ignored enums
+    const rows = enumsRes.rows.filter((row) => {
+        return ignoreEnums.indexOf(row.name) === -1;
+    });
+    rows.forEach((row) => {
+        output.enums[row.name] = parsePostgresArray(row.values);
+    });
+    return output;
+}
+/**
+ * Will produce a description of a given database's schema. This will include
+ * information about tables, enums, constraints, indices, etc.
+ */
+async function describeDatabase(databaseName, options = {}) {
+    // Connect to the database.
+    const pool = new postgres_1.PostgresPool();
+    const pgConfig = {
+        user: 'postgres',
+        database: databaseName,
+        host: 'localhost',
+        max: 10,
+        idleTimeoutMillis: 30000,
+    };
+    function idleErrorHandler(err) {
+        throw err;
+    }
+    await pool.initAsync(pgConfig, idleErrorHandler);
+    try {
+        return await describeWithPool(pool, options);
+    }
+    finally {
+        await pool.closeAsync();
+    }
+}
+exports.describeDatabase = describeDatabase;
+function formatDatabaseDescription(description, options = { coloredOutput: true }) {
+    const output = {
+        tables: {},
+        enums: {},
+    };
+    Object.keys(description.tables).forEach((tableName) => (output.tables[tableName] = ''));
+    /**
+     * Optionally applies the given formatter to the text if colored output is
+     * enabled.
+     */
+    function formatText(text, formatter) {
+        if (options.coloredOutput) {
+            return formatter(text);
+        }
+        return text;
+    }
+    Object.entries(description.tables).forEach(([tableName, table]) => {
+        if (table.columns.length > 0) {
+            output.tables[tableName] += formatText('columns\n', chalk_1.default.underline);
+            output.tables[tableName] += table.columns
+                .map((row) => {
+                let rowText = formatText(`    ${row.name}`, chalk_1.default.bold);
+                rowText += ':' + formatText(` ${row.type}`, chalk_1.default.green);
+                if (row.notnull) {
+                    rowText += formatText(' not null', chalk_1.default.gray);
+                }
+                if (row.default) {
+                    rowText += formatText(` default ${row.default}`, chalk_1.default.gray);
+                }
+                return rowText;
+            })
+                .join('\n');
+        }
+        if (table.indexes.length > 0) {
+            if (output.tables[tableName].length !== 0) {
+                output.tables[tableName] += '\n\n';
+            }
+            output.tables[tableName] += formatText('indexes\n', chalk_1.default.underline);
+            output.tables[tableName] += table.indexes
+                .map((row) => {
+                const using = row.indexdef.substring(row.indexdef.indexOf('USING '));
+                let rowText = formatText(`    ${row.name}`, chalk_1.default.bold) + ':';
+                // Primary indexes are implicitly unique, so we don't need to
+                // capture that explicitly.
+                if (row.isunique && !row.isprimary) {
+                    if (!row.constraintdef || row.constraintdef.indexOf('UNIQUE') === -1) {
+                        // Some unique indexes don't include the UNIQUE constraint
+                        // as part of the constraint definition, so we need to capture
+                        // that manually.
+                        rowText += formatText(` UNIQUE`, chalk_1.default.green);
+                    }
+                }
+                rowText += row.constraintdef ? formatText(` ${row.constraintdef}`, chalk_1.default.green) : '';
+                rowText += using ? formatText(` ${using}`, chalk_1.default.green) : '';
+                return rowText;
+            })
+                .join('\n');
+        }
+        if (table.checkConstraints.length > 0) {
+            if (output.tables[tableName].length !== 0) {
+                output.tables[tableName] += '\n\n';
+            }
+            output.tables[tableName] += formatText('check constraints\n', chalk_1.default.underline);
+            output.tables[tableName] += table.checkConstraints
+                .map((row) => {
+                // Particularly long constraints are formatted as multiple lines.
+                // We'll collapse them into a single line for better appearance in
+                // the resulting file.
+                //
+                // The first replace handles lines that end with a parenthesis: we
+                // want to avoid spaces between the parenthesis and the next token.
+                //
+                // The second replace handles all other lines: we want to collapse
+                // all leading whitespace into a single space.
+                const def = row.def.replace(/\(\n/g, '(').replace(/\n\s*/g, ' ');
+                let rowText = formatText(`    ${row.name}:`, chalk_1.default.bold);
+                rowText += formatText(` ${def}`, chalk_1.default.green);
+                return rowText;
+            })
+                .join('\n');
+        }
+        if (table.foreignKeyConstraints.length > 0) {
+            if (output.tables[tableName].length !== 0) {
+                output.tables[tableName] += '\n\n';
+            }
+            output.tables[tableName] += formatText('foreign-key constraints\n', chalk_1.default.underline);
+            output.tables[tableName] += table.foreignKeyConstraints
+                .map((row) => {
+                let rowText = formatText(`    ${row.name}:`, chalk_1.default.bold);
+                rowText += formatText(` ${row.def}`, chalk_1.default.green);
+                return rowText;
+            })
+                .join('\n');
+        }
+        if (table.references.length > 0) {
+            if (output.tables[tableName].length !== 0) {
+                output.tables[tableName] += '\n\n';
+            }
+            output.tables[tableName] += formatText('referenced by\n', chalk_1.default.underline);
+            output.tables[tableName] += table.references
+                ?.map((row) => {
+                let rowText = formatText(`    ${row.table}:`, chalk_1.default.bold);
+                rowText += formatText(` ${row.condef}`, chalk_1.default.green);
+                return rowText;
+            })
+                .join('\n');
+        }
+    });
+    Object.entries(description.enums).forEach(([enumName, enumValues]) => {
+        output.enums[enumName] = formatText(enumValues.join(', '), chalk_1.default.gray);
+    });
+    // We need to tack on a newline to everything.
+    Object.entries(output.tables).forEach(([tableName, table]) => {
+        output.tables[tableName] = table + '\n';
+    });
+    Object.entries(output.enums).forEach(([enumName, enumValues]) => {
+        output.enums[enumName] = enumValues + '\n';
+    });
+    return output;
+}
+exports.formatDatabaseDescription = formatDatabaseDescription;
+//# sourceMappingURL=describe.js.map

package/dist/describe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":";;;;;;AAAA,YAAY;AACZ,4CAAoB;AACpB,kDAA0B;AAC1B,qDAAoE;AAEpE,MAAM,GAAG,GAAG,IAAA,uBAAY,EAAC,UAAU,CAAC,CAAC;AACrC,MAAM,OAAO,GAAG,YAAE,CAAC,KAAK,CAAC,WAAW,CAAC;AAqDrC,SAAS,kBAAkB,CAAC,GAAW;IACrC,gEAAgE;IAChE,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,IAAkB,EAClB,OAAwB;IAExB,MAAM,YAAY,GAAG,OAAO,EAAE,YAAY,IAAI,EAAE,CAAC;IACjD,MAAM,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,EAAE,CAAC;IAC/C,IAAI,aAAa,GAA6B,EAAE,CAAC;IAEjD,MAAM,MAAM,GAAwB;QAClC,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,EAAE;KACV,CAAC;IAEF,gEAAgE;IAChE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzF,kEAAkE;IAClE,kBAAkB;IAClB,IAAI,OAAO,CAAC,aAAa,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACjE,aAAa,GAAG,OAAO,CAAC,aAAa;aAClC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;YACjB,OAAO,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACxB,MAAM,GAAG,GAAG,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnD,IAAI,CAAC,GAAG,EAAE;gBACR,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,EAAE,CAAC,CAAC;aACpD;YACD,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YACrB,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,EAA8B,CAAC,CAAC;KACtC;IAED,iCAAiC;IACjC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,qBAAqB,EAAE;YACrE,GAAG,EAAE,KAAK,CAAC,GAAG;SACf,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YAChD,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,qBAAqB,EAAE;YACpE,GAAG,EAAE,KAAK,CAAC,GAAG;SACf,CAAC,CAAC;QAEH,MAAM,2BAA2B,GAAG,MAAM,IAAI,CAAC,UAAU,CACvD,GAAG,CAAC,qCAAqC,EACzC;YACE,GAAG,EAAE,KAAK,CAAC,GAAG;SACf,CACF,CAAC;QAEF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,wBAAwB,EAAE;YAC3E,GAAG,EAAE,KAAK,CAAC,GAAG;SACf,CAAC,CAAC;QAEH,4CAA4C;QAC5C,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YACtD,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,+BAA+B,EAAE;YACxF,GAAG,EAAE,KAAK,CAAC,GAAG;SACf,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;YAC1B,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,YAAY,CAAC,IAAI;YAC1B,qBAAqB,EAAE,2BAA2B,CAAC,IAAI;YACvD,UAAU,EAAE,UAAU;YACtB,gBAAgB,EAAE,sBAAsB,CAAC,IAAI;SAC9C,CAAC;KACH;IAED,gBAAgB;IAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAE1D,uBAAuB;IACvB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACxC,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,gBAAgB,CACpC,YAAoB,EACpB,UAA2B,EAAE;IAE7B,2BAA2B;IAC3B,MAAM,IAAI,GAAG,IAAI,uBAAY,EAAE,CAAC;IAChC,MAAM,QAAQ,GAAG;QACf,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,YAAY;QACtB,IAAI,EAAE,WAAW;QACjB,GAAG,EAAE,EAAE;QACP,iBAAiB,EAAE,KAAK;KACzB,CAAC;IACF,SAAS,gBAAgB,CAAC,GAAU;QAClC,MAAM,GAAG,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;IAEjD,IAAI;QACF,OAAO,MAAM,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KAC9C;YAAS;QACR,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;KACzB;AACH,CAAC;AAvBD,4CAuBC;AAED,SAAgB,yBAAyB,CACvC,WAAgC,EAChC,OAAO,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE;IAEjC,MAAM,MAAM,GAAG;QACb,MAAM,EAAE,EAA4B;QACpC,KAAK,EAAE,EAA4B;KACpC,CAAC;IAEF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAExF;;;OAGG;IACH,SAAS,UAAU,CAAC,IAAY,EAAE,SAAgC;QAChE,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;SACxB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;QAChE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,WAAW,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;YACrE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,OAAO;iBACtC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACX,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,GAAG,CAAC,IAAI,EAAE,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;gBACxD,OAAO,IAAI,GAAG,GAAG,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC;gBACzD,IAAI,GAAG,CAAC,OAAO,EAAE;oBACf,OAAO,IAAI,UAAU,CAAC,WAAW,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;iBAChD;gBACD,IAAI,GAAG,CAAC,OAAO,EAAE;oBACf,OAAO,IAAI,UAAU,CAAC,YAAY,GAAG,CAAC,OAAO,EAAE,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;iBAC9D;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;SACf;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC;aACpC;YACD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,WAAW,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;YACrE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,OAAO;iBACtC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACX,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACrE,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,GAAG,CAAC,IAAI,EAAE,EAAE,eAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;gBAC9D,6DAA6D;gBAC7D,2BAA2B;gBAC3B,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE;oBAClC,IAAI,CAAC,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE;wBACpE,0DAA0D;wBAC1D,8DAA8D;wBAC9D,iBAAiB;wBACjB,OAAO,IAAI,UAAU,CAAC,SAAS,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC;qBAC/C;iBACF;gBACD,OAAO,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,aAAa,EAAE,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrF,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,KAAK,EAAE,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7D,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;SACf;QAED,IAAI,KAAK,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC;aACpC;YACD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,qBAAqB,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;YAC/E,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,gBAAgB;iBAC/C,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACX,iEAAiE;gBACjE,kEAAkE;gBAClE,sBAAsB;gBACtB,EAAE;gBACF,kEAAkE;gBAClE,mEAAmE;gBACnE,EAAE;gBACF,kEAAkE;gBAClE,8CAA8C;gBAC9C,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;gBAEjE,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;gBACzD,OAAO,IAAI,UAAU,CAAC,IAAI,GAAG,EAAE,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC;gBAC9C,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;SACf;QAED,IAAI,KAAK,CAAC,qBAAqB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1C,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC;aACpC;YACD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,2BAA2B,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;YACrF,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,qBAAqB;iBACpD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACX,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;gBACzD,OAAO,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC;gBAClD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;SACf;QAED,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC;aACpC;YACD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,iBAAiB,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;YAC3E,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU;gBAC1C,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACZ,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,GAAG,CAAC,KAAK,GAAG,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;gBAC1D,OAAO,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC;gBACrD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;SACf;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE;QACnE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,8CAA8C;IAC9C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;QAC3D,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC;IAC1C,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE;QAC9D,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AArID,8DAqIC"}

package/dist/describe.sql

@@ -0,0 +1,129 @@
+-- BLOCK get_tables
+SELECT
+  c.relname AS name,
+  c.oid AS oid
+FROM
+  pg_catalog.pg_class c
+  JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+WHERE
+  c.relkind = 'r'
+  AND n.nspname != 'pg_catalog'
+  AND n.nspname != 'information_schema'
+  AND n.nspname !~ '^pg_toast'
+  AND pg_catalog.pg_table_is_visible (c.oid)
+ORDER BY
+  c.relname;
+
+-- BLOCK get_columns_for_table
+SELECT
+  a.attname AS name,
+  pg_catalog.format_type (a.atttypid, a.atttypmod) AS
+type,
+a.attnotnull AS notnull,
+(
+  SELECT
+    substring(
+      pg_catalog.pg_get_expr (d.adbin, d.adrelid) for 128
+    )
+  FROM
+    pg_catalog.pg_attrdef d
+  WHERE
+    d.adrelid = a.attrelid
+    AND d.adnum = a.attnum
+    AND a.atthasdef
+) AS default
+FROM
+  pg_catalog.pg_attribute a
+  JOIN pg_catalog.pg_class c ON a.attrelid = c.oid
+WHERE
+  a.attrelid = $oid
+  AND NOT a.attisdropped
+  AND a.attnum > 0
+ORDER BY
+  a.attname;
+
+-- BLOCK get_indexes_for_table
+SELECT
+  c2.relname AS name,
+  i.indisprimary AS isprimary,
+  i.indisunique AS isunique,
+  pg_catalog.pg_get_indexdef (i.indexrelid, 0, true) AS indexdef,
+  pg_catalog.pg_get_constraintdef (con.oid, true) AS constraintdef,
+  contype
+FROM
+  pg_catalog.pg_class c,
+  pg_catalog.pg_class c2,
+  pg_catalog.pg_index i
+  LEFT JOIN pg_catalog.pg_constraint con ON (
+    conrelid = i.indrelid
+    AND conindid = i.indexrelid
+    AND contype IN ('p', 'u')
+  )
+WHERE
+  c.oid = $oid
+  AND c.oid = i.indrelid
+  AND i.indexrelid = c2.oid
+ORDER BY
+  i.indisprimary DESC,
+  i.indisunique DESC,
+  c2.relname;
+
+-- BLOCK get_references_for_table
+SELECT
+  conname AS name,
+  conrelid::pg_catalog.regclass AS table,
+  pg_catalog.pg_get_constraintdef (c.oid, true) as condef
+FROM
+  pg_catalog.pg_constraint c
+WHERE
+  c.confrelid = $oid
+  AND c.contype = 'f'
+ORDER BY
+  conname;
+
+-- BLOCK get_foreign_key_constraints_for_table
+SELECT
+  conname AS name,
+  pg_catalog.pg_get_constraintdef (r.oid, true) as def
+FROM
+  pg_catalog.pg_constraint r
+WHERE
+  r.conrelid = $oid
+  AND r.contype = 'f'
+ORDER BY
+  1;
+
+-- BLOCK get_check_constraints_for_table
+SELECT
+  conname AS name,
+  pg_catalog.pg_get_constraintdef (r.oid, true) as def
+FROM
+  pg_catalog.pg_constraint r
+WHERE
+  r.conrelid = $oid
+  AND r.contype = 'c'
+ORDER BY
+  1;
+
+-- BLOCK get_enums
+SELECT
+  t.typname AS name,
+  ARRAY (
+    SELECT
+      e.enumlabel
+    FROM
+      pg_catalog.pg_enum e
+    WHERE
+      e.enumtypid = t.oid
+    ORDER BY
+      e.enumsortorder
+  ) AS
+values
+FROM
+  pg_type t
+  JOIN pg_enum e ON t.oid = e.enumtypid
+  JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
+GROUP BY
+  n.nspname,
+  t.typname,
+  t.oid;

package/dist/diff.d.ts

@@ -0,0 +1,8 @@
+type DiffOptions = {
+    coloredOutput?: boolean;
+};
+export declare function diffDatabases(database1: string, database2: string, options: DiffOptions): Promise<string>;
+export declare function diffDatabaseAndDirectory(database: string, directory: string, options: DiffOptions): Promise<string>;
+export declare function diffDirectoryAndDatabase(directory: string, database: string, options: DiffOptions): Promise<string>;
+export declare function diffDirectories(directory1: string, directory2: string, options: DiffOptions): Promise<string>;
+export {};