@antelopejs/postgres 0.0.1-stage → 0.2.0

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

@@ -0,0 +1,32 @@
+import { type SqlType } from "./types";
+import type { DecodingContext } from "./context";
+import type { Compiled } from "./sql";
+import type { TableShape } from "./fields";
+import { type ColumnDescriptor } from "./external-types";
+export type ExternalWriteMode = "insert" | "update" | "replace";
+export interface ExternalAssignment {
+    field: string;
+    descriptor: ColumnDescriptor;
+    value: Compiled;
+    raw?: unknown;
+    toDefault?: boolean;
+}
+export interface ExternalPayload {
+    assignments: ExternalAssignment[];
+    asserted: Map<string, AssertedKey>;
+    keyFields: KeyFieldClaim[];
+}
+export interface KeyFieldClaim {
+    field: string;
+    descriptor: ColumnDescriptor;
+    type: SqlType;
+    raw: unknown;
+}
+export declare function KeyFieldValue(claim: KeyFieldClaim, context: DecodingContext): Compiled;
+export interface AssertedKey {
+    descriptor: ColumnDescriptor;
+    raw: string;
+    claimedBy: string;
+}
+export declare function KeyValue(asserted: AssertedKey, context: DecodingContext): Compiled;
+export declare function SplitExternalPayload(document: Record<string, unknown>, shape: TableShape, context: DecodingContext, mode: ExternalWriteMode): ExternalPayload;

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

