@intentius/chant-lexicon-sql 0.0.0-stage → 0.112.1

package/dist/postgres/apply/statements.d.ts

@@ -0,0 +1,138 @@
+/**
+ * The statements that make one classified Postgres change (#3280): the
+ * declared `CREATE` with chant's marker set by `COMMENT ON`, the `ALTER` for
+ * each change the classifier (`../plan/rules.ts`) does not refuse, and the
+ * `DROP` a prune issues.
+ *
+ * Each function takes a declared object, what the server holds for it, and
+ * the changes the diff reported, and returns statements; nothing is sent. The
+ * applier (`./apply.ts`) groups them into transactions and sends them, and
+ * the expand-and-contract migration Op (#3281) builds its expand and contract
+ * steps from the same pieces.
+ *
+ * The SQL is the declaration's own text wherever there is some: a column's
+ * type and default, a constraint's expression, an index's `CREATE`, a view's
+ * `CREATE`. The canonical forms the diff compared are for comparing; what the
+ * server is sent is what the author wrote.
+ *
+ * Every step carries the class of the change it makes, which picks its
+ * transaction and its statement timeout, and whether it may run inside a
+ * transaction block at all (`CREATE INDEX CONCURRENTLY` may not).
+ */
+import type { OwnershipMarker } from "@intentius/chant/ownership";
+import { type Token } from "../tokens.js";
+import { type PostgresEntityType } from "../entity-types.js";
+import type { PgChange } from "../plan/diff.js";
+import { type PgChangeClass, type PgClassifierRuleId } from "../plan/rules.js";
+import { type CanonicalConstraint, type CanonicalKind } from "../plan/normalize.js";
+import type { PgDiffObject } from "../plan/schema.js";
+import type { CheckDef, ColumnDef, ExclusionDef, ForeignKeyDef, KeyDef, SequenceProps } from "../entities.js";
+/** One object as a build declares it, in the shape the applier works with. */
+export interface DeclaredPgObject {
+    /** The export name: the object's identity in chant. */
+    exportName: string;
+    type: PostgresEntityType;
+    /** Its name on the server, as an apply result names it: `app.users`, or a schema's or extension's own name. */
+    name: string;
+    /** The diff's key against a server: the namespace and the qualified name (`relation app.users`). */
+    key: string;
+    /** The statements as the build wrote them: the CREATE, then any COMMENT ON. */
+    ddl: string;
+    /** The props the tag parses out of `ddl`. */
+    props: Record<string, unknown>;
+    /** The canonical form the diff compares. */
+    canonical: PgDiffObject;
+    /** The export names it references. */
+    dependsOn: string[];
+}
+/** One statement to send. */
+export interface PgStep {
+    sql: string;
+    /** The class of the change it makes; it picks the transaction and the statement timeout. */
+    class: PgChangeClass;
+    /** False for a statement that refuses a transaction block or is kept out of one (`CONCURRENTLY`, `ALTER TYPE ... ADD VALUE`). */
+    transactional: boolean;
+    /** The rule of the change it makes, when it makes one. */
+    rule?: PgClassifierRuleId;
+    /** An index this statement builds CONCURRENTLY: a failed build leaves it INVALID, and the applier drops it again. */
+    buildsIndex?: string;
+}
+/** What {@link alterSteps} could not make in place: changes with no statement, each with why. */
+export interface UnsupportedChange {
+    change: PgChange;
+    why: string;
+}
+/** A string literal: `'` doubled (standard_conforming_strings is on). */
+export declare const pgString: (value: string) => string;
+/** `schema.name`, each part quoted where Postgres needs it. */
+export declare const pgQualified: (schema: string | undefined, name: string) => string;
+/** An object's name in a statement. A schema and an extension have no schema. */
+export declare const objectIdent: (o: {
+    kind: CanonicalKind;
+    schema?: string;
+    name: string;
+}) => string;
+/** The words a statement names the object's kind with. */
+export declare const KIND_WORDS: Readonly<Record<CanonicalKind, string>>;
+/** The canonical kind of an entity type. */
+export declare const kindOfType: (type: string) => CanonicalKind;
+interface Statement {
+    text: string;
+    tokens: Token[];
+}
+/** The statements of a template's DDL, split at top-level semicolons, comments kept with the statement they precede. */
+export declare function splitStatements(ddl: string): Statement[];
+/** The declared comment with chant's trailer: what the object's own `COMMENT ON` sets. */
+export declare function commentStatement(obj: Pick<DeclaredPgObject, "canonical">, marker: OwnershipMarker | undefined, base?: string): string;
+/**
+ * The declared statements that create the object, its own `COMMENT ON`
+ * replaced by one carrying chant's marker, so no object is left unmarked.
+ * `base` is the comment kept under the trailer when nothing is declared (an
+ * extension's own comment, from its control file). `orReplace` turns
+ * `CREATE VIEW` into `CREATE OR REPLACE VIEW`.
+ */
+export declare function createSteps(obj: Pick<DeclaredPgObject, "ddl" | "canonical" | "props">, marker: OwnershipMarker | undefined, opts?: {
+    base?: string;
+    orReplace?: boolean;
+    cls?: PgChangeClass;
+    rule?: PgClassifierRuleId;
+}): PgStep[];
+/** The `DROP` for an object a prune removes. Never `CASCADE`: what something else still uses is kept. */
+export declare function dropStatement(kind: CanonicalKind, schema: string | undefined, name: string): PgStep;
+/** A column's definition for `ADD COLUMN`: its type, storage, collation, generation, default and NOT NULL; its constraints are added on their own. */
+export declare function columnDefinition(c: ColumnDef): string;
+/** A constraint as a table constraint (`ADD CONSTRAINT ...`), whether it was declared on a column or the table. */
+export declare function constraintSql(kind: CanonicalConstraint["kind"], def: KeyDef | CheckDef | ForeignKeyDef | ExclusionDef): string;
+/** `ALTER SEQUENCE`'s options for what is declared, every option left out set back to its default. */
+export declare function sequenceOptionsSql(p: SequenceProps): string;
+/** Changes a plan refuses to make in place: expand and contract, by the migration Op (#3281). */
+export declare const isRefused: (c: PgChange) => boolean;
+/** Changes that destroy data, which only an apply allowed to delete makes. */
+export declare const isDestructive: (c: PgChange) => boolean;
+/** Changes that replace the object: drop it and create it again from its declaration. */
+export declare const isRecreate: (c: PgChange) => boolean;
+/**
+ * The statements for an object that exists on the server, change by change.
+ * `live` is the server's definition, matched to the declaration (a renamed
+ * index by its `-- previously:` name). What has no statement in place is
+ * returned in `unsupported`, so the applier can refuse the object rather
+ * than make half of it.
+ */
+export declare function alterSteps(obj: DeclaredPgObject, live: PgDiffObject, changes: readonly PgChange[], opts: {
+    marker?: OwnershipMarker;
+    major: number;
+}): {
+    steps: PgStep[];
+    unsupported: UnsupportedChange[];
+};
+/** Whether a change class reads or rewrites rows, so its statement runs in a transaction of its own with the scan timeout. */
+export declare const scansRows: (cls: PgChangeClass) => boolean;
+/**
+ * The detail of a refused object: each change, the rule and restriction
+ * behind it, and the Op that makes it. `declared` is the object as declared,
+ * which names the table a column rename or type change is handed to
+ * `PostgresMigrationOp` for (`../migrate/handoff.ts`).
+ */
+export declare function refusalDetail(changes: readonly PgChange[], name: string, declared?: Pick<PgDiffObject, "kind" | "schema" | "name">): string;
+export {};
+//# sourceMappingURL=statements.d.ts.map

