@antelopejs/postgres 0.0.1-stage → 0.2.1

package/dist/implementations/database/external-column-profile.js

@@ -0,0 +1,223 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Profiled = Profiled;
+exports.ProfileColumn = ProfileColumn;
+const external_measures_1 = require("./external-measures");
+const external_sample_1 = require("./external-sample");
+const external_declarations_1 = require("./external-declarations");
+const external_types_1 = require("./external-types");
+const sql_1 = require("./sql");
+const CATEGORY_LIMIT = 25;
+const CATEGORY_MIN_ROWS = 5;
+const ENUM_LIKE_MIN_ROWS = 100;
+const MONTH_LIMIT = 36;
+const LABEL_DISTINCT_SHARE = 0.9;
+const LABEL_MAX_LENGTH = 80;
+const TIME_AXIS_FILLED_SHARE = 0.9;
+const TIME_AXIS_MIN_MONTHS = 3;
+const MONTHS_PER_YEAR = 12;
+const TEXT_FAMILIES = ["text", "citext", "bpchar"];
+const CATEGORY_FAMILIES = [
+    ...TEXT_FAMILIES,
+    "enum",
+    "int",
+    "int8",
+    "bool",
+];
+const RANGED_KINDS = ["float", "timestamp"];
+const DISTINCT_KINDS = [
+    "text",
+    "float",
+    "bool",
+    "timestamp",
+];
+function Profiled(column) {
+    const family = (0, external_types_1.FamilyOf)(column);
+    const [proposed] = (0, external_declarations_1.AcceptedDeclarations)(column);
+    if (!family || !proposed) {
+        return undefined;
+    }
+    return {
+        name: column.name,
+        family,
+        kind: proposed.kind,
+        quoted: `${external_sample_1.SOURCE_ALIAS}.${(0, sql_1.QuoteIdentifier)(column.name)}`,
+    };
+}
+function RangeExpression(column) {
+    if (column.family === "enum") {
+        return `(${column.quoted})`;
+    }
+    if (!RANGED_KINDS.includes(column.kind.kind)) {
+        return undefined;
+    }
+    return column.kind.kind === "timestamp"
+        ? InstantExpression(column)
+        : `(${column.quoted})::float8`;
+}
+const INSTANTS = {
+    timestamptz: (column) => column,
+    timestamp: (column) => `(${column} AT TIME ZONE 'UTC')`,
+    date: (column) => `((${column})::timestamp AT TIME ZONE 'UTC')`,
+};
+function InstantExpression(column) {
+    return (INSTANTS[column.family] ?? ((value) => value))(column.quoted);
+}
+function BaseSql(column, source) {
+    const range = RangeExpression(column);
+    const isText = TEXT_FAMILIES.includes(column.family);
+    const length = `length(${column.quoted})`;
+    return `SELECT (count(*) - count(${column.quoted}))::float8 AS nulls,
+    ${range ? `min(${range})` : "NULL"} AS min, ${range ? `max(${range})` : "NULL"} AS max,
+    ${isText ? `min(${length})` : "NULL"}::float8 AS "minLength",
+    ${isText ? `avg(${length})` : "NULL"}::float8 AS "avgLength",
+    ${isText ? `max(${length})` : "NULL"}::float8 AS "maxLength"
+    FROM ${source.from}`;
+}
+function RangeValue(column, row) {
+    if (row.min === null || row.max === null) {
+        return undefined;
+    }
+    return { min: RangeEnd(row.min), max: RangeEnd(row.max) };
+}
+function RangeEnd(value) {
+    return value instanceof Date ? value.toISOString() : value;
+}
+function LengthValue(row) {
+    if (row.minLength === null ||
+        row.avgLength === null ||
+        row.maxLength === null) {
+        return undefined;
+    }
+    return { min: row.minLength, avg: row.avgLength, max: row.maxLength };
+}
+async function MeasureBase(session, column, source) {
+    const measured = await session.measure(BaseSql(column, source));
+    const base = { nulls: (0, external_measures_1.FirstRow)(measured, (row) => row.nulls) };
+    const row = (0, external_measures_1.ValueOf)(measured)?.[0];
+    if (RangeExpression(column)) {
+        base.range =
+            measured.status === "ok"
+                ? Present(row && RangeValue(column, row))
+                : measured;
+    }
+    if (TEXT_FAMILIES.includes(column.family)) {
+        base.length =
+            measured.status === "ok" ? Present(row && LengthValue(row)) : measured;
+    }
+    return base;
+}
+function Present(value) {
+    return value === undefined
+        ? { status: "error", code: "empty" }
+        : { status: "ok", value };
+}
+async function MeasureDistinct(session, column, source) {
+    if (!DISTINCT_KINDS.includes(column.kind.kind)) {
+        return undefined;
+    }
+    const measured = await session.measure(`SELECT count(DISTINCT ${column.quoted})::float8 AS distinct FROM ${source.from}`);
+    return (0, external_measures_1.FirstRow)(measured, (row) => row.distinct);
+}
+const CATEGORY_VALUES = {
+    int: (column) => `(${column})::float8`,
+    int8: (column) => `(${column})::float8`,
+    bool: (column) => column,
+};
+function CategoryValue(column) {
+    return (CATEGORY_VALUES[column.family] ?? ((value) => `(${value})::text`))(column.quoted);
+}
+function AsCategories(rows) {
+    const named = rows.filter((row) => row.rows >= CATEGORY_MIN_ROWS);
+    const other = rows
+        .filter((row) => row.rows < CATEGORY_MIN_ROWS)
+        .reduce((total, row) => total + row.rows, 0);
+    return {
+        values: named.map(({ value, rows: count }) => ({ value, rows: count })),
+        other,
+    };
+}
+async function MeasureCategories(session, column, source, distinct) {
+    const isCategorical = column.family === "enum" || (distinct ?? Infinity) <= CATEGORY_LIMIT;
+    if (!CATEGORY_FAMILIES.includes(column.family) || !isCategorical) {
+        return undefined;
+    }
+    const measured = await session.measure(`SELECT ${CategoryValue(column)} AS value, count(*)::float8 AS rows FROM ${source.from}
+      WHERE ${column.quoted} IS NOT NULL GROUP BY 1 ORDER BY 2 DESC, 1 LIMIT ${CATEGORY_LIMIT + 1}`);
+    return (0, external_measures_1.Mapped)(measured, AsCategories);
+}
+async function MeasureMonths(session, column, source) {
+    if (column.kind.kind !== "timestamp") {
+        return undefined;
+    }
+    const measured = await session.measure(`SELECT to_char(date_trunc('month', ${InstantExpression(column)} AT TIME ZONE 'UTC'), 'YYYY-MM') AS month,
+      count(*)::float8 AS rows FROM ${source.from}
+      WHERE ${column.quoted} IS NOT NULL GROUP BY 1 ORDER BY 1 DESC LIMIT ${MONTH_LIMIT}`);
+    return (0, external_measures_1.Mapped)(measured, (rows) => rows.reverse());
+}
+function MonthsSpanned(range) {
+    const start = new Date(String(range.min));
+    const end = new Date(String(range.max));
+    return ((end.getUTCFullYear() - start.getUTCFullYear()) * MONTHS_PER_YEAR +
+        end.getUTCMonth() -
+        start.getUTCMonth() +
+        1);
+}
+function Filled(facts) {
+    const nulls = (0, external_measures_1.ValueOf)(facts.profile.nulls);
+    return facts.rows === undefined || nulls === undefined
+        ? undefined
+        : facts.rows - nulls;
+}
+const TRAIT_RULES = {
+    "enum-like": (facts) => facts.column.family === "enum" ||
+        (CATEGORY_FAMILIES.includes(facts.column.family) &&
+            ((0, external_measures_1.ValueOf)(facts.profile.distinct) ?? Infinity) <= CATEGORY_LIMIT &&
+            (facts.rows ?? 0) >= ENUM_LIKE_MIN_ROWS),
+    "identifier-like": (facts) => (facts.rows ?? 0) > 0 &&
+        (0, external_measures_1.ValueOf)(facts.profile.nulls) === 0 &&
+        (0, external_measures_1.ValueOf)(facts.profile.distinct) === facts.rows,
+    "label-candidate": (facts) => {
+        const filled = Filled(facts) ?? 0;
+        const distinct = (0, external_measures_1.ValueOf)(facts.profile.distinct) ?? 0;
+        const length = (0, external_measures_1.ValueOf)(facts.profile.length);
+        return (TEXT_FAMILIES.includes(facts.column.family) &&
+            filled > 0 &&
+            distinct >= LABEL_DISTINCT_SHARE * filled &&
+            length !== undefined &&
+            length.avg <= LABEL_MAX_LENGTH);
+    },
+    "time-axis": (facts) => {
+        const range = (0, external_measures_1.ValueOf)(facts.profile.range);
+        return (facts.column.kind.kind === "timestamp" &&
+            range !== undefined &&
+            (Filled(facts) ?? 0) >=
+                TIME_AXIS_FILLED_SHARE * (facts.rows ?? Infinity) &&
+            MonthsSpanned(range) >= TIME_AXIS_MIN_MONTHS);
+    },
+    measure: (facts) => facts.column.kind.kind === "float" &&
+        !facts.roles.keys.has(facts.column.name) &&
+        !facts.roles.references.has(facts.column.name),
+};
+function TraitsOf(facts) {
+    return Object.keys(TRAIT_RULES).filter((trait) => TRAIT_RULES[trait](facts));
+}
+async function ProfileColumn(session, column, source, rows, roles) {
+    const base = await MeasureBase(session, column, source);
+    const distinct = await MeasureDistinct(session, column, source);
+    const categories = await MeasureCategories(session, column, source, (0, external_measures_1.ValueOf)(distinct));
+    const months = await MeasureMonths(session, column, source);
+    const profile = { name: column.name, ...base, traits: [] };
+    if (distinct) {
+        profile.distinct = distinct;
+    }
+    if (categories) {
+        profile.categories = categories;
+    }
+    if (months) {
+        profile.months = months;
+    }
+    profile.traits = TraitsOf({ column, profile, rows, roles });
+    return profile;
+}
+//# sourceMappingURL=external-column-profile.js.map