@@ -0,0 +1,206 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyFieldValue = KeyFieldValue;
+exports.KeyValue = KeyValue;
+exports.SplitExternalPayload = SplitExternalPayload;
+const common_1 = require("@antelopejs/interface-database/common");
+const types_1 = require("./types");
+const value_1 = require("./value");
+const readings_1 = require("./readings");
+const identifier_1 = require("./identifier");
+const utils_1 = require("./utils");
+const external_types_1 = require("./external-types");
+function KeyFieldValue(claim, context) {
+    const decoded = (0, value_1.DecodeValue)(claim.raw, context);
+    return (0, readings_1.WrittenAs)(decoded, claim.type, `Field '${claim.field}'`);
+}
+function KeyValue(asserted, context) {
+    const decoded = (0, value_1.DecodeValue)(asserted.raw, context);
+    return (0, readings_1.WrittenAs)(decoded, types_1.TEXT, `Key column "${asserted.descriptor.column}"`);
+}
+function Decoded(walk, value) {
+    const decoded = (0, value_1.DecodeValue)(value, walk.context);
+    if (!decoded) {
+        throw new Error(`A payload value for '${walk.path}' could not be read`);
+    }
+    return decoded;
+}
+function IsConstant(value) {
+    return !(value instanceof common_1.StagedObject);
+}
+function Undeclared(walk, name) {
+    return new Error(`Payload key '${name}' is not a field of '${walk.path}': ${(0, identifier_1.QualifiedName)(walk.external.schema, walk.external.table)} is an external relation, and only its declared fields can be written`);
+}
+function ReadOnlyValue(walk, name, descriptor) {
+    return new Error(`Field '${walk.path}.${name}' cannot be given a value: it is ${(0, external_types_1.ReadOnlyReason)(descriptor)}, which the database fills`);
+}
+function KeyDisagreement(walk, column, first, second) {
+    return new Error(`Payload of '${walk.path}' claims two values for key column "${column}", through '${first}' and '${second}'`);
+}
+function MalformedId(walk, value) {
+    return new Error(`Payload key '_id' of '${walk.path}' is ${JSON.stringify(value)}, which is not a key of this relation: a key of ${walk.external.key?.length ?? 0} columns is spelled as a JSON array of their texts`);
+}
+function KeyColumn(walk, column) {
+    return walk.external.key?.find((part) => part.column === column);
+}
+function Claim(walk, claimed) {
+    const column = claimed.descriptor.column;
+    const existing = walk.payload.asserted.get(column);
+    if (existing && existing.raw !== claimed.raw) {
+        throw KeyDisagreement(walk, column, existing.claimedBy, claimed.claimedBy);
+    }
+    if (!existing) {
+        walk.payload.asserted.set(column, claimed);
+    }
+}
+function IdParts(walk, value) {
+    const width = walk.external.key?.length ?? 0;
+    if (width === 1) {
+        return [KeyText(value)];
+    }
+    const parsed = typeof value === "string" ? SafeParse(value) : undefined;
+    const parts = Array.isArray(parsed) ? parsed : [];
+    if (parts.length !== width ||
+        !parts.every((part) => typeof part === "string")) {
+        throw MalformedId(walk, value);
+    }
+    return parts;
+}
+function KeyText(value) {
+    return typeof value === "string" ? value : JSON.stringify(value);
+}
+function SafeParse(text) {
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return undefined;
+    }
+}
+function TakeId(walk, value) {
+    if (value === undefined || value === null) {
+        return;
+    }
+    const key = walk.external.key ?? [];
+    IdParts(walk, value).forEach((part, position) => Claim(walk, { descriptor: key[position], raw: part, claimedBy: utils_1.ID_COLUMN }));
+}
+function TakeKeyField(walk, name, descriptor, value) {
+    if (value === undefined || value === null) {
+        return;
+    }
+    walk.payload.keyFields.push({
+        field: name,
+        descriptor,
+        type: walk.shape.fields[name].type,
+        raw: value,
+    });
+}
+function Disagrees(claim, text) {
+    if (claim.type.kind === "text") {
+        return KeyText(claim.raw) !== text;
+    }
+    if (claim.type.kind === "float" && !claim.descriptor.lossy) {
+        return Number(text) !== claim.raw;
+    }
+    return false;
+}
+function SettleInsertKeys(walk) {
+    walk.payload.keyFields = walk.payload.keyFields.filter((claim) => {
+        const claimed = walk.payload.asserted.get(claim.descriptor.column);
+        if (!claimed) {
+            return true;
+        }
+        if (Disagrees(claim, claimed.raw)) {
+            throw KeyDisagreement(walk, claim.descriptor.column, claimed.claimedBy, claim.field);
+        }
+        return false;
+    });
+}
+function TakeReadOnly(walk, name, descriptor, value) {
+    if (walk.mode === "insert" && value !== undefined && value !== null) {
+        throw ReadOnlyValue(walk, name, descriptor);
+    }
+}
+function TakeField(walk, name, value) {
+    const spec = walk.shape.fields[name];
+    const descriptor = spec.native;
+    if (KeyColumn(walk, descriptor.column)) {
+        if ((0, external_types_1.IsReadOnly)(descriptor)) {
+            TakeReadOnly(walk, name, descriptor, value);
+        }
+        TakeKeyField(walk, name, descriptor, value);
+        return;
+    }
+    if ((0, external_types_1.IsReadOnly)(descriptor)) {
+        TakeReadOnly(walk, name, descriptor, value);
+        return;
+    }
+    if (value === undefined && walk.mode === "insert") {
+        return;
+    }
+    const written = value === undefined || value === null
+        ? Absent(spec.type)
+        : (0, readings_1.WrittenAs)(Decoded(walk, value), spec.type, `Field '${walk.path}.${name}'`);
+    walk.payload.assignments.push({
+        field: name,
+        descriptor,
+        value: written,
+        raw: value !== undefined && value !== null && IsConstant(value)
+            ? value
+            : undefined,
+    });
+}
+function Absent(type) {
+    return { sql: `(NULL::${(0, types_1.PhysicalType)(type)})`, type };
+}
+function TakeKey(walk, name, value) {
+    if (name === utils_1.ID_COLUMN) {
+        TakeId(walk, value);
+        return;
+    }
+    if (name === utils_1.INSTANCE_COLUMN) {
+        return;
+    }
+    if (!Object.hasOwn(walk.shape.fields, name)) {
+        throw Undeclared(walk, name);
+    }
+    TakeField(walk, name, value);
+}
+function ClearSilentFields(walk, document) {
+    for (const [name, spec] of Object.entries(walk.shape.fields)) {
+        const descriptor = spec.native;
+        const silent = !Object.hasOwn(document, name);
+        if (silent &&
+            !KeyColumn(walk, descriptor.column) &&
+            !(0, external_types_1.IsReadOnly)(descriptor)) {
+            walk.payload.assignments.push({
+                field: name,
+                descriptor,
+                value: Absent(spec.type),
+                toDefault: descriptor.hasDefault,
+            });
+        }
+    }
+}
+function SplitExternalPayload(document, shape, context, mode) {
+    const external = shape.external;
+    const walk = {
+        shape,
+        external,
+        path: `${external.schema}.${external.table}`,
+        mode,
+        context,
+        payload: { assignments: [], asserted: new Map(), keyFields: [] },
+    };
+    for (const [name, value] of Object.entries(document)) {
+        TakeKey(walk, name, value);
+    }
+    if (mode === "insert") {
+        SettleInsertKeys(walk);
+    }
+    if (mode === "replace") {
+        ClearSilentFields(walk, document);
+    }
+    return walk.payload;
+}
+//# sourceMappingURL=external-payload.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"external-payload.js","sourceRoot":"","sources":["../../../src/implementations/database/external-payload.ts"],"names":[],"mappings":";;AA+DA,sCAMC;AAaD,4BAMC;AA+QD,oDAyBC;AAhYD,kEAAqE;AAErE,mCAA2D;AAC3D,mCAAsC;AACtC,yCAAuC;AAGvC,6CAA6C;AAE7C,mCAAqD;AACrD,qDAI0B;AAiD1B,SAAgB,aAAa,CAC3B,KAAoB,EACpB,OAAwB;IAExB,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAa,CAAC;IAC5D,OAAO,IAAA,oBAAS,EAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;AAClE,CAAC;AAaD,SAAgB,QAAQ,CACtB,QAAqB,EACrB,OAAwB;IAExB,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAa,CAAC;IAC/D,OAAO,IAAA,oBAAS,EAAC,OAAO,EAAE,YAAI,EAAE,eAAe,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;AAChF,CAAC;AAWD,SAAS,OAAO,CAAC,IAAkB,EAAE,KAAc;IACjD,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,CAAC,IAAI,qBAAqB,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAGD,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,CAAC,CAAC,KAAK,YAAY,qBAAY,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,UAAU,CAAC,IAAkB,EAAE,IAAY;IAClD,OAAO,IAAI,KAAK,CACd,gBAAgB,IAAI,wBAAwB,IAAI,CAAC,IAAI,MAAM,IAAA,0BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,uEAAuE,CAC3L,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,IAAkB,EAClB,IAAY,EACZ,UAA4B;IAE5B,OAAO,IAAI,KAAK,CACd,UAAU,IAAI,CAAC,IAAI,IAAI,IAAI,oCAAoC,IAAA,+BAAc,EAAC,UAAU,CAAC,4BAA4B,CACtH,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CACtB,IAAkB,EAClB,MAAc,EACd,KAAa,EACb,MAAc;IAEd,OAAO,IAAI,KAAK,CACd,eAAe,IAAI,CAAC,IAAI,uCAAuC,MAAM,eAAe,KAAK,UAAU,MAAM,GAAG,CAC7G,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,IAAkB,EAAE,KAAc;IACrD,OAAO,IAAI,KAAK,CACd,yBAAyB,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,mDAAmD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,IAAI,CAAC,oDAAoD,CACrM,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAChB,IAAkB,EAClB,MAAc;IAEd,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,KAAK,CAAC,IAAkB,EAAE,OAAoB;IACrD,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC;IACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACnD,IAAI,QAAQ,IAAI,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;QAC7C,MAAM,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7E,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC;AAGD,SAAS,OAAO,CAAC,IAAkB,EAAE,KAAc;IACjD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,IAAI,CAAC,CAAC;IAC7C,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1B,CAAC;IACD,MAAM,MAAM,GACV,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAClD,IACE,KAAK,CAAC,MAAM,KAAK,KAAK;QACtB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAChD,CAAC;QACD,MAAM,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,KAAiB,CAAC;AAC3B,CAAC;AAGD,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,MAAM,CAAC,IAAkB,EAAE,KAAc;IAChD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC;IACpC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,CAC9C,KAAK,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,iBAAS,EAAE,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,IAAkB,EAClB,IAAY,EACZ,UAA4B,EAC5B,KAAc;IAEd,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;QAC1B,KAAK,EAAE,IAAI;QACX,UAAU;QACV,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI;QAClC,GAAG,EAAE,KAAK;KACX,CAAC,CAAC;AACL,CAAC;AAMD,SAAS,SAAS,CAAC,KAAoB,EAAE,IAAY;IACnD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC/B,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;IACrC,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QAC3D,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAOD,SAAS,gBAAgB,CAAC,IAAkB;IAC1C,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,eAAe,CACnB,IAAI,EACJ,KAAK,CAAC,UAAU,CAAC,MAAM,EACvB,OAAO,CAAC,SAAS,EACjB,KAAK,CAAC,KAAK,CACZ,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC;AAMD,SAAS,YAAY,CACnB,IAAkB,EAClB,IAAY,EACZ,UAA4B,EAC5B,KAAc;IAEd,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACpE,MAAM,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,IAAkB,EAAE,IAAY,EAAE,KAAc;IACjE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,IAAI,CAAC,MAA0B,CAAC;IACnD,IAAI,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,IAAI,IAAA,2BAAU,EAAC,UAAU,CAAC,EAAE,CAAC;YAC3B,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;QACD,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAC5C,OAAO;IACT,CAAC;IACD,IAAI,IAAA,2BAAU,EAAC,UAAU,CAAC,EAAE,CAAC;QAC3B,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAC5C,OAAO;IACT,CAAC;IACD,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAClD,OAAO;IACT,CAAC;IACD,MAAM,OAAO,GACX,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QACnC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC,CAAC,IAAA,oBAAS,EACP,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EACpB,IAAI,CAAC,IAAI,EACT,UAAU,IAAI,CAAC,IAAI,IAAI,IAAI,GAAG,CAC/B,CAAC;IACR,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QAC5B,KAAK,EAAE,IAAI;QACX,UAAU;QACV,KAAK,EAAE,OAAO;QACd,GAAG,EACD,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,UAAU,CAAC,KAAK,CAAC;YACxD,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,SAAS;KAChB,CAAC,CAAC;AACL,CAAC;AAGD,SAAS,MAAM,CAAC,IAAa;IAC3B,OAAO,EAAE,GAAG,EAAE,UAAU,IAAA,oBAAY,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;AACxD,CAAC;AAED,SAAS,OAAO,CAAC,IAAkB,EAAE,IAAY,EAAE,KAAc;IAC/D,IAAI,IAAI,KAAK,iBAAS,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACpB,OAAO;IACT,CAAC;IACD,IAAI,IAAI,KAAK,uBAAe,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;QAC5C,MAAM,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC/B,CAAC;AAMD,SAAS,iBAAiB,CACxB,IAAkB,EAClB,QAAiC;IAEjC,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,MAA0B,CAAC;QACnD,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,IACE,MAAM;YACN,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC;YACnC,CAAC,IAAA,2BAAU,EAAC,UAAU,CAAC,EACvB,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;gBAC5B,KAAK,EAAE,IAAI;gBACX,UAAU;gBACV,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBACxB,SAAS,EAAE,UAAU,CAAC,UAAU;aACjC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC;AAOD,SAAgB,oBAAoB,CAClC,QAAiC,EACjC,KAAiB,EACjB,OAAwB,EACxB,IAAuB;IAEvB,MAAM,QAAQ,GAAG,KAAK,CAAC,QAA4B,CAAC;IACpD,MAAM,IAAI,GAAiB;QACzB,KAAK;QACL,QAAQ;QACR,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,KAAK,EAAE;QAC5C,IAAI;QACJ,OAAO;QACP,OAAO,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;KACjE,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrD,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,IAAI,CAAC,OAAO,CAAC;AACtB,CAAC"}

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