package/dist/postgres/apply/statements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statements.d.ts","sourceRoot":"","sources":["../../../src/postgres/apply/statements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,EAA0B,KAAK,KAAK,EAAE,MAAM,WAAW,CAAC;AAG/D,OAAO,EAAyB,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAuB,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACjG,OAAO,EAAoC,KAAK,mBAAmB,EAAE,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAe,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAc,MAAM,aAAa,CAAC;AAEpI,8EAA8E;AAC9E,MAAM,WAAW,gBAAgB;IAC/B,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,kBAAkB,CAAC;IACzB,+GAA+G;IAC/G,IAAI,EAAE,MAAM,CAAC;IACb,oGAAoG;IACpG,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,GAAG,EAAE,MAAM,CAAC;IACZ,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,4CAA4C;IAC5C,SAAS,EAAE,YAAY,CAAC;IACxB,sCAAsC;IACtC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,6BAA6B;AAC7B,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,4FAA4F;IAC5F,KAAK,EAAE,aAAa,CAAC;IACrB,iIAAiI;IACjI,aAAa,EAAE,OAAO,CAAC;IACvB,0DAA0D;IAC1D,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B,qHAAqH;IACrH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,iGAAiG;AACjG,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,QAAQ,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAID,yEAAyE;AACzE,eAAO,MAAM,QAAQ,GAAI,OAAO,MAAM,KAAG,MAA0C,CAAC;AAEpF,+DAA+D;AAC/D,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,GAAG,SAAS,EAAE,MAAM,MAAM,KAAG,MAAmF,CAAC;AAE3J,iFAAiF;AACjF,eAAO,MAAM,WAAW,GAAI,GAAG;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,KAAG,MACY,CAAC;AAErG,0DAA0D;AAC1D,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAU9D,CAAC;AAEF,4CAA4C;AAC5C,eAAO,MAAM,UAAU,GAAI,MAAM,MAAM,KAAG,aAC4D,CAAC;AAOvG,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,wHAAwH;AACxH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,CAiBxD;AAgBD,0FAA0F;AAC1F,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,eAAe,GAAG,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAGrI;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,WAAW,GAAG,OAAO,CAAC,EAC1D,MAAM,EAAE,eAAe,GAAG,SAAS,EACnC,IAAI,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,CAAC,EAAE,aAAa,CAAC;IAAC,IAAI,CAAC,EAAE,kBAAkB,CAAA;CAAO,GAChG,MAAM,EAAE,CAYV;AAED,yGAAyG;AACzG,wBAAgB,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAInG;AAID,sJAAsJ;AACtJ,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,CAWrD;AAsCD,mHAAmH;AACnH,wBAAgB,aAAa,CAAC,IAAI,EAAE,mBAAmB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,MAAM,CA6C9H;AAgGD,sGAAsG;AACtG,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,aAAa,GAAG,MAAM,CAc3D;AAID,iGAAiG;AACjG,eAAO,MAAM,SAAS,GAAI,GAAG,QAAQ,KAAG,OAA+B,CAAC;AAExE,8EAA8E;AAC9E,eAAO,MAAM,aAAa,GAAI,GAAG,QAAQ,KAAG,OAAgC,CAAC;AAE7E,yFAAyF;AACzF,eAAO,MAAM,UAAU,GAAI,GAAG,QAAQ,KAAG,OAAyD,CAAC;AAEnG;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,gBAAgB,EACrB,IAAI,EAAE,YAAY,EAClB,OAAO,EAAE,SAAS,QAAQ,EAAE,EAC5B,IAAI,EAAE;IAAE,MAAM,CAAC,EAAE,eAAe,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChD;IAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,WAAW,EAAE,iBAAiB,EAAE,CAAA;CAAE,CA+JvD;AAED,8HAA8H;AAC9H,eAAO,MAAM,SAAS,GAAI,KAAK,aAAa,KAAG,OAA4E,CAAC;AAE5H;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC,GAAG,MAAM,CAa3I"}

