@intentius/chant-lexicon-sql 0.124.12 → 0.124.14

package/dist/rules/postgres-helpers.ts

@@ -8,54 +8,26 @@
 import type { PostSynthCheck, PostSynthContext, PostSynthDiagnostic } from "@intentius/chant/lint/post-synth";
 import { POSTGRES_MAJORS, VERSION_RANGES } from "../../generated/postgres";
 import type { VersionRange } from "../../postgres/catalog-types";
-import type { ColumnDef, KeyDef } from "../../postgres/entities";
-import { postgresMajorOf, postgresObjects, type OutputObject } from "./sql-helpers";
+import { readPostgres, type PostgresIndexInfo, type PostgresTableInfo, type PostgresViewInfo } from "../../read/postgres";
+import type { PostgresIndexJson, PostgresTableJson, PostgresViewJson } from "../../read/objects";
+import { postgresMajorOf, type OutputObject } from "./sql-helpers";
 
-export interface PgTable extends OutputObject {
-  sqlName: string;
-  like: string[];
-  schema?: string;
-  comment?: string;
-  columns: Array<ColumnDef & { comment?: string }>;
-  primaryKey?: KeyDef;
-  uniques: KeyDef[];
-  checks: Array<{ name?: string; expr: string; notEnforced?: boolean }>;
-  foreignKeys: Array<{ name?: string; columns: string[]; refTable: string; refColumns: string[] }>;
-  exclusions: unknown[];
-  inherits: unknown[];
-  partitionOf?: unknown;
-  ofType?: unknown;
-  persistence?: string;
-  with?: string;
-}
-
-export interface PgIndex extends OutputObject {
-  sqlName: string;
-  schema?: string;
-  table: string;
-  tableName: string;
-  unique?: boolean;
-  method?: string;
-  elements: Array<{ expr: string; column?: string }>;
-  include?: string;
-  where?: string;
-  with?: string;
-}
-
-export interface PgView extends OutputObject {
-  sqlName: string;
-  schema?: string;
-  query: string;
-  with?: string;
-}
+/**
+ * The objects as the public read API types them (`../../read/postgres.ts`,
+ * `@intentius/chant-lexicon-sql/read`): the checks and a project's own
+ * `lint.policies` read the same values.
+ */
+export type PgTable = PostgresTableInfo;
+export type PgIndex = PostgresIndexInfo;
+export type PgView = PostgresViewInfo;
 
-export const isTable = (o: OutputObject): o is PgTable => o.type === "Postgres::Table";
-export const isIndex = (o: OutputObject): o is PgIndex => o.type === "Postgres::Index";
-export const isView = (o: OutputObject): o is PgView => o.type === "Postgres::View";
-export const isMaterializedView = (o: OutputObject): o is PgView => o.type === "Postgres::MaterializedView";
+export const isTable = (o: OutputObject): o is OutputObject & PostgresTableJson => o.type === "Postgres::Table";
+export const isIndex = (o: OutputObject): o is OutputObject & PostgresIndexJson => o.type === "Postgres::Index";
+export const isView = (o: OutputObject): o is OutputObject & PostgresViewJson => o.type === "Postgres::View";
+export const isMaterializedView = (o: OutputObject): o is OutputObject & PostgresViewJson => o.type === "Postgres::MaterializedView";
 
-export const tablesOf = (ctx: PostSynthContext): PgTable[] => postgresObjects(ctx).filter(isTable);
-export const indexesOf = (ctx: PostSynthContext): PgIndex[] => postgresObjects(ctx).filter(isIndex);
+export const tablesOf = (ctx: PostSynthContext): PgTable[] => readPostgres(ctx).tables;
+export const indexesOf = (ctx: PostSynthContext): PgIndex[] => readPostgres(ctx).indexes;
 
 /** The major the build targets (`postgresMajor` in the output), else the newest pinned. */
 export const targetMajor = (ctx: PostSynthContext): number => postgresMajorOf(ctx, PINNED_MAJOR);
@@ -87,14 +59,7 @@ export function storageParams(text: string | undefined): Map<string, string> {
 }
 
 /** The leading bare-column elements of an index, in order; stops at the first expression. */