package/dist/implementations/database/external-column-profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"external-column-profile.js","sourceRoot":"","sources":["../../../src/implementations/database/external-column-profile.ts"],"names":[],"mappings":";;AAkFA,4BAYC;AAuPD,sCA4BC;AAtWD,2DAK6B;AAC7B,uDAA8D;AAC9D,mEAA+D;AAC/D,qDAA+D;AAC/D,+BAAwC;AAIxC,MAAM,cAAc,GAAG,EAAE,CAAC;AAE1B,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAC5B,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAC/B,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B,MAAM,aAAa,GAA4B,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC5E,MAAM,iBAAiB,GAA4B;IACjD,GAAG,aAAa;IAChB,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;CACP,CAAC;AACF,MAAM,YAAY,GAA+B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AACxE,MAAM,cAAc,GAA+B;IACjD,MAAM;IACN,OAAO;IACP,MAAM;IACN,WAAW;CACZ,CAAC;AAiCF,SAAgB,QAAQ,CAAC,MAAqB;IAC5C,MAAM,MAAM,GAAG,IAAA,yBAAQ,EAAC,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAA,4CAAoB,EAAC,MAAM,CAAC,CAAC;IAChD,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM;QACN,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,MAAM,EAAE,GAAG,8BAAY,IAAI,IAAA,qBAAe,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE;KAC1D,CAAC;AACJ,CAAC;AAGD,SAAS,eAAe,CAAC,MAAsB;IAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC7B,OAAO,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;IAC9B,CAAC;IACD,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW;QACrC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC;QAC3B,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,WAAW,CAAC;AACnC,CAAC;AAED,MAAM,QAAQ,GAA8D;IAC1E,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM;IAC/B,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,sBAAsB;IACvD,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,MAAM,kCAAkC;CAChE,CAAC;AAEF,SAAS,iBAAiB,CAAC,MAAsB;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,OAAO,CAAC,MAAsB,EAAE,MAAc;IACrD,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,UAAU,MAAM,CAAC,MAAM,GAAG,CAAC;IAC1C,OAAO,4BAA4B,MAAM,CAAC,MAAM;MAC5C,KAAK,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM;MAC5E,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM;MAClC,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM;MAClC,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM;WAC7B,MAAM,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED,SAAS,UAAU,CACjB,MAAsB,EACtB,GAAY;IAEZ,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;QACzC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;AAC5D,CAAC;AAED,SAAS,QAAQ,CAAC,KAA6B;IAC7C,OAAO,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;AAC7D,CAAC;AAED,SAAS,WAAW,CAAC,GAAY;IAC/B,IACE,GAAG,CAAC,SAAS,KAAK,IAAI;QACtB,GAAG,CAAC,SAAS,KAAK,IAAI;QACtB,GAAG,CAAC,SAAS,KAAK,IAAI,EACtB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC;AACxE,CAAC;AAQD,KAAK,UAAU,WAAW,CACxB,OAAuB,EACvB,MAAsB,EACtB,MAAc;IAEd,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAU,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACzE,MAAM,IAAI,GAAiB,EAAE,KAAK,EAAE,IAAA,4BAAQ,EAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;IAC7E,MAAM,GAAG,GAAG,IAAA,2BAAO,EAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK;YACR,QAAQ,CAAC,MAAM,KAAK,IAAI;gBACtB,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBACzC,CAAC,CAAC,QAAQ,CAAC;IACjB,CAAC;IACD,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM;YACT,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC3E,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,OAAO,CAAI,KAAoB;IACtC,OAAO,KAAK,KAAK,SAAS;QACxB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE;QACpC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC9B,CAAC;AAED,KAAK,UAAU,eAAe,CAC5B,OAAuB,EACvB,MAAsB,EACtB,MAAc;IAEd,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CACpC,yBAAyB,MAAM,CAAC,MAAM,8BAA8B,MAAM,CAAC,IAAI,EAAE,CAClF,CAAC;IACF,OAAO,IAAA,4BAAQ,EAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,eAAe,GAEjB;IACF,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,WAAW;IACtC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,WAAW;IACvC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM;CACzB,CAAC;AAEF,SAAS,aAAa,CAAC,MAAsB;IAC3C,OAAO,CACL,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAC1E,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACnB,CAAC;AAGD,SAAS,YAAY,CAAC,IAAgB;IACpC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI;SACf,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,iBAAiB,CAAC;SAC7C,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/C,OAAO;QACL,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACvE,KAAK;KACN,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,OAAuB,EACvB,MAAsB,EACtB,MAAc,EACd,QAA4B;IAE5B,MAAM,aAAa,GACjB,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,cAAc,CAAC;IACvE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QACjE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CACpC,UAAU,aAAa,CAAC,MAAM,CAAC,4CAA4C,MAAM,CAAC,IAAI;cAC5E,MAAM,CAAC,MAAM,oDAAoD,cAAc,GAAG,CAAC,EAAE,CAChG,CAAC;IACF,OAAO,IAAA,0BAAM,EAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AACxC,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,OAAuB,EACvB,MAAsB,EACtB,MAAc;IAEd,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CACpC,sCAAsC,iBAAiB,CAAC,MAAM,CAAC;sCAC7B,MAAM,CAAC,IAAI;cACnC,MAAM,CAAC,MAAM,iDAAiD,WAAW,EAAE,CACtF,CAAC;IACF,OAAO,IAAA,0BAAM,EAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACpD,CAAC;AAGD,SAAS,aAAa,CAAC,KAAiB;IACtC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1C,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACxC,OAAO,CACL,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC,GAAG,eAAe;QACjE,GAAG,CAAC,WAAW,EAAE;QACjB,KAAK,CAAC,WAAW,EAAE;QACnB,CAAC,CACF,CAAC;AACJ,CAAC;AAiBD,SAAS,MAAM,CAAC,KAAiB;IAC/B,MAAM,KAAK,GAAG,IAAA,2BAAO,EAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3C,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;QACpD,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC;AACzB,CAAC;AAED,MAAM,WAAW,GAAmC;IAClD,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CACrB,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM;QAC9B,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;YAC9C,CAAC,IAAA,2BAAO,EAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,IAAI,cAAc;YAC/D,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,kBAAkB,CAAC;IAC5C,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE,CAC3B,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC;QACrB,IAAA,2BAAO,EAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;QAClC,IAAA,2BAAO,EAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,KAAK,CAAC,IAAI;IAChD,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAA,2BAAO,EAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAA,2BAAO,EAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7C,OAAO,CACL,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;YAC3C,MAAM,GAAG,CAAC;YACV,QAAQ,IAAI,oBAAoB,GAAG,MAAM;YACzC,MAAM,KAAK,SAAS;YACpB,MAAM,CAAC,GAAG,IAAI,gBAAgB,CAC/B,CAAC;IACJ,CAAC;IACD,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE;QACrB,MAAM,KAAK,GAAG,IAAA,2BAAO,EAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,CACL,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW;YACtC,KAAK,KAAK,SAAS;YACnB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClB,sBAAsB,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,QAAQ,CAAC;YACnD,aAAa,CAAC,KAAK,CAAC,IAAI,oBAAoB,CAC7C,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CACjB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO;QAClC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;QACxC,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;CACjD,CAAC;AAEF,SAAS,QAAQ,CAAC,KAAiB;IACjC,OAAQ,MAAM,CAAC,IAAI,CAAC,WAAW,CAAmB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAClE,WAAW,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAC1B,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,aAAa,CACjC,OAAuB,EACvB,MAAsB,EACtB,MAAc,EACd,IAAwB,EACxB,KAAkB;IAElB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACxD,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAChE,MAAM,UAAU,GAAG,MAAM,iBAAiB,CACxC,OAAO,EACP,MAAM,EACN,MAAM,EACN,IAAA,2BAAO,EAAC,QAAQ,CAAC,CAClB,CAAC;IACF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAkB,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1E,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;IAClC,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAC1B,CAAC;IACD,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5D,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/implementations/database/external-declarations.d.ts