package/dist/postgres/catalog-types.d.ts

@@ -0,0 +1,50 @@
+/**
+ * The shapes of the generated Postgres tables (`src/generated/postgres.ts`).
+ * The data is generated; these types are not, so the generated module stays
+ * data and a reader of it has one place to look for what a field means.
+ *
+ * The generated types are the union of every supported major's catalog. A
+ * name that is not in all of them carries a {@link VersionRange}, in the
+ * generated `VERSION_RANGES` table and as `@since` / `@until` on the member's
+ * JSDoc. `since` is the first major with the name and is absent when that is
+ * the oldest supported major; `until` is the last major with it and is absent
+ * when that is the newest.
+ */
+import type { ArgumentKind, ClauseArgument } from "./overlays/kinds.js";
+import type { StorageParameterType } from "./overlays/storage.js";
+export type { ArgumentKind, ClauseArgument, StorageParameterType };
+export interface VersionRange {
+    /** The first supported major that has this name. Absent: the oldest. */
+    readonly since?: number;
+    /** The last supported major that has this name. Absent: the newest. */
+    readonly until?: number;
+}
+/** True when `range` (or no range) covers `major`. */
+export declare function availableAt(range: VersionRange | undefined, major: number): boolean;
+export interface SettingSpec {
+    /** `bool`, `integer`, `real`, `string` or `enum`, as `pg_settings.vartype` says (the newest major that has the setting). */
+    type: string;
+    /** When a value can be changed: `postmaster`, `sighup`, `superuser`, `user`... */
+    context: string;
+    category: string;
+    unit?: string;
+    default?: string;
+    min?: string;
+    max?: string;
+}
+export interface StorageParameterSpec {
+    type: StorageParameterType;
+    /** The relation kinds that accept it: `table`, `toast`, `view`, `materialized view`, `index:btree`... */
+    targets: readonly string[];
+}
+export interface ColumnTypeSpec {
+    /** The `pg_type` name (`int4`), when it differs from the SQL name. */
+    catalogName?: string;
+    /** `typcategory`: `N` numeric, `S` string, `D` date and time... */
+    category: string;
+    /** Spellings that stand for this type (`int`, `int4`). */
+    aliases: readonly string[];
+    /** The type's parameters, from the overlay; none when it takes none. */
+    parameters: readonly ClauseArgument[];
+}
+//# sourceMappingURL=catalog-types.d.ts.map

package/dist/postgres/catalog-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog-types.d.ts","sourceRoot":"","sources":["../../src/postgres/catalog-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAC;AAEnE,MAAM,WAAW,YAAY;IAC3B,wEAAwE;IACxE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,sDAAsD;AACtD,wBAAgB,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAGnF;AAED,MAAM,WAAW,WAAW;IAC1B,4HAA4H;IAC5H,IAAI,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,yGAAyG;IACzG,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,wEAAwE;IACxE,UAAU,EAAE,SAAS,cAAc,EAAE,CAAC;CACvC"}