-export function leadingColumns(index: PgIndex): string[] {
-  const out: string[] = [];
-  for (const e of index.elements) {
-    if (!e.column) break;
-    out.push(e.column);
-  }
-  return out;
-}
+export const leadingColumns = (index: PgIndex): string[] => index.columns;
 
 /** A check over the build's Postgres objects, so each check file holds its rule. */
 export function checkOf(

package/dist/rules/postgres-names.ts

@@ -12,13 +12,13 @@
  */
 
 import type { PostSynthContext } from "@intentius/chant/lint/post-synth";
-import { COLUMN_TYPES, FUNCTIONS, INDEX_ACCESS_METHODS, KEYWORDS, OPERATOR_CLASSES } from "../../generated/postgres";
+import { COLUMN_TYPES, FUNCTIONS, INDEX_ACCESS_METHODS, KEYWORDS, OPERATOR_CLASSES, POSTGRES_MAJORS } from "../../generated/postgres";
 import { EXTENSION_OBJECTS } from "../../postgres/overlays/extension-objects";
 import { GRAMMAR_TYPE_SPELLINGS, SERIAL_TYPES, SERIAL_WIDTH_SPELLINGS, TYPE_SPELLINGS } from "../../postgres/overlays/types";
 import { isTrivia, tokenizeText, type Token } from "../../postgres/tokens";
 import type { ColumnTypeSpec } from "../../postgres/catalog-types";
-import { targetMajor, type PgTable } from "./postgres-helpers";
-import { postgresObjects, type OutputObject } from "./sql-helpers";
+import { dialectObjects, recordedPostgresMajor, type PostgresTableJson as PgTable } from "../../read/objects";
+import type { OutputObject } from "./sql-helpers";
 
 // ── Catalog lookups ────────────────────────────────────────────────────
 
@@ -120,7 +120,7 @@ export interface PgProject {
 }
 
 export function projectOf(ctx: PostSynthContext): PgProject {
-  return projectFromObjects(postgresObjects(ctx), targetMajor(ctx));
+  return projectFromObjects(dialectObjects(ctx, "postgres"), recordedPostgresMajor(ctx, POSTGRES_MAJORS[POSTGRES_MAJORS.length - 1]!));
 }
 
 /** The project a set of output objects declares, at `major`: for a reader that holds the build output itself (`chant sql types`). */
@@ -386,7 +386,7 @@ function providesFunction(e: (typeof EXTENSION_OBJECTS)[string], name: string):
 export function expressionsOf(o: OutputObject): Array<{ where: string; expr: string }> {
   const out: Array<{ where: string; expr: string }> = [];
   if (o.type === "Postgres::Table") {
-    const t = o as PgTable;
+    const t = o as unknown as PgTable;
     for (const c of t.columns) {
       if (c.default) out.push({ where: `column ${c.name}'s DEFAULT`, expr: c.default });
       if (c.generated?.expr) out.push({ where: `generated column ${c.name}`, expr: c.generated.expr });
@@ -483,7 +483,7 @@ export function interpolatedTable(p: PgProject, ref: unknown, sqlName: string |
   const o = p.byExport.get(ref);
   if (!o || o.type !== "Postgres::Table") return undefined;
   if (sqlName !== undefined && o.sqlName !== sqlName) return undefined;
-  return o as PgTable;
+  return o as unknown as PgTable;
 }
 
 /**

package/dist/rules/sql-helpers.ts

@@ -1,41 +1,26 @@
 /**
  * Reading the sql lexicon's build output in a post-synth check: the JSON
- * document the serializer writes (`dialect`, `applyOrder`, `objects`).
+ * document the serializer writes (`dialect`, `applyOrder`, `objects`). The
+ * documents are found by `../../read/objects.ts`, the same path the public
+ * read API (`@intentius/chant-lexicon-sql/read`) takes.
  */
 
 import type { PostSynthContext } from "@intentius/chant/lint/post-synth";
+import { dialectObjects, recordedPostgresMajor, type SqlObjectJson } from "../../read/objects";
 
-export interface OutputObject {
-  export: string;
-  type: string;
-  name: string;
+export interface OutputObject extends SqlObjectJson {
   database?: string;
   engine?: { name: string; args?: string[] };
-  [key: string]: unknown;
 }
 
 /** Every schema object in the build's sql output, ClickHouse dialect. */
 export function clickhouseObjects(ctx: PostSynthContext): OutputObject[] {
-  const out: OutputObject[] = [];
-  for (const doc of ctx.docs ?? []) {
-    if (doc.error || doc.lexicon !== "sql" || doc.format !== "json") continue;
-    const value = doc.value as { dialect?: unknown; objects?: unknown };
-    if (value?.dialect !== "clickhouse" || !Array.isArray(value.objects)) continue;
-    out.push(...(value.objects as OutputObject[]));
-  }
-  return out;
+  return dialectObjects(ctx, "clickhouse") as OutputObject[];
 }
 
 /** Every schema object in the build's sql output, Postgres dialect. */
 export function postgresObjects(ctx: PostSynthContext): OutputObject[] {
-  const out: OutputObject[] = [];
-  for (const doc of ctx.docs ?? []) {
-    if (doc.error || doc.lexicon !== "sql" || doc.format !== "json") continue;
-    const value = doc.value as { dialect?: unknown; objects?: unknown };
-    if (value?.dialect !== "postgres" || !Array.isArray(value.objects)) continue;
-    out.push(...(value.objects as OutputObject[]));
-  }
-  return out;
+  return dialectObjects(ctx, "postgres") as OutputObject[];
 }
 
 /**
@@ -44,10 +29,5 @@ export function postgresObjects(ctx: PostSynthContext): OutputObject[] {
  * output that carries none.
  */
 export function postgresMajorOf(ctx: PostSynthContext, fallback: number): number {
-  for (const doc of ctx.docs ?? []) {
-    if (doc.error || doc.lexicon !== "sql" || doc.format !== "json") continue;
-    const value = doc.value as { dialect?: unknown; postgresMajor?: unknown };
-    if (value?.dialect === "postgres" && typeof value.postgresMajor === "number") return value.postgresMajor;
-  }
-  return fallback;
+  return recordedPostgresMajor(ctx, fallback);
 }

package/dist/rules/sqlch102.ts

@@ -1,5 +1,4 @@
-import { checkOf, isTable, keyElements } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, keyElements, tablesOf } from "./clickhouse-helpers";
 
 /**
  * SQLCH102: a PRIMARY KEY that is not a prefix of ORDER BY.
@@ -9,7 +8,7 @@ import { clickhouseObjects } from "./sql-helpers";
  * the table at CREATE.
  */
 export const sqlch102 = checkOf({ id: "SQLCH102", description: "A PRIMARY KEY is not a prefix of ORDER BY" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     if (!t.primaryKey || !t.orderBy) continue;
     const pk = keyElements(t.primaryKey).map((e) => e.replace(/\s+/g, ""));
     const ob = keyElements(t.orderBy).map((e) => e.replace(/\s+/g, ""));

package/dist/rules/sqlch103.ts

@@ -1,5 +1,4 @@
-import { baseEngineName, checkOf, columnByName, engineArguments, isNullableType, isTable, typeFamily } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { baseEngineName, checkOf, columnByName, engineArguments, isNullableType, tablesOf, typeFamily } from "./clickhouse-helpers";
 
 const VERSION_TYPES = new Set(["UInt8", "UInt16", "UInt32", "UInt64", "UInt128", "UInt256", "Date", "DateTime", "DateTime64"]);
 
@@ -25,7 +24,7 @@ const SPECIAL: Record<string, Array<{ role: string; index: number; accepts: (fam
  * .../collapsingmergetree, .../versionedcollapsingmergetree (sign: Int8).
  */
 export const sqlch103 = checkOf({ id: "SQLCH103", description: "An engine's version, sign or is_deleted column has an unsupported type" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     if (!t.engine) continue;
     const roles = SPECIAL[baseEngineName(t.engine)];
     if (!roles) continue;

package/dist/rules/sqlch104.ts

@@ -1,5 +1,4 @@
-import { baseEngineName, checkOf, engineArguments, isTable, splitTop } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { baseEngineName, checkOf, engineArguments, splitTop, tablesOf } from "./clickhouse-helpers";
 
 /** The engine arguments that name columns, by base engine. */
 function columnArguments(engine: string, args: string[]): string[] {
@@ -26,7 +25,7 @@ function columnArguments(engine: string, args: string[]): string[] {
  * sign, version, is_deleted and summed columns are columns of the table).
  */
 export const sqlch104 = checkOf({ id: "SQLCH104", description: "A MergeTree engine argument names a column the table does not declare" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     if (!t.engine || t.columns.length === 0) continue;
     const declared = new Set(t.columns.map((c) => c.name));
     for (const arg of columnArguments(baseEngineName(t.engine), engineArguments(t.engine))) {

package/dist/rules/sqlch105.ts

@@ -1,5 +1,4 @@
-import { bareName, checkOf, isTable, keyElements } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { bareName, checkOf, keyElements, tablesOf } from "./clickhouse-helpers";
 
 /**
  * SQLCH105: ORDER BY, PRIMARY KEY, PARTITION BY or SAMPLE BY lists a bare
@@ -10,7 +9,7 @@ import { clickhouseObjects } from "./sql-helpers";
  * judged; an expression is left to the server.
  */
 export const sqlch105 = checkOf({ id: "SQLCH105", description: "A table key clause names a column the table does not declare" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     if (t.columns.length === 0) continue;
     const declared = new Set(t.columns.map((c) => c.name));
     const clauses: Array<[string, string | undefined]> = [

package/dist/rules/sqlch106.ts

@@ -1,5 +1,4 @@
-import { checkOf, isTable, mentionedNames } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, mentionedNames, tablesOf } from "./clickhouse-helpers";
 
 /**
  * SQLCH106: a data skipping index expression mentions a column the table does
@@ -11,7 +10,7 @@ import { clickhouseObjects } from "./sql-helpers";
  * SQL parser would guess.
  */
 export const sqlch106 = checkOf({ id: "SQLCH106", description: "A skip index expression names a column the table does not declare" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     if (t.columns.length === 0) continue;
     const declared = new Set(t.columns.map((c) => c.name));
     for (const index of t.indexes ?? []) {

package/dist/rules/sqlch107.ts

@@ -1,5 +1,4 @@
-import { bareName, checkOf, isTable, splitTop, typeFamily } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { bareName, checkOf, splitTop, tablesOf, typeFamily } from "./clickhouse-helpers";
 
 const DATE_TYPES = new Set(["Date", "Date32", "DateTime", "DateTime64"]);
 const TTL_ACTION = /\s+(DELETE|TO\s+DISK|TO\s+VOLUME|RECOMPRESS|GROUP\s+BY|WHERE)\b[\s\S]*$/i;
@@ -13,7 +12,7 @@ const TTL_ACTION = /\s+(DELETE|TO\s+DISK|TO\s+VOLUME|RECOMPRESS|GROUP\s+BY|WHERE
  * a function call is left to the server.
  */
 export const sqlch107 = checkOf({ id: "SQLCH107", description: "A TTL expression is built on a column that is not a Date or DateTime" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     const ttls: Array<{ where: string; expr: string }> = [];
     if (t.ttl) for (const clause of splitTop(t.ttl)) ttls.push({ where: "table TTL", expr: clause.replace(TTL_ACTION, "") });
     for (const c of t.columns) if (c.ttl) ttls.push({ where: `column ${c.name} TTL`, expr: c.ttl.replace(TTL_ACTION, "") });

package/dist/rules/sqlch111.ts

@@ -1,5 +1,4 @@
-import { checkOf, isTable, splitTop } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, splitTop, tablesOf } from "./clickhouse-helpers";
 
 const MAX_VALUES = 100;
 
@@ -23,7 +22,7 @@ function allowedValues(expr: string): { column: string; count: number } | undefi
  * https://clickhouse.com/docs/best-practices/select-data-types.
  */
 export const sqlch111 = checkOf({ id: "SQLCH111", description: "A String column limited to a few values is not LowCardinality" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     for (const c of t.constraints ?? []) {
       if (c.kind !== "CHECK") continue;
       const found = allowedValues(c.expr);

package/dist/rules/sqlch112.ts

@@ -1,5 +1,4 @@
-import { checkOf, isTable, typeFamily } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, tablesOf, typeFamily } from "./clickhouse-helpers";
 
 const FINE_FUNCTIONS =
   /\b(toStartOfSecond|toStartOfMinute|toStartOfFiveMinutes?|toStartOfTenMinutes|toStartOfFifteenMinutes|toStartOfHour|toRelativeSecondNum|toRelativeMinuteNum|toRelativeHourNum|toUnixTimestamp|toYYYYMMDDhhmmss|toStartOfInterval)\s*\(/;
@@ -15,7 +14,7 @@ const FINE_FUNCTIONS =
  * the sub-day truncation functions.
  */
 export const sqlch112 = checkOf({ id: "SQLCH112", description: "A PARTITION BY expression is finer than a day" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     const expr = t.partitionBy?.trim();
     if (!expr) continue;
     const col = t.columns.find((c) => c.name === expr.replace(/^\(|\)$/g, "").trim());

package/dist/rules/sqlch113.ts

@@ -1,5 +1,4 @@
-import { checkOf, isMergeTree, isTable } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, isMergeTree, tablesOf } from "./clickhouse-helpers";
 
 /**
  * SQLCH113: a MergeTree table with neither ORDER BY nor PRIMARY KEY.
@@ -9,7 +8,7 @@ import { clickhouseObjects } from "./sql-helpers";
  * `ORDER BY tuple()` to have none). The server refuses the CREATE.
  */
 export const sqlch113 = checkOf({ id: "SQLCH113", description: "A MergeTree table declares no sort key" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     if (!isMergeTree(t.engine) || t.orderBy || t.primaryKey) continue;
     report({
       severity: "error",

package/dist/rules/sqlch114.ts

@@ -1,6 +1,5 @@
 import { CODECS } from "../../generated/clickhouse";
-import { checkOf, codecNames, isTable } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, codecNames, tablesOf } from "./clickhouse-helpers";
 
 /**
  * SQLCH114: a column CODEC names a codec the pinned server does not have.
@@ -10,7 +9,7 @@ import { clickhouseObjects } from "./sql-helpers";
  */
 export const sqlch114 = checkOf({ id: "SQLCH114", description: "A column codec is not one the pinned server has" }, (ctx, report) => {
   const known = new Set(Object.keys(CODECS).map((n) => n.toLowerCase()));
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     for (const c of t.columns) {
       if (!c.codec) continue;
       for (const name of codecNames(c.codec)) {

package/dist/rules/sqlch115.ts

@@ -1,6 +1,5 @@
 import { CODECS } from "../../generated/clickhouse";
-import { checkOf, codecNames, isTable } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, codecNames, tablesOf } from "./clickhouse-helpers";
 
 const SENSITIVE = /(^|_)(password|passwd|pwd|secret|api_?key|access_?key|private_?key|token|ssn|social_?security|credit_?card|card_?number|iban)(_|$)/i;
 
@@ -17,7 +16,7 @@ const SENSITIVE = /(^|_)(password|passwd|pwd|secret|api_?key|access_?key|private
  */
 export const sqlch115 = checkOf({ id: "SQLCH115", description: "A secret- or PII-named column carries no comment, TTL or encryption" }, (ctx, report) => {
   const encryption = new Set(Object.entries(CODECS).filter(([, s]) => s.encryption).map(([n]) => n.toLowerCase()));
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     for (const c of t.columns) {
       if (!SENSITIVE.test(c.name) || c.comment || c.ttl || t.ttl) continue;
       if (c.codec && codecNames(c.codec).some((n) => encryption.has(n.toLowerCase()))) continue;

package/dist/rules/sqlch120.ts

@@ -1,5 +1,4 @@
-import { checkOf, isTable } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, tablesOf } from "./clickhouse-helpers";
 
 /**
  * SQLCH120: a MergeTree engine written with the legacy positional arguments.
@@ -10,7 +9,7 @@ import { clickhouseObjects } from "./sql-helpers";
  * syntax is a bare `MergeTree` with ORDER BY, PARTITION BY and SETTINGS.
  */
 export const sqlch120 = checkOf({ id: "SQLCH120", description: "A MergeTree engine uses the deprecated positional arguments" }, (ctx, report) => {
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     if (t.engine?.name !== "MergeTree" || (t.engine.args ?? []).length === 0) continue;
     report({
       severity: "warning",

package/dist/rules/sqlch125.ts

@@ -1,6 +1,5 @@
 import { CODECS, CLICKHOUSE_VERSION } from "../../generated/clickhouse";
-import { checkOf, isTable, splitTop } from "./clickhouse-helpers";
-import { clickhouseObjects } from "./sql-helpers";
+import { checkOf, splitTop, tablesOf } from "./clickhouse-helpers";
 
 type Param = { name: string; kind: string; optional?: boolean; range?: readonly [number, number]; values?: readonly string[] };
 
@@ -17,7 +16,7 @@ const NUMBER = /^-?\d+(\.\d+)?$/;
  */
 export const sqlch125 = checkOf({ id: "SQLCH125", description: "A codec parameter is outside what the codec takes" }, (ctx, report) => {
   const codecs = CODECS as Record<string, { parameters: readonly Param[] | "unknown" } | undefined>;
-  for (const t of clickhouseObjects(ctx).filter(isTable)) {
+  for (const t of tablesOf(ctx)) {
     for (const c of t.columns) {
       if (!c.codec) continue;
       for (const part of splitTop(c.codec)) {

package/dist/serializer.d.ts

@@ -25,11 +25,21 @@
  * targets (`sql.postgresMajor`, else the newest pinned major). Post-synth
  * checks and the lock classifier read it; ClickHouse output has no such field.
  *
+ * A clause chant's parser does not know (#3872) is kept in the statement as
+ * written and named in a build warning ({@link unparsedWarnings}).
+ *
  * Rule ids: `SQL` for rules that hold in every dialect, `SQLCH` for the
  * ClickHouse dialect's (#3199), `SQLPG` for Postgres's (#3289).
  */
-import type { Serializer } from "@intentius/chant";
+import type { Declarable, Serializer } from "@intentius/chant";
 export { applyOrder } from "./core/references.js";
+/**
+ * A warning for each clause chant's parser does not know (#3872): where it
+ * is (the `.sql` file and line, or the template's file and the line in its
+ * statement), which object, and what follows from it. The statement is sent
+ * as written; the server decides.
+ */
+export declare function unparsedWarnings(objects: ReadonlyMap<string, Declarable>): string[];
 /** The file the statements are written to, beside the primary output. */
 export declare const CLICKHOUSE_DDL_FILE = "clickhouse.sql";
 /** The Postgres statements' file, beside the primary output. */

package/dist/serializer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,EAAc,UAAU,EAAoB,MAAM,kBAAkB,CAAC;AASjF,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,yEAAyE;AACzE,eAAO,MAAM,mBAAmB,mBAAmB,CAAC;AAEpD,gEAAgE;AAChE,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAmEhD,eAAO,MAAM,aAAa,EAAE,UAuC3B,CAAC"}
+{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAoB,MAAM,kBAAkB,CAAC;AAYjF,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,MAAM,EAAE,CAkBnF;AAED,yEAAyE;AACzE,eAAO,MAAM,mBAAmB,mBAAmB,CAAC;AAEpD,gEAAgE;AAChE,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAqEhD,eAAO,MAAM,aAAa,EAAE,UAyC3B,CAAC"}

package/dist/sql-files.d.ts

@@ -18,7 +18,9 @@
  * `MATERIALIZED VIEW`, `DICTIONARY`, `FUNCTION`, `USER`, `ROLE` and `ROW
  * POLICY`, and `GRANT` (#3711). Any other statement, and any
  * statement that does not parse, throws a {@link SqlFileError} naming every
- * such statement: none is left out.
+ * such statement: none is left out. A statement that parses except for a
+ * clause the parser does not know (#3872) is read, kept as written, and the
+ * clause listed in its object's `unparsed` with the line it is on.
  *
  * A name is a reference where it is qualified (`app.users`), or bare where an
  * object is named (`REFERENCES users`, `FROM users`, an index's table, a
@@ -41,6 +43,18 @@ export interface SqlFileObject {
     ddl: string;
     /** The file it came from, the `origin` it was read under. */
     origin: string;
+    /** The line its statement starts on in the file, from 1. */
+    line?: number;
+    /**
+     * Clauses in it chant's parser does not know (#3872), each with the line
+     * it starts on: kept in `ddl` as written, for the server to check. Absent
+     * when there are none.
+     */
+    unparsed?: Array<{
+        clause: string;
+        line: number;
+        column?: string;
+    }>;
 }
 /** A file to read: its DDL and the name errors give it. */
 export interface SqlFileSource extends ReadOptions {
@@ -60,6 +74,8 @@ export declare function sqlFileDeclarations(dialect: SqlDialect, ddl: string, op
 };
 /** Where an entity read from a `.sql` file came from: its `origin`. Undefined for any other entity. */
 export declare function sqlFileOf(entity: unknown): string | undefined;
+/** The line an entity read from a `.sql` file starts on in it. Undefined for any other entity. */
+export declare function sqlFileLineOf(entity: unknown): number | undefined;
 /**
  * The declarations the files make, by export name. `known` holds the
  * entities declared elsewhere (the project's tagged templates): a file's

package/dist/sql-files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sql-files.d.ts","sourceRoot":"","sources":["../src/sql-files.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAUhE,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,YAAY,EAAE,WAAW,IAAI,cAAc,EAAE,CAAC;AAE9C,yCAAyC;AACzC,MAAM,WAAW,aAAa;IAC5B,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,+GAA+G;IAC/G,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,2DAA2D;AAC3D,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,GAAG,EAAE,MAAM,CAAC;CACb;AAuBD,8GAA8G;AAC9G,wBAAgB,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,CAInG;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,aAAa,EAAE,CAAA;CAAE,CAW/J;AAED,uGAAuG;AACvG,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAE7D;AA4BD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,aAAa,EAAE,EAAE,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;CAAO,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAqD1K;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAatH"}
+{"version":3,"file":"sql-files.d.ts","sourceRoot":"","sources":["../src/sql-files.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAiB,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAU/E,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,YAAY,EAAE,WAAW,IAAI,cAAc,EAAE,CAAC;AAE9C,yCAAyC;AACzC,MAAM,WAAW,aAAa;IAC5B,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,+GAA+G;IAC/G,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrE;AAED,2DAA2D;AAC3D,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,GAAG,EAAE,MAAM,CAAC;CACb;AA0BD,8GAA8G;AAC9G,wBAAgB,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,CAInG;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,aAAa,EAAE,CAAA;CAAE,CAW/J;AAED,uGAAuG;AACvG,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAE7D;AAED,kGAAkG;AAClG,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAEjE;AA6BD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,aAAa,EAAE,EAAE,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;CAAO,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAuD1K;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAatH"}

package/dist/sql-types.d.ts

@@ -22,6 +22,9 @@
  *   (`./lint/post-synth/postgres-names.ts`'s `typeIdentity`), the type
  *   family in ClickHouse; `never` when it cannot be told.
  *
+ * A column that carries a clause chant does not read (#3872) keeps the type
+ * that was read, with `nullable` and `cmp` `never`.
+ *
  * A view's column that is one column reference (`${t.columns.c}`, `o.${t.columns.c}`)
  * is that column's type; any other expression is `unknown`.
  */

package/dist/sql-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sql-types.d.ts","sourceRoot":"","sources":["../src/sql-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAIH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAW9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAQ7C,4EAA4E;AAC5E,eAAO,MAAM,cAAc,mBAAmB,CAAC;AAE/C;;;GAGG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,MAAM,CAGpG;AAED,kGAAkG;AAClG,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,EACzC,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,qBAA0B,GAC/B,SAAS,GAAG,OAAO,GAAG,SAAS,CASjC;AAED,6DAA6D;AAC7D,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAGjE,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,yGAAyG;IACzG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yGAAyG;IACzG,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAiOD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,GAAE,qBAA0B,GAAG,MAAM,CAiClH"}
+{"version":3,"file":"sql-types.d.ts","sourceRoot":"","sources":["../src/sql-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAIH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAW9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAQ7C,4EAA4E;AAC5E,eAAO,MAAM,cAAc,mBAAmB,CAAC;AAE/C;;;GAGG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,MAAM,CAGpG;AAED,kGAAkG;AAClG,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,EACzC,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,qBAA0B,GAC/B,SAAS,GAAG,OAAO,GAAG,SAAS,CASjC;AAED,6DAA6D;AAC7D,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAGjE,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,yGAAyG;IACzG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yGAAyG;IACzG,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AA+OD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,GAAE,qBAA0B,GAAG,MAAM,CAiClH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-sql",
-  "version": "0.124.12",
+  "version": "0.124.14",
   "description": "SQL lexicon for chant — database schema as typed declarations, one dialect at a time; ClickHouse first, with types read from a pinned server's catalog",
   "license": "Apache-2.0",
   "homepage": "https://intentius.io/chant",
@@ -70,6 +70,6 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.124.12"
+    "@intentius/chant": "^0.124.14"
   }
 }

package/src/clickhouse/apply/statements.ts

@@ -187,6 +187,8 @@ export function refusalDetail(changes: readonly Change[], key?: string, type?: s
     type === undefined || type === CLICKHOUSE_ENTITY_TYPES.table
       ? `Run it as the rebuild migration Op: ClickHouseRebuildOp({ table: ${JSON.stringify(key ?? "<database.table>")}, ... }) from @intentius/chant-lexicon-sql/clickhouse`
       : "The rebuild migration Op rebuilds tables only; drop and create this object instead";
+  // A clause chant does not read (#3872) is refused for review: whether ALTER can make it is not known.
+  if (changes.every((c) => c.rule === "SQLCH290")) return `needs review, since chant does not read the clause: ${parts.join("; ")}`;
   return `needs a rebuild, which ALTER cannot make: ${parts.join("; ")}. ${instead}`;
 }
 

package/src/clickhouse/entities.ts

@@ -42,7 +42,7 @@ import { setInterpolationFields } from "@intentius/chant/provenance";
 import { CLICKHOUSE_LEXICAL, isTrivia, SqlSyntaxError, untokenize } from "./tokens";
 import { parseCreate, unquote, type ColumnNode, type CreateNode, type Span, type StorageNode } from "./parser";
 import { parseAccess, type AccessNode } from "./access";
-import { feed, lineage, spanText as text, splice as spliceWith, templateSyntaxError, type TemplateCtx, type TemplateDialect } from "../core/interpolation";
+import { feed, lineage, spanText as text, splice as spliceWith, templateSyntaxError, unparsedClauses, type TemplateCtx, type TemplateDialect, type UnparsedClause } from "../core/interpolation";
 import { SQL_LEXICON, SqlObject, isColumnRefOf, isSqlObjectOf, makeSqlEntity } from "../core/entity";
 import type { LineageEdge } from "../core/references";
 import { SqlLiteral, SqlTemplateError, describeValue as describe, stripUnset as strip, templateParts } from "../core/template";
@@ -50,6 +50,7 @@ import { setTypedSlots, type ColumnsIn, type Named, type RowIn, type SlotsIn, ty
 
 export { SQL_LEXICON } from "../core/entity";
 export type { LineageEdge } from "../core/references";
+export type { UnparsedClause } from "../core/interpolation";
 export { SqlLiteral, SqlTemplateError, templateParts, unescapeTemplateDelimiters } from "../core/template";
 export type { AnyColumn, Column, ColumnTraits, KeyColumn, Named, NotNullColumn, UncheckedColumn, Unnamed } from "../core/typed";
 
@@ -110,6 +111,11 @@ interface CommonProps {
   ddl: string;
   /** The template's raw parts, as written, for a source round trip. */
   source: { strings: string[] };
+  /**
+   * Clauses chant's parser does not know (#3872), kept in `ddl` as written
+   * and left to the catalog checks and the server. Absent when there are none.
+   */
+  unparsed?: UnparsedClause[];
 }
 
 export interface DatabaseProps extends CommonProps {
@@ -540,6 +546,7 @@ function build(tag: Expect, strings: TemplateStringsArray | readonly string[], v
     database,
     onCluster: text(ctx, node.onCluster, "onCluster"),
     comment: stringValue(text(ctx, node.comment, "comment")),
+    unparsed: unparsedClauses(ctx, node.unknown),
   };
   const done = <T extends ClickHouseObject>(entity: T): T => {
     setInterpolationFields(entity, ctx.fed.map((paths) => [...paths].sort()));