@@ -0,0 +1,9 @@
+import type { CatalogColumn } from "./external-catalog";
+import { type SqlType } from "./types";
+export interface AcceptedDeclaration {
+    declared: string;
+    kind: SqlType;
+    lossy?: string;
+}
+export declare function AcceptedDeclarations(column: CatalogColumn): AcceptedDeclaration[];
+export declare function UnsupportedReason(column: CatalogColumn): string;

package/dist/implementations/database/external-declarations.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AcceptedDeclarations = AcceptedDeclarations;
+exports.UnsupportedReason = UnsupportedReason;
+const external_types_1 = require("./external-types");
+const types_1 = require("./types");
+const PROPOSED_KIND = {
+    text: types_1.TEXT,
+    citext: types_1.TEXT,
+    bpchar: types_1.TEXT,
+    uuid: types_1.TEXT,
+    enum: types_1.TEXT,
+    rendered: types_1.TEXT,
+    int: types_1.FLOAT,
+    int8: types_1.FLOAT,
+    numeric: types_1.FLOAT,
+    float4: types_1.FLOAT,
+    float8: types_1.FLOAT,
+    bool: types_1.BOOL,
+    timestamptz: types_1.TIMESTAMP,
+    timestamp: types_1.TIMESTAMP,
+    date: types_1.TIMESTAMP,
+    jsonb: types_1.OPAQUE,
+    json: types_1.OPAQUE,
+};
+const SCALAR_KINDS = [types_1.TEXT, types_1.FLOAT, types_1.BOOL, types_1.TIMESTAMP, types_1.OPAQUE];
+const FIELD_TOKENS = {
+    text: "string",
+    float: "number",
+    bool: "boolean",
+    timestamp: "date",
+    json: "object",
+};
+const ARRAY_SUFFIX = "[]";
+function FieldToken(kind) {
+    return kind.kind === "array"
+        ? `${FieldToken(kind.elem)}${ARRAY_SUFFIX}`
+        : FIELD_TOKENS[kind.kind];
+}
+function ProposedFirst(kinds, proposed) {
+    return [
+        ...kinds.filter((kind) => kind === proposed),
+        ...kinds.filter((kind) => kind !== proposed),
+    ];
+}
+function CandidateKinds(column) {
+    const family = (0, external_types_1.FamilyOf)(column);
+    if (family === "array") {
+        const element = (0, external_types_1.ElementFamily)(column);
+        const proposed = element && element !== "array" ? PROPOSED_KIND[element] : undefined;
+        return ProposedFirst([...SCALAR_KINDS], proposed ?? types_1.TEXT).map(types_1.ArrayOf);
+    }
+    return family ? ProposedFirst([...SCALAR_KINDS], PROPOSED_KIND[family]) : [];
+}
+function AcceptedDeclarations(column) {
+    const family = (0, external_types_1.FamilyOf)(column);
+    return CandidateKinds(column).flatMap((kind) => {
+        const reading = (0, external_types_1.ReadingOf)(kind, family, column);
+        return reading
+            ? [{ declared: FieldToken(kind), kind, lossy: reading.lossy }]
+            : [];
+    });
+}
+function UnsupportedReason(column) {
+    return `no field type reads a ${column.native} column`;
+}
+//# sourceMappingURL=external-declarations.js.map