package/dist/postgres/container.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A throwaway `postgres` server in a container, for catalog generation and the
+ * live tests: started under a unique name with no published port, queried with
+ * `docker exec psql`, and always removed.
+ *
+ * The official image restarts the server once after `initdb`, so the ready
+ * line appears twice in its log; the server is ready on the second.
+ */
+export { dockerAvailable } from "../core/container.js";
+export interface ScratchPostgres {
+    /** The container's name, for a log line. */
+    name: string;
+    /** Run a SQL script with psql as `postgres` (`-qAt`, stop at the first error) and return its stdout. */
+    psql(sql: string): Promise<string>;
+    /** Remove the container. Safe to call twice. */
+    stop(): Promise<void>;
+}
+/** Start `image` and wait until the server accepts connections. Pulls the image when it is absent. */
+export declare function startScratchPostgres(image: string, options?: {
+    namePrefix?: string;
+    readyTimeoutMs?: number;
+}): Promise<ScratchPostgres>;
+//# sourceMappingURL=container.d.ts.map

package/dist/postgres/container.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"container.d.ts","sourceRoot":"","sources":["../../src/postgres/container.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIpD,MAAM,WAAW,eAAe;IAC9B,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,wGAAwG;IACxG,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,gDAAgD;IAChD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAkBD,sGAAsG;AACtG,wBAAsB,oBAAoB,CACxC,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,CAAA;CAAO,GAC7D,OAAO,CAAC,eAAe,CAAC,CAyB1B"}

package/dist/postgres/entities.d.ts

