@antelopejs/postgres 0.0.1-stage → 0.2.1

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExternalWriteRefusal = ExternalWriteRefusal;
+exports.ExternalFeedRefusal = ExternalFeedRefusal;
+exports.ExternalInstanceRefusal = ExternalInstanceRefusal;
+exports.KeylessRefusal = KeylessRefusal;
+const identifier_1 = require("./identifier");
+function Named(external) {
+    return (0, identifier_1.QualifiedName)(external.schema, external.table);
+}
+function ExternalWriteRefusal(external, stage) {
+    return new Error(`The '${stage}' stage is not supported on ${Named(external)}, an external relation: its contract tells a missing field from a NULL one, which a column cannot`);
+}
+function ExternalFeedRefusal(external) {
+    return new Error(`changes() needs the adapter's change log, which ${Named(external)} does not have: it is an external relation, and the adapter installs nothing on it`);
+}
+function ExternalInstanceRefusal(stage) {
+    return new Error(`The '${stage}' stage manages instances, and an external instance's relations have none: read them through the default instance`);
+}
+function KeylessRefusal(external) {
+    return new Error(`${Named(external)} has no primary key and no unique index over NOT NULL columns, so its rows have no _id and cannot be read by key: filter on a field, or getAll by a field name`);
+}
+//# sourceMappingURL=external-refusals.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"external-refusals.js","sourceRoot":"","sources":["../../../src/implementations/database/external-refusals.ts"],"names":[],"mappings":";;AAWA,oDAOC;AAGD,kDAIC;AAGD,0DAIC;AAGD,wCAIC;AAvCD,6CAA6C;AAG7C,SAAS,KAAK,CAAC,QAA0B;IACvC,OAAO,IAAA,0BAAa,EAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAMD,SAAgB,oBAAoB,CAClC,QAA0B,EAC1B,KAAa;IAEb,OAAO,IAAI,KAAK,CACd,QAAQ,KAAK,+BAA+B,KAAK,CAAC,QAAQ,CAAC,mGAAmG,CAC/J,CAAC;AACJ,CAAC;AAGD,SAAgB,mBAAmB,CAAC,QAA0B;IAC5D,OAAO,IAAI,KAAK,CACd,mDAAmD,KAAK,CAAC,QAAQ,CAAC,oFAAoF,CACvJ,CAAC;AACJ,CAAC;AAGD,SAAgB,uBAAuB,CAAC,KAAa;IACnD,OAAO,IAAI,KAAK,CACd,QAAQ,KAAK,mHAAmH,CACjI,CAAC;AACJ,CAAC;AAGD,SAAgB,cAAc,CAAC,QAA0B;IACvD,OAAO,IAAI,KAAK,CACd,GAAG,KAAK,CAAC,QAAQ,CAAC,gKAAgK,CACnL,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,2 @@
+import { type RowSample, type SampleRequest } from "@antelopejs/interface-database-catalog";
+export declare function SampleRelationRows(request: SampleRequest): Promise<RowSample>;

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

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SampleRelationRows = SampleRelationRows;
+const interface_database_catalog_1 = require("@antelopejs/interface-database-catalog");
+const external_catalog_1 = require("./external-catalog");
+const external_discovery_1 = require("./external-discovery");
+const external_measures_1 = require("./external-measures");
+const external_profile_1 = require("./external-profile");
+const external_sample_1 = require("./external-sample");
+const sql_1 = require("./sql");
+const BINARY_TYPES = ["bytea"];
+const COLUMN_ALIAS_PREFIX = "c";
+function SampledColumnOf(column) {
+    return {
+        name: column.name,
+        binary: BINARY_TYPES.includes(column.typname),
+    };
+}
+function CheckedLimit(limit) {
+    if (!Number.isInteger(limit) || limit < 1 || limit > interface_database_catalog_1.SAMPLE_ROWS_LIMIT) {
+        throw new Error(`A sample answers from 1 to ${interface_database_catalog_1.SAMPLE_ROWS_LIMIT} rows, not ${limit}`);
+    }
+    return limit;
+}
+function Chosen(columns, request) {
+    const unknown = (request.columns ?? []).filter((name) => !columns.some((column) => column.name === name));
+    if (unknown.length > 0) {
+        throw new Error(`Relation '${request.relation}' has no column ${unknown.join(", ")}`);
+    }
+    return columns
+        .filter((column) => !request.columns || request.columns.includes(column.name))
+        .map(SampledColumnOf);
+}
+function Expression(column, index) {
+    const value = `${external_sample_1.SOURCE_ALIAS}.${(0, sql_1.QuoteIdentifier)(column.name)}`;
+    const read = column.binary
+        ? `octet_length(${value})`
+        : `left(${value}::text, ${interface_database_catalog_1.SAMPLE_TEXT_LENGTH + 1})`;
+    return `${read} AS ${COLUMN_ALIAS_PREFIX}${index}`;
+}
+function Value(column, read) {
+    if (read === null) {
+        return null;
+    }
+    if (column.binary) {
+        return { bytes: Number(read) };
+    }
+    const text = String(read);
+    return {
+        text: text.slice(0, interface_database_catalog_1.SAMPLE_TEXT_LENGTH),
+        truncated: text.length > interface_database_catalog_1.SAMPLE_TEXT_LENGTH,
+    };
+}
+function Row(columns, row) {
+    return columns.map((column, index) => Value(column, row[`${COLUMN_ALIAS_PREFIX}${index}`] ?? null));
+}
+function FailureOf(measured) {
+    return measured.status === "timeout" ? "timeout" : measured.code;
+}
+async function SampleRelationRows(request) {
+    const limit = CheckedLimit(request.limit);
+    const row = await (0, external_profile_1.NamedRow)(request.relation);
+    const columns = Chosen(await (0, external_catalog_1.ReadColumns)(row.oid), request);
+    const { estimatedRows } = await (0, external_discovery_1.EstimateOf)(row);
+    const source = (0, external_sample_1.SourceFor)(row, estimatedRows);
+    const select = columns.map(Expression).join(", ");
+    const measured = await (0, external_measures_1.WithMeasures)((session) => session.measure(`SELECT ${select} FROM ${source.from} LIMIT $1`, [limit]));
+    if (measured.status !== "ok") {
+        throw new Error(`The sample of '${request.relation}' did not finish: ${FailureOf(measured)}`);
+    }
+    return {
+        relation: (0, external_discovery_1.RelationName)(row),
+        columns: columns.map((column) => column.name),
+        rows: measured.value.map((sampled) => Row(columns, sampled)),
+        sample: source.sample && {
+            ...source.sample,
+            rows: measured.value.length,
+        },
+    };
+}
+//# sourceMappingURL=external-rows.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"external-rows.js","sourceRoot":"","sources":["../../../src/implementations/database/external-rows.ts"],"names":[],"mappings":";;AAqGA,gDA6BC;AAlID,uFAQgD;AAEhD,yDAAqE;AACrE,6DAAgE;AAChE,2DAAmD;AACnD,yDAA8C;AAC9C,uDAA4D;AAC5D,+BAAwC;AAExC,MAAM,YAAY,GAAsB,CAAC,OAAO,CAAC,CAAC;AAClD,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAShC,SAAS,eAAe,CAAC,MAAqB;IAC5C,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;KAC9C,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,8CAAiB,EAAE,CAAC;QACvE,MAAM,IAAI,KAAK,CACb,8BAA8B,8CAAiB,cAAc,KAAK,EAAE,CACrE,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,MAAM,CACb,OAAwB,EACxB,OAAsB;IAEtB,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAC5C,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAC1D,CAAC;IACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,aAAa,OAAO,CAAC,QAAQ,mBAAmB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACrE,CAAC;IACJ,CAAC;IACD,OAAO,OAAO;SACX,MAAM,CACL,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CACtE;SACA,GAAG,CAAC,eAAe,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,UAAU,CAAC,MAAqB,EAAE,KAAa;IACtD,MAAM,KAAK,GAAG,GAAG,8BAAY,IAAI,IAAA,qBAAe,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IAChE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM;QACxB,CAAC,CAAC,gBAAgB,KAAK,GAAG;QAC1B,CAAC,CAAC,QAAQ,KAAK,WAAW,+CAAkB,GAAG,CAAC,GAAG,CAAC;IACtD,OAAO,GAAG,IAAI,OAAO,mBAAmB,GAAG,KAAK,EAAE,CAAC;AACrD,CAAC;AAED,SAAS,KAAK,CACZ,MAAqB,EACrB,IAA4B;IAE5B,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IACjC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,+CAAkB,CAAC;QACvC,SAAS,EAAE,IAAI,CAAC,MAAM,GAAG,+CAAkB;KAC5C,CAAC;AACJ,CAAC;AAED,SAAS,GAAG,CAAC,OAAwB,EAAE,GAAe;IACpD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CACnC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,mBAAmB,GAAG,KAAK,EAAE,CAAC,IAAI,IAAI,CAAC,CAC7D,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,QAAuC;IACxD,OAAO,QAAQ,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;AACnE,CAAC;AAMM,KAAK,UAAU,kBAAkB,CACtC,OAAsB;IAEtB,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,GAAG,GAAG,MAAM,IAAA,2BAAQ,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,IAAA,8BAAW,EAAC,GAAG,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5D,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAA,+BAAU,EAAC,GAAG,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,IAAA,2BAAS,EAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,MAAM,IAAA,gCAAY,EAAC,CAAC,OAAO,EAAE,EAAE,CAC9C,OAAO,CAAC,OAAO,CACb,UAAU,MAAM,SAAS,MAAM,CAAC,IAAI,WAAW,EAC/C,CAAC,KAAK,CAAC,CACR,CACF,CAAC;IACF,IAAI,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,kBAAkB,OAAO,CAAC,QAAQ,qBAAqB,SAAS,CAAC,QAAQ,CAAC,EAAE,CAC7E,CAAC;IACJ,CAAC;IACD,OAAO;QACL,QAAQ,EAAE,IAAA,iCAAY,EAAC,GAAG,CAAC;QAC3B,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;QAC7C,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5D,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI;YACvB,GAAG,MAAM,CAAC,MAAM;YAChB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM;SAC5B;KACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,9 @@
+import type { SampleInfo } from "@antelopejs/interface-database-catalog";
+import type { RelationRow } from "./external-discovery";
+export declare const SAMPLE_THRESHOLD_ROWS = 1000000;
+export declare const SOURCE_ALIAS = "r";
+export interface Source {
+    from: string;
+    sample: SampleInfo | null;
+}
+export declare function SourceFor(row: RelationRow, estimate: number | null, alias?: string): Source;

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOURCE_ALIAS = exports.SAMPLE_THRESHOLD_ROWS = void 0;
+exports.SourceFor = SourceFor;
+const identifier_1 = require("./identifier");
+exports.SAMPLE_THRESHOLD_ROWS = 1_000_000;
+const SAMPLE_TARGET_ROWS = 100_000;
+const SAMPLE_SEED = 42;
+const PERCENT = 100;
+exports.SOURCE_ALIAS = "r";
+const SAMPLED_KINDS = ["r", "p", "m"];
+function SourceFor(row, estimate, alias = exports.SOURCE_ALIAS) {
+    const table = `${(0, identifier_1.QualifiedName)(row.schema, row.name)} AS ${alias}`;
+    if (estimate === null || estimate <= exports.SAMPLE_THRESHOLD_ROWS) {
+        return { from: table, sample: null };
+    }
+    const percent = Math.min(PERCENT, (SAMPLE_TARGET_ROWS / estimate) * PERCENT);
+    if (SAMPLED_KINDS.includes(row.kind)) {
+        return {
+            from: `${table} TABLESAMPLE SYSTEM (${percent}) REPEATABLE (${SAMPLE_SEED})`,
+            sample: { percent, rows: 0 },
+        };
+    }
+    return {
+        from: `(SELECT * FROM ${(0, identifier_1.QualifiedName)(row.schema, row.name)} LIMIT ${SAMPLE_TARGET_ROWS}) AS ${alias}`,
+        sample: { percent, rows: 0 },
+    };
+}
+//# sourceMappingURL=external-sample.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"external-sample.js","sourceRoot":"","sources":["../../../src/implementations/database/external-sample.ts"],"names":[],"mappings":";;;AAuBA,8BAoBC;AAxCD,6CAA6C;AAGhC,QAAA,qBAAqB,GAAG,SAAS,CAAC;AAC/C,MAAM,kBAAkB,GAAG,OAAO,CAAC;AACnC,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,OAAO,GAAG,GAAG,CAAC;AAGP,QAAA,YAAY,GAAG,GAAG,CAAC;AAEhC,MAAM,aAAa,GAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AASzD,SAAgB,SAAS,CACvB,GAAgB,EAChB,QAAuB,EACvB,KAAK,GAAG,oBAAY;IAEpB,MAAM,KAAK,GAAG,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,EAAE,CAAC;IACnE,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,IAAI,6BAAqB,EAAE,CAAC;QAC3D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACvC,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,kBAAkB,GAAG,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC;IAC7E,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,OAAO;YACL,IAAI,EAAE,GAAG,KAAK,wBAAwB,OAAO,iBAAiB,WAAW,GAAG;YAC5E,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE;SAC7B,CAAC;IACJ,CAAC;IACD,OAAO;QACL,IAAI,EAAE,kBAAkB,IAAA,0BAAa,EAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,kBAAkB,QAAQ,KAAK,EAAE;QACtG,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE;KAC7B,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,3 @@
+import type { SchemaDefinition } from "@antelopejs/interface-database/schema";
+import type { SchemaShape } from "./fields";
+export declare function DescribeExternalSchema(schemaId: string, schema: SchemaDefinition, parsed: SchemaShape): Promise<SchemaShape>;

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

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DescribeExternalSchema = DescribeExternalSchema;
+const logger_1 = require("../../logger");
+const ddl_1 = require("./ddl");
+const utils_1 = require("./utils");
+const identifier_1 = require("./identifier");
+const external_catalog_1 = require("./external-catalog");
+const external_types_1 = require("./external-types");
+function PathOf(declared) {
+    return `${declared.schemaId}.${declared.tableId}`;
+}
+function NativeName(declared) {
+    return (0, identifier_1.QualifiedName)(declared.schemaId, declared.tableId);
+}
+function MissingRelation(declared) {
+    return new Error(`Table '${PathOf(declared)}' reads ${NativeName(declared)}, which the database does not have`);
+}
+function UnreadableRelation(declared) {
+    return new Error(`Table '${PathOf(declared)}' reads ${NativeName(declared)}, which the connected role cannot SELECT from`);
+}
+function MissingColumn(declared, field) {
+    return new Error(`Field '${PathOf(declared)}.${field}' reads column "${field}", which ${NativeName(declared)} does not have`);
+}
+function KeylessAlias(declared) {
+    return new Error(`Field '${PathOf(declared)}.${utils_1.ID_COLUMN}' aliases the relation's key, but ${NativeName(declared)} has no primary key and no unique index over NOT NULL columns; remove it`);
+}
+async function ReadDeclared(declared) {
+    const relation = await (0, external_catalog_1.ReadRelation)(declared.schemaId, declared.tableId);
+    if (!relation) {
+        throw MissingRelation(declared);
+    }
+    if (!relation.readable) {
+        throw UnreadableRelation(declared);
+    }
+    return relation;
+}
+function ColumnsByName(relation) {
+    return new Map(relation.columns.map((column) => [column.name, column]));
+}
+function WarnLossy(declared, descriptor) {
+    if (descriptor.lossy) {
+        logger_1.Logger.Warn(`Field '${PathOf(declared)}.${descriptor.field}' over ${descriptor.native} is read lossily: ${descriptor.lossy}`);
+    }
+}
+function DescribeFields(declared, columns) {
+    const fields = {};
+    for (const [name, spec] of Object.entries(declared.parsed.fields)) {
+        const column = columns.get(name);
+        if (!column) {
+            throw MissingColumn(declared, name);
+        }
+        const native = (0, external_types_1.Describe)(name, spec.type, column, `${PathOf(declared)}.${name}`);
+        WarnLossy(declared, native);
+        fields[name] = { ...spec, native };
+    }
+    return fields;
+}
+function ReportKeyless(declared) {
+    logger_1.Logger.Info(`${NativeName(declared)} has no primary key and no unique index over NOT NULL columns usable as one, so the rows of '${PathOf(declared)}' answer no ${utils_1.ID_COLUMN}: it can be queried, but not read by key`);
+}
+function KeyFor(declared, relation, columns) {
+    const key = (0, external_types_1.DescribeKeyColumns)(relation.key, columns);
+    if (key) {
+        return key;
+    }
+    if (Object.hasOwn(declared.table.fields ?? {}, utils_1.ID_COLUMN)) {
+        throw KeylessAlias(declared);
+    }
+    ReportKeyless(declared);
+    return undefined;
+}
+function IndexColumnNames(fields, key) {
+    return fields.flatMap((field) => (field === utils_1.ID_COLUMN ? key : [field]));
+}
+function Serves(served, wanted) {
+    return wanted.every((column, position) => served[position] === column);
+}
+function WarnUnservedIndexes(declared, relation) {
+    for (const [indexId, index] of Object.entries(declared.table.indexes ?? {})) {
+        const wanted = IndexColumnNames((0, ddl_1.IndexFields)(indexId, index), relation.key ?? []);
+        if (!relation.indexes.some((served) => Serves(served, wanted))) {
+            logger_1.Logger.Warn(`Index '${indexId}' on '${PathOf(declared)}' is declared, but no btree index of ${NativeName(declared)} leads with (${wanted.join(", ")}): queries by it stay correct, and may be slow`);
+        }
+    }
+}
+async function DescribeTable(declared) {
+    const relation = await ReadDeclared(declared);
+    const columns = ColumnsByName(relation);
+    const fields = DescribeFields(declared, columns);
+    const external = {
+        schema: declared.schemaId,
+        table: declared.tableId,
+        key: KeyFor(declared, relation, columns),
+    };
+    WarnUnservedIndexes(declared, relation);
+    return { fields, external };
+}
+async function DescribeExternalSchema(schemaId, schema, parsed) {
+    const shapes = {};
+    for (const [tableId, table] of Object.entries(schema)) {
+        shapes[tableId] = await DescribeTable({
+            schemaId,
+            tableId,
+            table,
+            parsed: parsed[tableId],
+        });
+    }
+    return shapes;
+}
+//# sourceMappingURL=external-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"external-schema.js","sourceRoot":"","sources":["../../../src/implementations/database/external-schema.ts"],"names":[],"mappings":";;AA0LA,wDAeC;AApMD,yCAAsC;AACtC,+BAAoC;AACpC,mCAAoC;AACpC,6CAA6C;AAC7C,yDAI4B;AAC5B,qDAI0B;AAgB1B,SAAS,MAAM,CAAC,QAAuB;IACrC,OAAO,GAAG,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;AACpD,CAAC;AAED,SAAS,UAAU,CAAC,QAAuB;IACzC,OAAO,IAAA,0BAAa,EAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,eAAe,CAAC,QAAuB;IAC9C,OAAO,IAAI,KAAK,CACd,UAAU,MAAM,CAAC,QAAQ,CAAC,WAAW,UAAU,CAAC,QAAQ,CAAC,oCAAoC,CAC9F,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAuB;IACjD,OAAO,IAAI,KAAK,CACd,UAAU,MAAM,CAAC,QAAQ,CAAC,WAAW,UAAU,CAAC,QAAQ,CAAC,+CAA+C,CACzG,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,QAAuB,EAAE,KAAa;IAC3D,OAAO,IAAI,KAAK,CACd,UAAU,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,mBAAmB,KAAK,YAAY,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAC5G,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,QAAuB;IAC3C,OAAO,IAAI,KAAK,CACd,UAAU,MAAM,CAAC,QAAQ,CAAC,IAAI,iBAAS,qCAAqC,UAAU,CAAC,QAAQ,CAAC,0EAA0E,CAC3K,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,QAAuB;IACjD,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAY,EAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACvB,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,aAAa,CAAC,QAAyB;IAC9C,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,SAAS,CAChB,QAAuB,EACvB,UAA4B;IAE5B,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,eAAM,CAAC,IAAI,CACT,UAAU,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,KAAK,UAAU,UAAU,CAAC,MAAM,qBAAqB,UAAU,CAAC,KAAK,EAAE,CACjH,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CACrB,QAAuB,EACvB,OAAmC;IAEnC,MAAM,MAAM,GAA8B,EAAE,CAAC;IAC7C,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAClE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,MAAM,GAAG,IAAA,yBAAQ,EACrB,IAAI,EACJ,IAAI,CAAC,IAAI,EACT,MAAM,EACN,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAC9B,CAAC;QACF,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,QAAuB;IAC5C,eAAM,CAAC,IAAI,CACT,GAAG,UAAU,CAAC,QAAQ,CAAC,gGAAgG,MAAM,CAAC,QAAQ,CAAC,eAAe,iBAAS,0CAA0C,CAC1M,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CACb,QAAuB,EACvB,QAAyB,EACzB,OAAmC;IAEnC,MAAM,GAAG,GAAG,IAAA,mCAAkB,EAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACtD,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,GAAG,CAAC;IACb,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,iBAAS,CAAC,EAAE,CAAC;QAC1D,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IACD,aAAa,CAAC,QAAQ,CAAC,CAAC;IACxB,OAAO,SAAS,CAAC;AACnB,CAAC;AAGD,SAAS,gBAAgB,CAAC,MAAgB,EAAE,GAAa;IACvD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,iBAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,MAAM,CAAC,MAAgB,EAAE,MAAgB;IAChD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,CAAC;AACzE,CAAC;AAOD,SAAS,mBAAmB,CAC1B,QAAuB,EACvB,QAAyB;IAEzB,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;QAC5E,MAAM,MAAM,GAAG,gBAAgB,CAC7B,IAAA,iBAAW,EAAC,OAAO,EAAE,KAAK,CAAC,EAC3B,QAAQ,CAAC,GAAG,IAAI,EAAE,CACnB,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;YAC/D,eAAM,CAAC,IAAI,CACT,UAAU,OAAO,SAAS,MAAM,CAAC,QAAQ,CAAC,wCAAwC,UAAU,CAAC,QAAQ,CAAC,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gDAAgD,CACxL,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,QAAuB;IAClD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAqB;QACjC,MAAM,EAAE,QAAQ,CAAC,QAAQ;QACzB,KAAK,EAAE,QAAQ,CAAC,OAAO;QACvB,GAAG,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC;KACzC,CAAC;IACF,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAQM,KAAK,UAAU,sBAAsB,CAC1C,QAAgB,EAChB,MAAwB,EACxB,MAAmB;IAEnB,MAAM,MAAM,GAAgB,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACtD,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,aAAa,CAAC;YACpC,QAAQ;YACR,OAAO;YACP,KAAK;YACL,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC;SACxB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,37 @@
+import type { CatalogColumn } from "./external-catalog";
+import { type SqlType } from "./types";
+export type NativeFamily = "text" | "citext" | "bpchar" | "uuid" | "enum" | "rendered" | "int" | "int8" | "numeric" | "float4" | "float8" | "bool" | "timestamptz" | "timestamp" | "date" | "jsonb" | "json" | "array";
+type ValueExpression = (column: string) => string;
+interface Reading {
+    value: ValueExpression;
+    lossy?: string;
+}
+export interface ColumnDescriptor {
+    field: string;
+    column: string;
+    kind: SqlType;
+    family: NativeFamily;
+    native: string;
+    castType: string;
+    value: ValueExpression;
+    lossy?: string;
+    notNull: boolean;
+    hasDefault: boolean;
+    generated: boolean;
+    identity: string;
+}
+export declare function FamilyOf(column: CatalogColumn): NativeFamily | undefined;
+export declare function ElementFamily(column: CatalogColumn): NativeFamily | undefined;
+export declare function ReadingOf(kind: SqlType, family: NativeFamily | undefined, column: CatalogColumn): Reading | undefined;
+export declare function Describe(field: string, kind: SqlType, column: CatalogColumn, path: string): ColumnDescriptor;
+export declare function DescribeKey(column: CatalogColumn): ColumnDescriptor | undefined;
+export declare function DescribeKeyColumns(key: string[] | undefined, columns: Map<string, CatalogColumn>): ColumnDescriptor[] | undefined;
+export type Conversion = (other: string, operator: string) => string;
+export declare function ConversionFor(descriptor: ColumnDescriptor): Conversion | undefined;
+export declare function IsNumeric(descriptor: ColumnDescriptor): boolean;
+type Written = (value: string, descriptor: ColumnDescriptor) => string;
+export declare function WritingFor(descriptor: ColumnDescriptor): Written | undefined;
+export declare function IsReadOnly(descriptor: ColumnDescriptor): boolean;
+export declare function ReadOnlyReason(descriptor: ColumnDescriptor): string;
+export declare function CheckFor(value: string, descriptor: ColumnDescriptor): string | undefined;
+export {};