package/dist/implementations/database/external-declarations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"external-declarations.js","sourceRoot":"","sources":["../../../src/implementations/database/external-declarations.ts"],"names":[],"mappings":";;AAsFA,oDAUC;AAGD,8CAEC;AApGD,qDAK0B;AAC1B,mCAQiB;AAGjB,MAAM,aAAa,GAAoD;IACrE,IAAI,EAAE,YAAI;IACV,MAAM,EAAE,YAAI;IACZ,MAAM,EAAE,YAAI;IACZ,IAAI,EAAE,YAAI;IACV,IAAI,EAAE,YAAI;IACV,QAAQ,EAAE,YAAI;IACd,GAAG,EAAE,aAAK;IACV,IAAI,EAAE,aAAK;IACX,OAAO,EAAE,aAAK;IACd,MAAM,EAAE,aAAK;IACb,MAAM,EAAE,aAAK;IACb,IAAI,EAAE,YAAI;IACV,WAAW,EAAE,iBAAS;IACtB,SAAS,EAAE,iBAAS;IACpB,IAAI,EAAE,iBAAS;IACf,KAAK,EAAE,cAAM;IACb,IAAI,EAAE,cAAM;CACb,CAAC;AAEF,MAAM,YAAY,GAAuB,CAAC,YAAI,EAAE,aAAK,EAAE,YAAI,EAAE,iBAAS,EAAE,cAAM,CAAC,CAAC;AAEhF,MAAM,YAAY,GAAsD;IACtE,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,QAAQ;IACf,IAAI,EAAE,SAAS;IACf,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,QAAQ;CACf,CAAC;AAEF,MAAM,YAAY,GAAG,IAAI,CAAC;AAS1B,SAAS,UAAU,CAAC,IAAa;IAC/B,OAAO,IAAI,CAAC,IAAI,KAAK,OAAO;QAC1B,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,YAAY,EAAE;QAC3C,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,aAAa,CAAC,KAAgB,EAAE,QAAiB;IACxD,OAAO;QACL,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,QAAQ,CAAC;QAC5C,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,QAAQ,CAAC;KAC7C,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,MAAqB;IAC3C,MAAM,MAAM,GAAG,IAAA,yBAAQ,EAAC,MAAM,CAAC,CAAC;IAChC,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAA,8BAAa,EAAC,MAAM,CAAC,CAAC;QACtC,MAAM,QAAQ,GACZ,OAAO,IAAI,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,OAAO,aAAa,CAAC,CAAC,GAAG,YAAY,CAAC,EAAE,QAAQ,IAAI,YAAI,CAAC,CAAC,GAAG,CAAC,eAAO,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,GAAG,YAAY,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/E,CAAC;AAOD,SAAgB,oBAAoB,CAClC,MAAqB;IAErB,MAAM,MAAM,GAAG,IAAA,yBAAQ,EAAC,MAAM,CAAC,CAAC;IAChC,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7C,MAAM,OAAO,GAAG,IAAA,0BAAS,EAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAChD,OAAO,OAAO;YACZ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;YAC9D,CAAC,CAAC,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;AACL,CAAC;AAGD,SAAgB,iBAAiB,CAAC,MAAqB;IACrD,OAAO,yBAAyB,MAAM,CAAC,MAAM,SAAS,CAAC;AACzD,CAAC"}