@@ -0,0 +1,322 @@
+/**
+ * The Postgres entities: `schema`, `table`, `index`, `view`, `sequence`,
+ * `type`, `domain` and `extension` tagged templates that parse their DDL at
+ * fold time into one Declarable each (chant #3278, #3279).
+ *
+ * ```ts
+ * import { schema, table, index } from "@intentius/chant-lexicon-sql/postgres";
+ *
+ * export const app = schema`CREATE SCHEMA app`;
+ * export const users = table`
+ *   CREATE TABLE ${app}.users (
+ *     id    bigint GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+ *     email text NOT NULL UNIQUE
+ *   );
+ *   COMMENT ON TABLE ${app}.users IS 'One row per account'`;
+ * export const usersEmail = index`CREATE INDEX users_email_idx ON ${users} (lower(${users.columns.email}))`;
+ * ```
+ *
+ * The export name is the object's identity in chant; the name in the SQL is
+ * its name in the database. An unquoted name folds to lower case, as Postgres
+ * folds it, so `CREATE TABLE Users` is `users` and `.columns` is keyed by the
+ * folded name.
+ *
+ * What an interpolation means is decided by its value, as for ClickHouse
+ * (#3235):
+ *
+ * - a Postgres entity is a reference to that object and renders as its
+ *   schema-qualified name; a schema renders as its name, so `${app}.users`
+ *   reads `app.users`;
+ * - `entity.columns.<name>` is a reference to one column, and renders as the
+ *   column's name (write `u.${users.columns.id}` in a join);
+ * - a sequence inside `nextval(...)`, `currval(...)` or `setval(...)`, and any
+ *   object followed by `::regclass`, renders as a `regclass` literal:
+ *   `DEFAULT nextval(${ticketSeq})` reads `nextval('app.ticket_seq'::regclass)`,
+ *   which is also how the catalog prints it, and the table depends on the
+ *   sequence;
+ * - a string is SQL text, spliced into the statement before it is parsed;
+ * - a number or bigint is a numeric literal, a boolean `true`/`false`, `null`
+ *   is `NULL`;
+ * - `literal(value)` is a quoted string literal (`'` doubled; a backslash is an
+ *   ordinary character, since standard_conforming_strings is on).
+ *
+ * Postgres has no inline comment clause, so a template may follow its CREATE
+ * with `COMMENT ON` statements for the same object, its columns and its
+ * constraints. They fold into the entity's `comment`, each column's and each
+ * constraint's, and stay in the DDL.
+ */
+import type { AttrRef } from "@intentius/chant/attrref";
+import { type StatementNode } from "./parser.js";
+import { type TemplateDialect } from "../core/interpolation.js";
+import { SqlObject } from "../core/entity.js";
+import type { LineageEdge } from "../core/references.js";
+import { SqlLiteral } from "../core/template.js";
+export { SQL_LEXICON } from "../core/entity.js";
+export type { LineageEdge } from "../core/references.js";
+export { SqlLiteral, SqlTemplateError } from "../core/template.js";
+export { quoteIdent } from "./keywords.js";
+export { POSTGRES_ENTITY_TYPES, type PostgresEntityType } from "./entity-types.js";
+import { type PostgresEntityType } from "./entity-types.js";
+/** A column as declared. Expressions are the source text with interpolations rendered. */
+export interface ColumnDef {
+    name: string;
+    /** Absent on a typed table (`OF type`) or a partition, whose columns take their type elsewhere. */
+    type?: string;
+    /** `NOT NULL` (true) or `NULL` (false), when written. */
+    notNull?: boolean;
+    /** The name given to the column's NOT NULL constraint. */
+    notNullName?: string;
+    default?: string;
+    /** `GENERATED ALWAYS AS (expr) STORED | VIRTUAL`, or `GENERATED { ALWAYS | BY DEFAULT } AS IDENTITY [(options)]`. */
+    generated?: {
+        kind: "stored" | "virtual" | "identity";
+        expr?: string;
+        always: boolean;
+        options?: string;
+    };
+    collate?: string;
+    compression?: string;
+    storage?: string;
+    comment?: string;
+}
+/** Deferral attributes, on the constraints that take them. */
+interface Deferral {
+    deferrable?: boolean;
+    initiallyDeferred?: boolean;
+}
+export interface KeyDef extends Deferral {
+    name?: string;
+    columns: string[];
+    nullsNotDistinct?: boolean;
+    include?: string;
+    with?: string;
+    comment?: string;
+}
+export interface CheckDef {
+    name?: string;
+    expr: string;
+    noInherit?: boolean;
+    notValid?: boolean;
+    notEnforced?: boolean;
+    comment?: string;
+}
+export interface ForeignKeyDef extends Deferral {
+    name?: string;
+    columns: string[];
+    /** The referenced table: the entity when it is interpolated, else its name as written. */
+    references: PostgresObject | string;
+    /** The referenced table's SQL name, schema-qualified as written. */
+    refTable: string;
+    /** The referenced columns; empty means the referenced table's primary key. */
+    refColumns: string[];
+    match?: string;
+    onDelete?: string;
+    onUpdate?: string;
+    notValid?: boolean;
+    notEnforced?: boolean;
+    comment?: string;
+}
+export interface ExclusionDef extends Deferral {
+    name?: string;
+    using?: string;
+    /** The element list, `col WITH op, ...`, as written. */
+    elements: string;
+    where?: string;
+    include?: string;
+    with?: string;
+    comment?: string;
+}
+interface CommonProps {
+    /** The object's name in the database, folded as Postgres folds it. */
+    name: string;
+    /** The schema the DDL qualifies it with. */
+    schema?: string;
+    comment?: string;
+    /** The statements as they will be sent: the author's text, interpolations rendered. */
+    ddl: string;
+    /** The template's raw parts, as written, for a source round trip. */
+    source: {
+        strings: string[];
+    };
+}
+export interface SchemaProps extends Omit<CommonProps, "schema"> {
+    ifNotExists?: boolean;
+    authorization?: string;
+}
+export interface TableProps extends CommonProps {
+    persistence?: "temporary" | "unlogged";
+    ifNotExists?: boolean;
+    /** `PARTITION OF parent`: the entity when interpolated, else its name. */
+    partitionOf?: PostgresObject | string;
+    partitionBound?: string;
+    /** `OF type`: the entity when interpolated, else its name. */
+    ofType?: PostgresObject | string;
+    columns: ColumnDef[];
+    primaryKey?: KeyDef;
+    uniques: KeyDef[];
+    checks: CheckDef[];
+    foreignKeys: ForeignKeyDef[];
+    exclusions: ExclusionDef[];
+    /** `LIKE source [options]` clauses, as written. */
+    like: string[];
+    inherits: Array<PostgresObject | string>;
+    partitionBy?: string;
+    using?: string;
+    /** Storage parameters, as written: `(fillfactor = 70)`. */
+    with?: string;
+    onCommit?: string;
+    tablespace?: string;
+}
+export interface IndexProps extends CommonProps {
+    /** The indexed table: the entity when interpolated, else its name. */
+    table: PostgresObject | string;
+    /** The indexed table's SQL name. */
+    tableName: string;
+    unique?: boolean;
+    /** `CREATE INDEX CONCURRENTLY`: the classifier and the applier read it, since it refuses a transaction block. */
+    concurrently?: boolean;
+    ifNotExists?: boolean;
+    only?: boolean;
+    /** The access method (`btree`, `gin`, ...), when written. */
+    method?: string;
+    elements: Array<{
+        expr: string;
+        column?: string;
+    }>;
+    include?: string;
+    nullsNotDistinct?: boolean;
+    with?: string;
+    tablespace?: string;
+    where?: string;
+}
+export interface ViewProps extends CommonProps {
+    orReplace?: boolean;
+    recursive?: boolean;
+    temporary?: boolean;
+    ifNotExists?: boolean;
+    /** The declared column list; empty when the view names its outputs in its query. */
+    columns: string[];
+    with?: string;
+    using?: string;
+    tablespace?: string;
+    query: string;
+    checkOption?: string;
+    /** `WITH DATA` (true) or `WITH NO DATA` (false), for a materialized view. */
+    withData?: boolean;
+    /** The objects the query reads, as references. */
+    reads: PostgresObject[];
+    /** Per output column of the top-level select list, the columns it reads. */
+    lineage: LineageEdge[];
+    /** `COMMENT ON COLUMN` for the view's outputs. */
+    columnComments?: Record<string, string>;
+}
+export interface SequenceProps extends CommonProps {
+    persistence?: "temporary" | "unlogged";
+    ifNotExists?: boolean;
+    /** `AS type`: the sequence's data type. */
+    dataType?: string;
+    increment?: string;
+    /** A value, or `null` for `NO MINVALUE`. */
+    minValue?: string | null;
+    maxValue?: string | null;
+    start?: string;
+    cache?: string;
+    /** `CYCLE` (true) or `NO CYCLE` (false), when written. */
+    cycle?: boolean;
+    /** `OWNED BY table.column`, or `NONE`. */
+    ownedBy?: string;
+}
+export interface EnumProps extends CommonProps {
+    labels: string[];
+}
+export interface DomainProps extends CommonProps {
+    /** The underlying data type. */
+    dataType: string;
+    collate?: string;
+    default?: string;
+    notNull?: boolean;
+    checks: CheckDef[];
+}
+export interface ExtensionProps extends Omit<CommonProps, "schema"> {
+    /** `WITH SCHEMA`: the schema the extension's objects are created in. */
+    schema?: string;
+    version?: string;
+    cascade?: boolean;
+    ifNotExists?: boolean;
+}
+/**
+ * A string as a quoted Postgres string literal: `'` doubled, a backslash left
+ * as written (standard_conforming_strings is on). An interpolated plain string
+ * is SQL text; wrap it in `literal()` when it is a value.
+ */
+export declare function literal(value: string | number | boolean | null): SqlLiteral;
+/** The members a Postgres entity has besides its props (the shared core's {@link SqlObject}). */
+export declare abstract class PostgresObject extends SqlObject {
+    readonly entityType: PostgresEntityType;
+    /** The name the object is referred to by in SQL: `name`, or `schema.name`, quoted where Postgres needs it. */
+    readonly sqlName: string;
+}
+export interface PostgresSchema extends PostgresObject {
+    readonly entityType: "Postgres::Schema";
+    readonly props: SchemaProps;
+}
+/** A table or a view: something with columns that SQL can reference. */
+export interface PostgresRelation extends PostgresObject {
+    /** One reference per column, by its folded name: `${users.columns.email}`. */
+    readonly columns: Readonly<Record<string, AttrRef>>;
+}
+export interface PostgresTable extends PostgresRelation {
+    readonly entityType: "Postgres::Table";
+    readonly props: TableProps;
+}
+export interface PostgresView extends PostgresRelation {
+    readonly entityType: "Postgres::View" | "Postgres::MaterializedView";
+    readonly props: ViewProps;
+}
+export interface PostgresIndex extends PostgresObject {
+    readonly entityType: "Postgres::Index";
+    readonly props: IndexProps;
+}
+export interface PostgresSequence extends PostgresObject {
+    readonly entityType: "Postgres::Sequence";
+    readonly props: SequenceProps;
+}
+export interface PostgresEnum extends PostgresObject {
+    readonly entityType: "Postgres::Enum";
+    readonly props: EnumProps;
+}
+export interface PostgresDomain extends PostgresObject {
+    readonly entityType: "Postgres::Domain";
+    readonly props: DomainProps;
+}
+export interface PostgresExtension extends PostgresObject {
+    readonly entityType: "Postgres::Extension";
+    readonly props: ExtensionProps;
+}
+export declare function isPostgresObject(value: unknown): value is PostgresObject;
+/** A column reference: an AttrRef whose parent is a Postgres table or view. */
+export declare function isColumnRef(value: unknown): value is AttrRef;
+/** Postgres as the shared template machinery reads it (`../core/interpolation.ts`). */
+export declare const POSTGRES_TEMPLATES: TemplateDialect;
+export type PostgresTag = "schema" | "table" | "index" | "view" | "sequence" | "type" | "domain" | "extension";
+/** What each statement kind is called in a message. */
+export declare const STATEMENT_NAMES: Record<StatementNode["statement"], string>;
+/** A string constant's value: `'...'`, `E'...'`, `$tag$...$tag$`. */
+export declare function stringValue(s: string | undefined): string | undefined;
+/** `` schema`CREATE SCHEMA ...` ``: one Postgres schema, parsed at build time. */
+export declare function schema(strings: TemplateStringsArray, ...values: unknown[]): PostgresSchema;
+/** `` table`CREATE TABLE ...` ``: one Postgres table with its columns and constraints, parsed at build time. */
+export declare function table(strings: TemplateStringsArray, ...values: unknown[]): PostgresTable;
+/** `` index`CREATE [UNIQUE] INDEX [CONCURRENTLY] name ON ...` ``: one named index. */
+export declare function index(strings: TemplateStringsArray, ...values: unknown[]): PostgresIndex;
+/** `` view`CREATE [MATERIALIZED] VIEW ...` ``: one view or materialized view, with what it reads and its column lineage. */
+export declare function view(strings: TemplateStringsArray, ...values: unknown[]): PostgresView;
+/** `` sequence`CREATE SEQUENCE ...` ``: one sequence. Reference it as `nextval(${seq})`. */
+export declare function sequence(strings: TemplateStringsArray, ...values: unknown[]): PostgresSequence;
+/** `` type`CREATE TYPE name AS ENUM (...)` ``: one enum type. */
+export declare function type(strings: TemplateStringsArray, ...values: unknown[]): PostgresEnum;
+/** `` domain`CREATE DOMAIN ...` ``: one domain. */
+export declare function domain(strings: TemplateStringsArray, ...values: unknown[]): PostgresDomain;
+/** `` extension`CREATE EXTENSION ...` ``: one extension. */
+export declare function extension(strings: TemplateStringsArray, ...values: unknown[]): PostgresExtension;
+//# sourceMappingURL=entities.d.ts.map