@@ -0,0 +1,5 @@
+import type { ExternalRelation } from "./fields";
+export declare function ExternalWriteRefusal(external: ExternalRelation, stage: string): Error;
+export declare function ExternalFeedRefusal(external: ExternalRelation): Error;
+export declare function ExternalInstanceRefusal(stage: string): Error;
+export declare function KeylessRefusal(external: ExternalRelation): Error;

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-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,121 @@
+"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 DescribeKeyColumns(relation, columns) {
+    const described = (relation.key ?? []).map((name) => {
+        const column = columns.get(name);
+        return column ? (0, external_types_1.DescribeKey)(column) : undefined;
+    });
+    if (described.length === 0 || described.some((key) => !key)) {
+        return undefined;
+    }
+    return described;
+}
+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 = DescribeKeyColumns(relation, 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":";;AAqMA,wDAeC;AA/MD,yCAAsC;AACtC,+BAAoC;AACpC,mCAAoC;AACpC,6CAA6C;AAC7C,yDAI4B;AAC5B,qDAAgF;AAgBhF,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;AAGD,SAAS,kBAAkB,CACzB,QAAyB,EACzB,OAAmC;IAEnC,MAAM,SAAS,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAClD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,4BAAW,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClD,CAAC,CAAC,CAAC;IACH,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,SAA+B,CAAC;AACzC,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,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClD,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,29 @@
+import type { CatalogColumn } from "./external-catalog";
+import { type SqlType } from "./types";
+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;
+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 Describe(field: string, kind: SqlType, column: CatalogColumn, path: string): ColumnDescriptor;
+export declare function DescribeKey(column: 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 {};