package/dist/implementations/database/external-discovery.d.ts

@@ -0,0 +1,39 @@
+import type { CatalogInfo, EstimateSource, Reference, RelationDescription, RelationKey, RelationSummary } from "@antelopejs/interface-database-catalog";
+import { type CatalogColumn, type CatalogIndex } from "./external-catalog";
+export interface RelationRow {
+    oid: number;
+    schema: string;
+    name: string;
+    kind: string;
+    readable: boolean;
+    someColumns: boolean;
+    insert: boolean;
+    update: boolean;
+    delete: boolean;
+    analyzed: boolean;
+    statistics: number | null;
+    liveTuples: number | null;
+    comment: string | null;
+}
+interface ReferenceRow {
+    name: string;
+    fromRelation: string;
+    fromColumns: string[];
+    toRelation: string;
+    toColumns: string[];
+}
+export declare function RelationName(row: RelationRow): string;
+export declare function ReadInfo(): Promise<CatalogInfo>;
+export declare function ReadRelationRows(schemas?: string[]): Promise<RelationRow[]>;
+export declare function ReadNamedRelationRows(relations: string[]): Promise<RelationRow[]>;
+interface Estimate {
+    estimatedRows: number | null;
+    estimate: EstimateSource | null;
+}
+export declare function EstimateOf(row: RelationRow): Promise<Estimate>;
+export declare function KeyFrom(indexes: CatalogIndex[], columns: CatalogColumn[]): RelationKey | null;
+export declare function Summarize(row: RelationRow): Promise<RelationSummary>;
+export declare function ReferenceOf(row: ReferenceRow): Reference;
+export declare function ReadReferences(oid: number): Promise<ReferenceRow[]>;
+export declare function DescribeRow(row: RelationRow): Promise<RelationDescription>;
+export {};

package/dist/implementations/database/external-discovery.js