package/dist/postgres/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/postgres/entities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAGxD,OAAO,EAAiH,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE7J,OAAO,EAAgG,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC3J,OAAO,EAAE,SAAS,EAA+C,MAAM,gBAAgB,CAAC;AACxF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,UAAU,EAA0E,MAAM,kBAAkB,CAAC;AAEtH,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,EAAE,qBAAqB,EAAE,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAChF,OAAO,EAAyB,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAIhF,0FAA0F;AAC1F,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,mGAAmG;IACnG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qHAAqH;IACrH,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1G,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,8DAA8D;AAC9D,UAAU,QAAQ;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,MAAO,SAAQ,QAAQ;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,0FAA0F;IAC1F,UAAU,EAAE,cAAc,GAAG,MAAM,CAAC;IACpC,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IACjB,8EAA8E;IAC9E,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,WAAW;IACnB,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uFAAuF;IACvF,GAAG,EAAE,MAAM,CAAC;IACZ,qEAAqE;IACrE,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAC/B;AAED,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IAC9D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC7C,WAAW,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IACvC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,8DAA8D;IAC9D,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IACjC,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,UAAU,EAAE,YAAY,EAAE,CAAC;IAC3B,mDAAmD;IACnD,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,QAAQ,EAAE,KAAK,CAAC,cAAc,GAAG,MAAM,CAAC,CAAC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC7C,sEAAsE;IACtE,KAAK,EAAE,cAAc,GAAG,MAAM,CAAC;IAC/B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,iHAAiH;IACjH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAU,SAAQ,WAAW;IAC5C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oFAAoF;IACpF,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,4EAA4E;IAC5E,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,kDAAkD;IAClD,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,WAAW,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IACvC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,SAAU,SAAQ,WAAW;IAC5C,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,QAAQ,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IACjE,wEAAwE;IACxE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,UAAU,CAI3E;AAID,iGAAiG;AACjG,8BAAsB,cAAe,SAAQ,SAAS;IACpD,SAAiB,UAAU,EAAE,kBAAkB,CAAC;IAChD,8GAA8G;IAC9G,SAAiB,OAAO,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;CAC7B;AAED,wEAAwE;AACxE,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,8EAA8E;IAC9E,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC5B;AAED,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,QAAQ,CAAC,UAAU,EAAE,gBAAgB,GAAG,4BAA4B,CAAC;IACrE,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAC1C,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;IAC3C,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAChC;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAExE;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE5D;AAuED,uFAAuF;AACvF,eAAO,MAAM,kBAAkB,EAAE,eAiBhC,CAAC;AAMF,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,CAAC;AAyB/G,uDAAuD;AACvD,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,CAUtE,CAAC;AAUF,qEAAqE;AACrE,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CASrE;AA6eD,kFAAkF;AAClF,wBAAgB,MAAM,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAE1F;AAED,gHAAgH;AAChH,wBAAgB,KAAK,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,CAExF;AAED,sFAAsF;AACtF,wBAAgB,KAAK,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,CAExF;AAED,4HAA4H;AAC5H,wBAAgB,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,YAAY,CAEtF;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAE9F;AAED,iEAAiE;AACjE,wBAAgB,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,YAAY,CAEtF;AAED,mDAAmD;AACnD,wBAAgB,MAAM,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAE1F;AAED,4DAA4D;AAC5D,wBAAgB,SAAS,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,iBAAiB,CAEhG"}