@@ -0,0 +1,219 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationName = RelationName;
+exports.ReadInfo = ReadInfo;
+exports.ReadRelationRows = ReadRelationRows;
+exports.ReadNamedRelationRows = ReadNamedRelationRows;
+exports.EstimateOf = EstimateOf;
+exports.KeyFrom = KeyFrom;
+exports.Summarize = Summarize;
+exports.ReferenceOf = ReferenceOf;
+exports.ReadReferences = ReadReferences;
+exports.DescribeRow = DescribeRow;
+const connection_1 = require("../../connection");
+const external_catalog_1 = require("./external-catalog");
+const external_declarations_1 = require("./external-declarations");
+const external_types_1 = require("./external-types");
+const identifier_1 = require("./identifier");
+const ENGINE = "postgresql";
+const SYSTEM_SCHEMAS = "('pg_catalog', 'information_schema')";
+const RELATIONS_SQL = `
+  WITH leaves AS (
+    SELECT c.oid, coalesce(sum(CASE WHEN l.reltuples >= 0 THEN l.reltuples END), 0) AS statistics,
+      coalesce(sum(s.n_live_tup), 0) AS live, bool_and(l.reltuples >= 0) AS analyzed
+    FROM pg_class c
+    JOIN LATERAL pg_partition_tree(c.oid) t ON t.isleaf
+    JOIN pg_class l ON l.oid = t.relid
+    LEFT JOIN pg_stat_all_tables s ON s.relid = l.oid
+    WHERE c.relkind = 'p'
+    GROUP BY c.oid
+  )
+  SELECT c.oid, n.nspname AS schema, c.relname AS name, c.relkind AS kind,
+    has_table_privilege(c.oid, 'SELECT') AS readable,
+    has_any_column_privilege(c.oid, 'SELECT') AS "someColumns",
+    has_table_privilege(c.oid, 'INSERT') AS insert,
+    has_table_privilege(c.oid, 'UPDATE') AS update,
+    has_table_privilege(c.oid, 'DELETE') AS delete,
+    coalesce(p.analyzed, c.reltuples >= 0) AS analyzed,
+    coalesce(p.statistics, CASE WHEN c.reltuples >= 0 THEN c.reltuples END)::float8 AS statistics,
+    coalesce(p.live, s.n_live_tup)::float8 AS "liveTuples",
+    obj_description(c.oid, 'pg_class') AS comment
+  FROM pg_class c
+  JOIN pg_namespace n ON n.oid = c.relnamespace
+  LEFT JOIN pg_stat_all_tables s ON s.relid = c.oid
+  LEFT JOIN leaves p ON p.oid = c.oid
+  WHERE c.relkind IN ${external_catalog_1.RELATION_KINDS} AND NOT c.relispartition
+    AND n.nspname NOT IN ${SYSTEM_SCHEMAS}
+    AND n.nspname NOT LIKE 'pg\\_%'
+    AND has_schema_privilege(n.oid, 'USAGE')
+    AND ($1::text[] IS NULL OR n.nspname = ANY($1::text[]))
+  ORDER BY n.nspname, c.relname`;
+const NAMED_RELATIONS_SQL = RELATIONS_SQL.replace("AND ($1::text[] IS NULL OR n.nspname = ANY($1::text[]))", "AND (n.nspname || '.' || c.relname) = ANY($1::text[])");
+const COLUMN_LIST = (relation, keys) => `ARRAY(
+      SELECT a.attname::text FROM unnest(con.${keys}) WITH ORDINALITY k(n, o)
+      JOIN pg_attribute a ON a.attrelid = con.${relation} AND a.attnum = k.n
+      ORDER BY k.o
+    )`;
+const REFERENCES_SQL = `
+  SELECT con.conname AS name,
+    fn.nspname || '.' || fc.relname AS "fromRelation", ${COLUMN_LIST("conrelid", "conkey")} AS "fromColumns",
+    tn.nspname || '.' || tc.relname AS "toRelation", ${COLUMN_LIST("confrelid", "confkey")} AS "toColumns"
+  FROM pg_constraint con
+  JOIN pg_class fc ON fc.oid = con.conrelid
+  JOIN pg_namespace fn ON fn.oid = fc.relnamespace
+  JOIN pg_class tc ON tc.oid = con.confrelid
+  JOIN pg_namespace tn ON tn.oid = tc.relnamespace
+  WHERE con.contype = 'f' AND con.conparentid = 0 AND (con.conrelid = $1 OR con.confrelid = $1)
+  ORDER BY con.conname`;
+const INFO_SQL = `
+  SELECT current_setting('server_version') AS version, current_database() AS database,
+    current_user AS role`;
+const KINDS = {
+    r: "table",
+    p: "partitioned",
+    v: "view",
+    m: "materialized",
+    f: "foreign",
+};
+const PARTIAL_GRANTS = "SELECT is granted on some of its columns only";
+const NOT_READABLE = "the connected role cannot SELECT from it";
+function RelationName(row) {
+    return `${row.schema}.${row.name}`;
+}
+async function ReadInfo() {
+    const [row] = (await (0, connection_1.Query)(INFO_SQL)).rows;
+    return { engine: ENGINE, ...row };
+}
+async function ReadRelationRows(schemas) {
+    return (await (0, connection_1.Query)(RELATIONS_SQL, [schemas ?? null])).rows;
+}
+async function ReadNamedRelationRows(relations) {
+    return (await (0, connection_1.Query)(NAMED_RELATIONS_SQL, [relations])).rows;
+}
+async function PlannedRows(row) {
+    try {
+        const sql = `EXPLAIN (FORMAT JSON) SELECT * FROM ${(0, identifier_1.QualifiedName)(row.schema, row.name)}`;
+        const [plan] = (await (0, connection_1.Query)(sql)).rows;
+        return plan["QUERY PLAN"][0].Plan["Plan Rows"];
+    }
+    catch {
+        return null;
+    }
+}
+async function EstimateOf(row) {
+    if (row.analyzed && row.statistics !== null) {
+        return { estimatedRows: row.statistics, estimate: "statistics" };
+    }
+    if (row.liveTuples !== null) {
+        return { estimatedRows: row.liveTuples, estimate: "live-tuples" };
+    }
+    if (!row.readable) {
+        return { estimatedRows: null, estimate: null };
+    }
+    const planned = await PlannedRows(row);
+    return planned === null
+        ? { estimatedRows: null, estimate: null }
+        : { estimatedRows: planned, estimate: "plan" };
+}
+function UnmappableReason(row) {
+    if (row.readable) {
+        return undefined;
+    }
+    return row.someColumns ? PARTIAL_GRANTS : NOT_READABLE;
+}
+function KeyFrom(indexes, columns) {
+    const key = (0, external_catalog_1.KeyOf)(indexes);
+    const byName = new Map(columns.map((column) => [column.name, column]));
+    if (!key || !(0, external_types_1.DescribeKeyColumns)(key.columns, byName)) {
+        return null;
+    }
+    return { columns: key.columns, source: key.primary ? "primary" : "unique" };
+}
+async function SummaryOf(row, key) {
+    return {
+        schema: row.schema,
+        name: row.name,
+        kind: KINDS[row.kind],
+        ...(await EstimateOf(row)),
+        key,
+        unmappable: UnmappableReason(row),
+        writes: { insert: row.insert, update: row.update, delete: row.delete },
+        comment: row.comment,
+    };
+}
+async function Summarize(row) {
+    const [columns, indexes] = await Promise.all([
+        (0, external_catalog_1.ReadColumns)(row.oid),
+        (0, external_catalog_1.ReadIndexes)(row.oid),
+    ]);
+    return SummaryOf(row, KeyFrom(indexes, columns));
+}
+function ReadOnlyOf(column, path) {
+    const [proposed] = (0, external_declarations_1.AcceptedDeclarations)(column);
+    if (!proposed) {
+        return undefined;
+    }
+    const descriptor = (0, external_types_1.Describe)(column.name, proposed.kind, column, path);
+    return (0, external_types_1.IsReadOnly)(descriptor) ? (0, external_types_1.ReadOnlyReason)(descriptor) : undefined;
+}
+const IDENTITIES = {
+    a: "always",
+    d: "by default",
+};
+function DescribeColumn(column, relation) {
+    const accepts = (0, external_declarations_1.AcceptedDeclarations)(column).map(({ declared, lossy }) => lossy ? { declared, lossy } : { declared });
+    const described = {
+        name: column.name,
+        native: column.native,
+        nullable: !column.notNull,
+        hasDefault: column.hasDefault,
+        generated: column.generated,
+        identity: IDENTITIES[column.identity] ?? null,
+        accepts,
+        comment: column.comment,
+    };
+    if (column.enumLabels) {
+        described.enumLabels = column.enumLabels;
+    }
+    if (accepts.length === 0) {
+        described.unsupported = (0, external_declarations_1.UnsupportedReason)(column);
+    }
+    const readOnly = ReadOnlyOf(column, `${relation}.${column.name}`);
+    if (readOnly) {
+        described.readOnly = readOnly;
+    }
+    return described;
+}
+function IndexOf(index) {
+    return { name: index.name, columns: index.columns, unique: index.unique };
+}
+function ReferenceOf(row) {
+    return {
+        name: row.name,
+        from: { relation: row.fromRelation, columns: row.fromColumns },
+        to: { relation: row.toRelation, columns: row.toColumns },
+    };
+}
+async function ReadReferences(oid) {
+    return (await (0, connection_1.Query)(REFERENCES_SQL, [oid])).rows;
+}
+async function DescribeRow(row) {
+    const relation = RelationName(row);
+    const [columns, indexes, references] = await Promise.all([
+        (0, external_catalog_1.ReadColumns)(row.oid),
+        (0, external_catalog_1.ReadIndexes)(row.oid),
+        ReadReferences(row.oid),
+    ]);
+    return {
+        ...(await SummaryOf(row, KeyFrom(indexes, columns))),
+        columns: columns.map((column) => DescribeColumn(column, relation)),
+        indexes: indexes.filter((index) => index.columns.length > 0).map(IndexOf),
+        references: references
+            .filter((reference) => reference.fromRelation === relation)
+            .map(ReferenceOf),
+        referencedBy: references
+            .filter((reference) => reference.toRelation === relation)
+            .map(ReferenceOf),
+    };
+}
+//# sourceMappingURL=external-discovery.js.map

package/dist/implementations/database/external-discovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"external-discovery.js","sourceRoot":"","sources":["../../../src/implementations/database/external-discovery.ts"],"names":[],"mappings":";;AA2JA,oCAEC;AAED,4BAGC;AAED,4CAIC;AAED,sDAIC;AAsBD,gCAcC;AAUD,0BAUC;AAkBD,8BAMC;AAkDD,kCAMC;AAED,wCAEC;AAED,kCAoBC;AApUD,iDAAyC;AACzC,yDAO4B;AAC5B,mEAGiC;AACjC,qDAK0B;AAC1B,6CAA6C;AA6C7C,MAAM,MAAM,GAAG,YAAY,CAAC;AAE5B,MAAM,cAAc,GAAG,sCAAsC,CAAC;AAM9D,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;uBAyBC,iCAAc;2BACV,cAAc;;;;gCAIT,CAAC;AAEjC,MAAM,mBAAmB,GAAG,aAAa,CAAC,OAAO,CAC/C,yDAAyD,EACzD,uDAAuD,CACxD,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,IAAY,EAAE,EAAE,CAAC;+CACT,IAAI;gDACH,QAAQ;;MAElD,CAAC;AAGP,MAAM,cAAc,GAAG;;yDAEkC,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC;uDACnC,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC;;;;;;;uBAOnE,CAAC;AAExB,MAAM,QAAQ,GAAG;;yBAEQ,CAAC;AAE1B,MAAM,KAAK,GAAiC;IAC1C,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,aAAa;IAChB,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,SAAS;CACb,CAAC;AAEF,MAAM,cAAc,GAAG,+CAA+C,CAAC;AACvE,MAAM,YAAY,GAAG,0CAA0C,CAAC;AAEhE,SAAgB,YAAY,CAAC,GAAgB;IAC3C,OAAO,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;AACrC,CAAC;AAEM,KAAK,UAAU,QAAQ;IAC5B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,IAAA,kBAAK,EAAU,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IACpD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC;AACpC,CAAC;AAEM,KAAK,UAAU,gBAAgB,CACpC,OAAkB;IAElB,OAAO,CAAC,MAAM,IAAA,kBAAK,EAAc,aAAa,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3E,CAAC;AAEM,KAAK,UAAU,qBAAqB,CACzC,SAAmB;IAEnB,OAAO,CAAC,MAAM,IAAA,kBAAK,EAAc,mBAAmB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3E,CAAC;AAGD,KAAK,UAAU,WAAW,CAAC,GAAgB;IACzC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,uCAAuC,IAAA,0BAAa,EAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACzF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,IAAA,kBAAK,EAAU,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAWM,KAAK,UAAU,UAAU,CAAC,GAAgB;IAC/C,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,EAAE,aAAa,EAAE,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;IACnE,CAAC;IACD,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC5B,OAAO,EAAE,aAAa,EAAE,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IACpE,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAClB,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjD,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO,OAAO,KAAK,IAAI;QACrB,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;QACzC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AACnD,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAgB;IACxC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC;AACzD,CAAC;AAGD,SAAgB,OAAO,CACrB,OAAuB,EACvB,OAAwB;IAExB,MAAM,GAAG,GAAG,IAAA,wBAAK,EAAC,OAAO,CAAC,CAAC;IAC3B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACvE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAA,mCAAkB,EAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC9E,CAAC;AAED,KAAK,UAAU,SAAS,CACtB,GAAgB,EAChB,GAAuB;IAEvB,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC;QAC1B,GAAG;QACH,UAAU,EAAE,gBAAgB,CAAC,GAAG,CAAC;QACjC,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE;QACtE,OAAO,EAAE,GAAG,CAAC,OAAO;KACrB,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,SAAS,CAAC,GAAgB;IAC9C,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC3C,IAAA,8BAAW,EAAC,GAAG,CAAC,GAAG,CAAC;QACpB,IAAA,8BAAW,EAAC,GAAG,CAAC,GAAG,CAAC;KACrB,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,MAAqB,EAAE,IAAY;IACrD,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAA,4CAAoB,EAAC,MAAM,CAAC,CAAC;IAChD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,UAAU,GAAG,IAAA,yBAAQ,EAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACtE,OAAO,IAAA,2BAAU,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAA,+BAAc,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,GAAkD;IAChE,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,YAAY;CAChB,CAAC;AAEF,SAAS,cAAc,CACrB,MAAqB,EACrB,QAAgB;IAEhB,MAAM,OAAO,GAAG,IAAA,4CAAoB,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,CACvE,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAC3C,CAAC;IACF,MAAM,SAAS,GAAsB;QACnC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,QAAQ,EAAE,CAAC,MAAM,CAAC,OAAO;QACzB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI;QAC7C,OAAO;QACP,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAC;IACF,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACtB,SAAS,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IAC3C,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,SAAS,CAAC,WAAW,GAAG,IAAA,yCAAiB,EAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAClE,IAAI,QAAQ,EAAE,CAAC;QACb,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAChC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO,CAAC,KAAmB;IAClC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;AAC5E,CAAC;AAED,SAAgB,WAAW,CAAC,GAAiB;IAC3C,OAAO;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,GAAG,CAAC,WAAW,EAAE;QAC9D,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,SAAS,EAAE;KACzD,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,cAAc,CAAC,GAAW;IAC9C,OAAO,CAAC,MAAM,IAAA,kBAAK,EAAe,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACjE,CAAC;AAEM,KAAK,UAAU,WAAW,CAC/B,GAAgB;IAEhB,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACvD,IAAA,8BAAW,EAAC,GAAG,CAAC,GAAG,CAAC;QACpB,IAAA,8BAAW,EAAC,GAAG,CAAC,GAAG,CAAC;QACpB,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;KACxB,CAAC,CAAC;IACH,OAAO;QACL,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QACpD,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QACzE,UAAU,EAAE,UAAU;aACnB,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,KAAK,QAAQ,CAAC;aAC1D,GAAG,CAAC,WAAW,CAAC;QACnB,YAAY,EAAE,UAAU;aACrB,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,KAAK,QAAQ,CAAC;aACxD,GAAG,CAAC,WAAW,CAAC;KACpB,CAAC;AACJ,CAAC"}

package/dist/implementations/database/external-errors.d.ts

@@ -0,0 +1,20 @@
+import type { ExternalRelation } from "./fields";
+export type ExternalWriteErrorKind = "invalid" | "missing" | "duplicate" | "reference" | "referenced" | "check" | "forbidden";
+export declare class ExternalWriteError extends Error {
+    readonly kind: ExternalWriteErrorKind;
+    readonly fields: string[];
+    readonly constraint?: string;
+    readonly code?: string;
+    readonly detail?: string;
+    constructor(message: string, facts: ExternalWriteFacts);
+}
+interface ExternalWriteFacts {
+    kind: ExternalWriteErrorKind;
+    fields?: string[];
+    constraint?: string;
+    code?: string;
+    detail?: string;
+}
+export declare function ExternalWriteFailure(err: unknown, external: ExternalRelation): unknown;
+export declare function InvalidValues(failures: string[]): ExternalWriteError;
+export {};