package/dist/postgres/entity-types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The Postgres entity types, apart from the tags so generation can name them
+ * before the generated tables the tags read exist.
+ */
+export declare const POSTGRES_ENTITY_TYPES: {
+    readonly schema: "Postgres::Schema";
+    readonly table: "Postgres::Table";
+    readonly index: "Postgres::Index";
+    readonly view: "Postgres::View";
+    readonly materializedView: "Postgres::MaterializedView";
+    readonly sequence: "Postgres::Sequence";
+    readonly enum: "Postgres::Enum";
+    readonly domain: "Postgres::Domain";
+    readonly extension: "Postgres::Extension";
+};
+export type PostgresEntityType = (typeof POSTGRES_ENTITY_TYPES)[keyof typeof POSTGRES_ENTITY_TYPES];
+//# sourceMappingURL=entity-types.d.ts.map

package/dist/postgres/entity-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-types.d.ts","sourceRoot":"","sources":["../../src/postgres/entity-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;CAUxB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC"}

package/dist/postgres/import/generator.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The import IR as TypeScript: one `schema.ts` holding every imported object
+ * as a `schema`, `table`, `index`, `view`, `sequence`, `type`, `domain` or
+ * `extension` declaration, in dependency order, with the references between
+ * them interpolated, so the build orders them as the server did:
+ *
+ * - a qualified name of another imported object becomes `${export}`
+ *   (`REFERENCES app.users(id)` is `REFERENCES ${users}(id)`, a type
+ *   `app.order_status` is `${orderStatus}`);
+ * - a sequence named in a `regclass` literal becomes the reference
+ *   (`nextval('app.invoice_seq'::regclass)` is `nextval(${invoiceSeq})`);
+ * - the schema part of the object's own name, wherever the name appears,
+ *   becomes the schema's export (`CREATE TABLE ${appSchema}.users`);
+ * - an extension's `WITH SCHEMA` names the schema's export.
+ *
+ * Columns stay text, as they do for ClickHouse (#3236): which relation a bare
+ * column belongs to is the server's to resolve. One file, because the
+ * references cross schemas freely.
+ */
+import type { GeneratedFile, TypeScriptGenerator } from "@intentius/chant/import/generator";
+import type { TemplateIR } from "@intentius/chant/import/parser";
+export declare class PostgresGenerator implements TypeScriptGenerator {
+    private readonly header?;
+    readonly ownsLayout = true;
+    constructor(header?: string | undefined);
+    generate(ir: TemplateIR): GeneratedFile[];
+}
+//# sourceMappingURL=generator.d.ts.map

package/dist/postgres/import/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../src/postgres/import/generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAwGjE,qBAAa,iBAAkB,YAAW,mBAAmB;IAG/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAFpC,QAAQ,CAAC,UAAU,QAAQ;gBAEE,MAAM,CAAC,EAAE,MAAM,YAAA;IAE5C,QAAQ,CAAC,EAAE,EAAE,UAAU,GAAG,aAAa,EAAE;CA6C1C"}

package/dist/postgres/import/ir.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Postgres objects into the import IR: one resource per object, the
+ * statements that create it as the server prints them (`../live/catalog.ts`),
+ * and an export name.
+ */
+import type { TemplateIR } from "@intentius/chant/import/parser";
+import { type PostgresEntityType } from "../entity-types.js";
+export interface ImportedPgObject {
+    type: PostgresEntityType;
+    schema?: string;
+    name: string;
+    /** The CREATE, then any COMMENT ON statements, separated by `;`. */
+    ddl: string;
+}
+/**
+ * Export names: an object's name in camel case, prefixed with its schema when
+ * two schemas hold the same name; a schema's name with `Schema` after it and
+ * an extension's with `Extension`, so `app` the schema and `app` a table do
+ * not collide.
+ */
+export declare function exportNames(objects: readonly ImportedPgObject[]): string[];
+/** The IR for a set of objects. */
+export declare function objectsToIR(objects: readonly ImportedPgObject[], warnings?: string[]): TemplateIR;
+//# sourceMappingURL=ir.d.ts.map

package/dist/postgres/import/ir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ir.d.ts","sourceRoot":"","sources":["../../../src/postgres/import/ir.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAc,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAyB,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEjF,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAC;CACb;AAeD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,SAAS,gBAAgB,EAAE,GAAG,MAAM,EAAE,CAmB1E;AAED,mCAAmC;AACnC,wBAAgB,WAAW,CAAC,OAAO,EAAE,SAAS,gBAAgB,EAAE,EAAE,QAAQ,GAAE,MAAM,EAAO,GAAG,UAAU,CAQrG"}