@intentius/chant-lexicon-sql 0.124.46 → 0.124.49

package/dist/codegen/clickhouse-module.js

@@ -236,6 +236,9 @@ export function renderClickHouseModule(catalog) {
         `/** The table functions (\`system.table_functions\`): \`numbers\`, \`remote\`, \`s3\`. */`,
         `export const TABLE_FUNCTIONS: readonly string[] = ${JSON.stringify(catalog.tableFunctions)};`,
         "",
+        `/** The input and output formats (\`system.formats\`): \`Parquet\`, \`JSONEachRow\`. */`,
+        `export const FORMATS: readonly string[] = ${JSON.stringify(catalog.formats.map((f) => f.name))};`,
+        "",
         `export const SKIP_INDEX_TYPES: Readonly<Record<SkipIndexType, SkipIndexSpec>> = {`,
         ...indexLines,
         "};",

package/dist/codegen/coverage-page.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coverage-page.d.ts","sourceRoot":"","sources":["../../src/codegen/coverage-page.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA4BH,wBAAgB,kBAAkB,IAAI,MAAM,CA4C3C"}
+{"version":3,"file":"coverage-page.d.ts","sourceRoot":"","sources":["../../src/codegen/coverage-page.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA6BH,wBAAgB,kBAAkB,IAAI,MAAM,CA6C3C"}

package/dist/codegen/coverage-page.js

@@ -5,7 +5,7 @@
  */
 import { KIND_COVERAGE, PINNED_COMMANDS } from "../coverage.js";
 const cell = (s) => s.replace(/\|/g, "\\|").replace(/[{}<>]/g, (c) => `\\${c}`);
-const STATUS = { declared: "declared", refused: "refused", "out-of-scope": "out of scope" };
+const STATUS = { declared: "declared", referenced: "referenced", refused: "refused", "out-of-scope": "out of scope" };
 function table(dialect) {
     const rows = [...KIND_COVERAGE[dialect]].sort((a, b) => (a.command < b.command ? -1 : a.command > b.command ? 1 : 0));
     return [
@@ -21,7 +21,8 @@ function table(dialect) {
 function counts(dialect) {
     const rows = KIND_COVERAGE[dialect];
     const n = (s) => rows.filter((r) => r.status === s).length;
-    return `${n("declared")} declared, ${n("refused")} refused, ${n("out-of-scope")} out of scope`;
+    const referenced = n("referenced") > 0 ? `, ${n("referenced")} referenced` : "";
+    return `${n("declared")} declared${referenced}, ${n("refused")} refused, ${n("out-of-scope")} out of scope`;
 }
 export function renderCoveragePage() {
     const pg = PINNED_COMMANDS.postgres.map((p) => p.version).join(", ");
@@ -29,7 +30,7 @@ export function renderCoveragePage() {
     return `---
 title: "Object Coverage"
 label: "Object Coverage"
-description: "Every kind of object each pinned Postgres and ClickHouse server can create, marked declared, refused with a reason, or out of scope, and what import does with each"
+description: "Every kind of object each pinned Postgres and ClickHouse server can create, marked declared, referenced, refused with a reason, or out of scope, and what import does with each"
 diataxis: reference
 order: 3
 ---
@@ -39,6 +40,7 @@ order: 3
 Each row is a \`CREATE\` command a pinned server has, or one form of a command where chant treats the forms apart (\`CREATE TYPE ... AS ENUM\` is declared, \`CREATE TYPE ... AS RANGE\` is not). The commands come from the servers' own sources at each pinned version (\`scripts/sql-create-commands.ts\`), and a test fails when a pinned server has a command with no row here, so a new server release cannot add a kind nobody looked at.
 
 - **declared**: a tag declares it, and import writes it as that declaration.
+- **referenced**: the environment's, and never declared: a declaration names one, and chant never reads its values. A ClickHouse named collection is one ([#4395](https://github.com/INTENTIUS/chant/issues/4395)): \`ENGINE = S3(lake_creds, format = 'Parquet')\` names \`lake_creds\`, the build records the name, and \`chant sql plan\` fails when the server has no collection of that name. \`chant import --from <env>\` lists the server's SQL-defined collections as prerequisites and imports the rest. See [Named collections](../clickhouse-ddl/#named-collections).
 - **refused**: no declaration holds it yet. \`chant import --from <env>\` fails when the server has one, naming every such object (kind, schema, name) at once, and \`chant import schema.sql\` fails on the statement. Nothing is left out without a word.
 - **out of scope**: the environment's, not a schema's: import never reads it.
 

package/dist/codegen/docs.js

@@ -120,7 +120,7 @@ Postgres:
 - [Getting Started with Postgres](./postgres-getting-started/): declare a
   schema, apply it to a local server, add a column and an index, and see a
   rename refused.
-- [Declaring Postgres Objects](./postgres-ddl/): the eight tags,
+- [Declaring Postgres Objects](./postgres-ddl/): the tags for every schema-level kind,
   constraints, \`nextval(\${seq})\`, \`COMMENT ON\` and \`literal()\`.
 - [Importing a Postgres Server](./postgres-importing/): canonical text from
   the catalog's printers, and the objects that belong to someone else.

package/dist/codegen/postgres-classifier-page.js

@@ -60,14 +60,14 @@ A column rename or a type change across kinds is never DDL: it is a step naming
 
 ## Which major
 
-Two rules change class across the supported majors: a STORED generated column's expression (SQLPG212) is a rewrite from 17 and expand and contract before it, and a table's access method (SQLPG226) is a rewrite from 15 and expand and contract before it.
+Three rules change class across the supported majors: a STORED generated column's expression (SQLPG212) is a rewrite from 17 and expand and contract before it, a table's access method (SQLPG226) is a rewrite from 15 and expand and contract before it, and an operator's commutator, negator, HASHES and MERGES (SQLPG304) are altered in place from 17 and dropped and created before it.
 
 - \`chant sql diff\` classifies for the major the builds recorded (\`postgresMajor\` in the build output): the newer build's, else the older build's, else \`sql.postgresMajor\`, else 18. A diff between two revisions does not depend on today's config.
 - \`chant sql plan\` classifies for the major the server runs (\`server_version_num\`), since the server is what takes the locks. When the build targets another major, the plan says so in a hint.
 
 ## Identity and renames
 
-An object is identified by its export name between two builds, and by its schema-qualified name against a server, which has no export names. Tables, views, materialized views, sequences and indexes share one namespace per schema, types and domains another, and schemas and extensions are matched by name. Functions, procedures and aggregates share a namespace of their own and are told apart by their input parameter types, so an overload is another object; composite and range types share the types' namespace, collations have one of their own, a cast is named by its two types and an event trigger by its name in the database; a trigger is matched by its name on its table.
+An object is identified by its export name between two builds, and by its schema-qualified name against a server, which has no export names. Tables, foreign tables, views, materialized views, sequences and indexes share one namespace per schema, types and domains another, and schemas and extensions are matched by name. Functions, procedures and aggregates share a namespace of their own and are told apart by their input parameter types, so an overload is another object; composite and range types share the types' namespace, collations have one of their own, extended statistics another, an operator by its symbol and operand types, an operator class and an operator family each by its name and index method, text search configurations one namespace and dictionaries another, a cast by its two types and an event trigger, a foreign data wrapper, a foreign server and a publication by their names in the database; a trigger is matched by its name on its table.
 
 A rename is declared where it happens. Before a CREATE, \`-- previously: <old name>\` says the object had another name; on a column's line, it says the column did:
 

package/dist/codegen/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/codegen/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AA0CH,wBAAgB,aAAa,IAAI,MAAM,CAKtC"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/codegen/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAoDH,wBAAgB,aAAa,IAAI,MAAM,CAKtC"}

package/dist/codegen/registry.js

@@ -37,6 +37,16 @@ const KINDS = {
     PostgresCollation: POSTGRES_ENTITY_TYPES.collation,
     PostgresCast: POSTGRES_ENTITY_TYPES.cast,
     PostgresEventTrigger: POSTGRES_ENTITY_TYPES.eventTrigger,
+    PostgresOperator: POSTGRES_ENTITY_TYPES.operator,
+    PostgresOperatorClass: POSTGRES_ENTITY_TYPES.operatorClass,
+    PostgresOperatorFamily: POSTGRES_ENTITY_TYPES.operatorFamily,
+    PostgresForeignTable: POSTGRES_ENTITY_TYPES.foreignTable,
+    PostgresTextSearchConfiguration: POSTGRES_ENTITY_TYPES.textSearchConfiguration,
+    PostgresTextSearchDictionary: POSTGRES_ENTITY_TYPES.textSearchDictionary,
+    PostgresStatistics: POSTGRES_ENTITY_TYPES.statistics,
+    PostgresForeignDataWrapper: POSTGRES_ENTITY_TYPES.foreignDataWrapper,
+    PostgresForeignServer: POSTGRES_ENTITY_TYPES.foreignServer,
+    PostgresPublication: POSTGRES_ENTITY_TYPES.publication,
     PostgresExtension: POSTGRES_ENTITY_TYPES.extension,
     PostgresFunction: POSTGRES_ENTITY_TYPES.function,
     PostgresProcedure: POSTGRES_ENTITY_TYPES.procedure,

package/dist/composites/catalog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/composites/catalog.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,gBAAgB,EAAE,cAAc,EA2gB5C,CAAC"}
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/composites/catalog.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,gBAAgB,EAAE,cAAc,EA+mB5C,CAAC"}

package/dist/composites/catalog.js

@@ -210,6 +210,41 @@ export const compositeCatalog = [
             }
         ]
     },
+    {
+        "name": "OtelTables",
+        "lexicon": "sql",
+        "description": "The logs, traces and metrics tables the OpenTelemetry Collector's clickhouse exporter writes, as it creates them at v0.130.0.",
+        "bundles": [
+            "ClickHouseTable",
+            "ClickHouseView"
+        ],
+        "params": [
+            {
+                "name": "database",
+                "type": "string",
+                "required": false,
+                "description": "The database the tables are created in, the exporter's `database`."
+            },
+            {
+                "name": "ttl",
+                "type": "string",
+                "required": false,
+                "description": "How long rows are kept, as the exporter's `ttl` takes it: a Go duration such as `72h` or `30m`."
+            },
+            {
+                "name": "tables",
+                "type": "OtelTableNames",
+                "required": false,
+                "description": "Table names other than the exporter's defaults, as set on the exporter."
+            },
+            {
+                "name": "traceIdLookup",
+                "type": "boolean",
+                "required": false,
+                "description": "Declare the trace-id lookup table and its materialized view (default true)."
+            }
+        ]
+    },
     {
         "name": "RefreshedView",
         "lexicon": "sql",
@@ -468,6 +503,71 @@ export const compositeCatalog = [
             }
         ]
     },
+    {
+        "name": "StreamIngest",
+        "lexicon": "sql",
+        "description": "A stream table, the materialized view that reads it, and the MergeTree target the view writes.",
+        "bundles": [
+            "ClickHouseTable",
+            "ClickHouseView"
+        ],
+        "params": [
+            {
+                "name": "name",
+                "type": "string",
+                "required": true,
+                "description": "The target table's name."
+            },
+            {
+                "name": "columns",
+                "type": "string",
+                "required": true,
+                "description": "The target's columns, as SQL: `ts DateTime, user_id UInt64, kind LowCardinality(String)`."
+            },
+            {
+                "name": "engine",
+                "type": "string",
+                "required": true,
+                "description": "The stream table's engine, with a named collection as its first argument rather than inline credentials: `Kafka(kafka_creds)`, `S3Queue(lake_creds)`."
+            },
+            {
+                "name": "settings",
+                "type": "string",
+                "required": false,
+                "description": "The engine's settings, the body of a `SETTINGS` clause: `kafka_topic_list = 'events', kafka_group_name = 'ingest', kafka_format = 'JSONEachRow'`."
+            },
+            {
+                "name": "streamColumns",
+                "type": "string",
+                "required": false,
+                "description": "The stream table's columns when they differ from the target's: the message as it arrives."
+            },
+            {
+                "name": "select",
+                "type": "string",
+                "required": false,
+                "description": "The view's select list over the stream table, each item aliased to a target column."
+            },
+            {
+                "name": "orderBy",
+                "type": "string",
+                "required": true,
+                "description": "The target's sort key (a column list or an expression)."
+            },
+            {
+                "name": "targetEngine",
+                "type": "string",
+                "required": false,
+                "description": "The target's engine (default `MergeTree`)."
+            },
+            {
+                "name": "partitionBy",
+                "type": "string",
+                "required": false,
+                "description": "The target's partition key."
+            }
+        ]
+    },
     {
         "name": "TenantTable",
         "lexicon": "sql",

package/dist/composites/clickhouse.d.ts

@@ -4,4 +4,6 @@ export { EventsTable, type EventsTableProps, type EventsTableMembers } from "./e
 export { RollupView, type RollupViewProps, type RollupViewMembers } from "./rollup-view.js";
 export { CdcMirror, type CdcMirrorProps, type CdcMirrorMembers } from "./cdc-mirror.js";
 export { ShardedTable, type ShardedTableProps, type ShardedTableMembers } from "./sharded-table.js";
+export { OtelTables, OTEL_EXPORTER_DEFAULT_TABLES, otelTtlClause, type OtelTablesProps, type OtelTablesMembers, type OtelTableNames } from "./otel-tables.js";
+export { StreamIngest, type StreamIngestProps, type StreamIngestMembers } from "./stream-ingest.js";
 //# sourceMappingURL=clickhouse.d.ts.map

package/dist/composites/clickhouse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clickhouse.d.ts","sourceRoot":"","sources":["../../src/composites/clickhouse.ts"],"names":[],"mappings":"AAAA,wFAAwF;AAExF,OAAO,EAAE,cAAc,EAAE,KAAK,mBAAmB,EAAE,KAAK,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AACzG,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,KAAK,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACzF,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrF,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"clickhouse.d.ts","sourceRoot":"","sources":["../../src/composites/clickhouse.ts"],"names":[],"mappings":"AAAA,wFAAwF;AAExF,OAAO,EAAE,cAAc,EAAE,KAAK,mBAAmB,EAAE,KAAK,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AACzG,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,KAAK,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACzF,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrF,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACjG,OAAO,EAAE,UAAU,EAAE,4BAA4B,EAAE,aAAa,EAAE,KAAK,eAAe,EAAE,KAAK,iBAAiB,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAC3J,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/composites/clickhouse.js

@@ -4,3 +4,5 @@ export { EventsTable } from "./events-table.js";
 export { RollupView } from "./rollup-view.js";
 export { CdcMirror } from "./cdc-mirror.js";
 export { ShardedTable } from "./sharded-table.js";
+export { OtelTables, OTEL_EXPORTER_DEFAULT_TABLES, otelTtlClause } from "./otel-tables.js";
+export { StreamIngest } from "./stream-ingest.js";

package/dist/composites/otel-tables.d.ts

@@ -0,0 +1,100 @@
+/**
+ * `OtelTables`: the tables the OpenTelemetry Collector's `clickhouse` exporter writes, declared here so the exporter can run with `create_schema: false`.
+ *
+ * The DDL follows the exporter's own create statements at
+ * opentelemetry-collector-contrib v0.130.0, the otel lexicon's
+ * `COLLECTOR_PIN`, column for column:
+ *
+ * - `exporter/clickhouseexporter/internal/sqltemplates/logs_table.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/traces_table.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/traces_id_ts_lookup_table.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/traces_id_ts_lookup_mv.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/metrics_gauge_table.sql`,
+ *   `metrics_sum_table.sql`, `metrics_summary_table.sql`,
+ *   `metrics_histogram_table.sql` and `metrics_exp_histogram_table.sql`
+ *
+ * The table names default to the exporter's (`exporter/clickhouseexporter/config.go`,
+ * `createDefaultConfig`): `otel_logs`, `otel_traces` and `otel_metrics_<type>`.
+ * The exponential histogram table is `otel_metrics_exponential_histogram`:
+ * `defaultExpHistogramSuffix` in config.go is `_exponential_histogram`, though
+ * the README's option list says `otel_metrics_exp_histogram`. The code decides.
+ *
+ * With `create_schema: true` the exporter's traces exporter also creates a
+ * trace-id lookup table, `<traces>_trace_id_ts`, and a materialized view,
+ * `<traces>_trace_id_ts_mv`, that fills it from the traces table
+ * (`createTraceTables` in `exporter_traces.go`). The README's trace query
+ * reads the lookup table to bound a trace's time range. Both are declared
+ * here unless `traceIdLookup` is false.
+ *
+ * What differs from the exporter's DDL, none of it a column:
+ *
+ * - The engine is `MergeTree`, the exporter's default `table_engine`. A
+ *   replicated setup declares its own tables.
+ * - `IF NOT EXISTS` and `ON CLUSTER` are left out; the sql lexicon plans the
+ *   tables instead.
+ * - The metrics templates put `TTL` before `PARTITION BY`; here it follows
+ *   `ORDER BY`, as in the logs and traces templates. ClickHouse reads the
+ *   clauses the same in either order.
+ * - The exporter's JSON tables (`logs_json_table.sql`, `traces_json_table.sql`)
+ *   are used only behind the `clickhouse.json` feature gate (alpha, off by
+ *   default, `factory.go`) and are not declared.
+ *
+ * The database is not declared. Unqualified, the tables are created in the
+ * server's `default` database, which is the exporter's default `database`.
+ */
+import { type ClickHouseTable, type ClickHouseView } from "../clickhouse/entities.js";
+/** The table names the exporter writes, by its config key. Each defaults to the exporter's. */
+export interface OtelTableNames {
+    /** `logs_table_name` (default `otel_logs`). */
+    logs?: string;
+    /** `traces_table_name` (default `otel_traces`). */
+    traces?: string;
+    /** `metrics_tables.gauge.name` (default `otel_metrics_gauge`). */
+    gauge?: string;
+    /** `metrics_tables.sum.name` (default `otel_metrics_sum`). */
+    sum?: string;
+    /** `metrics_tables.summary.name` (default `otel_metrics_summary`). */
+    summary?: string;
+    /** `metrics_tables.histogram.name` (default `otel_metrics_histogram`). */
+    histogram?: string;
+    /** `metrics_tables.exponential_histogram.name` (default `otel_metrics_exponential_histogram`). */
+    exponentialHistogram?: string;
+}
+export interface OtelTablesProps {
+    /** The database the tables are created in, the exporter's `database`. Unset, the names are unqualified and land in `default`. */
+    database?: string;
+    /**
+     * How long rows are kept, as the exporter's `ttl` takes it: a Go duration
+     * such as `72h` or `30m`. Rendered the way the exporter renders it
+     * (`GenerateTTLExpr` in `internal/clickhouse.go`): whole days as
+     * `toIntervalDay`, else hours, minutes or seconds. Unset or zero, no TTL.
+     */
+    ttl?: string;
+    /** Table names other than the exporter's defaults, as set on the exporter. */
+    tables?: OtelTableNames;
+    /** Declare the trace-id lookup table and its materialized view (default true). */
+    traceIdLookup?: boolean;
+}
+export type OtelTablesMembers = {
+    logs: ClickHouseTable;
+    traces: ClickHouseTable;
+    /** `<traces>_trace_id_ts`, absent when `traceIdLookup` is false. */
+    traceIdTs?: ClickHouseTable;
+    /** `<traces>_trace_id_ts_mv`, absent when `traceIdLookup` is false. */
+    traceIdTsView?: ClickHouseView;
+    metricsGauge: ClickHouseTable;
+    metricsSum: ClickHouseTable;
+    metricsSummary: ClickHouseTable;
+    metricsHistogram: ClickHouseTable;
+    metricsExponentialHistogram: ClickHouseTable;
+};
+/** The exporter's default table names at v0.130.0 (`createDefaultConfig` in `config.go`). */
+export declare const OTEL_EXPORTER_DEFAULT_TABLES: Readonly<Required<OtelTableNames>>;
+/**
+ * The TTL clause the exporter writes for `ttl` over `timeField`, or "" for none
+ * (`GenerateTTLExpr` in `internal/clickhouse.go` at v0.130.0).
+ */
+export declare function otelTtlClause(ttl: string | undefined, timeField: string): string;
+/** The logs, traces and metrics tables the OpenTelemetry Collector's clickhouse exporter writes, as it creates them at v0.130.0. */
+export declare const OtelTables: import("@intentius/chant").CompositeDefinition<OtelTablesProps, OtelTablesMembers>;
+//# sourceMappingURL=otel-tables.d.ts.map

package/dist/composites/otel-tables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel-tables.d.ts","sourceRoot":"","sources":["../../src/composites/otel-tables.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAGH,OAAO,EAAe,KAAK,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAEhG,+FAA+F;AAC/F,MAAM,WAAW,cAAc;IAC7B,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kGAAkG;IAClG,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,iIAAiI;IACjI,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8EAA8E;IAC9E,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,eAAe,CAAC;IACxB,oEAAoE;IACpE,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,uEAAuE;IACvE,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,YAAY,EAAE,eAAe,CAAC;IAC9B,UAAU,EAAE,eAAe,CAAC;IAC5B,cAAc,EAAE,eAAe,CAAC;IAChC,gBAAgB,EAAE,eAAe,CAAC;IAClC,2BAA2B,EAAE,eAAe,CAAC;CAC9C,CAAC;AAEF,6FAA6F;AAC7F,eAAO,MAAM,4BAA4B,EAAE,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,CAQ1E,CAAC;AAgBH;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAQhF;AA+ED,oIAAoI;AACpI,eAAO,MAAM,UAAU,oFA6HP,CAAC"}

package/dist/composites/otel-tables.js

@@ -0,0 +1,282 @@
+/**
+ * `OtelTables`: the tables the OpenTelemetry Collector's `clickhouse` exporter writes, declared here so the exporter can run with `create_schema: false`.
+ *
+ * The DDL follows the exporter's own create statements at
+ * opentelemetry-collector-contrib v0.130.0, the otel lexicon's
+ * `COLLECTOR_PIN`, column for column:
+ *
+ * - `exporter/clickhouseexporter/internal/sqltemplates/logs_table.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/traces_table.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/traces_id_ts_lookup_table.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/traces_id_ts_lookup_mv.sql`
+ * - `exporter/clickhouseexporter/internal/sqltemplates/metrics_gauge_table.sql`,
+ *   `metrics_sum_table.sql`, `metrics_summary_table.sql`,
+ *   `metrics_histogram_table.sql` and `metrics_exp_histogram_table.sql`
+ *
+ * The table names default to the exporter's (`exporter/clickhouseexporter/config.go`,
+ * `createDefaultConfig`): `otel_logs`, `otel_traces` and `otel_metrics_<type>`.
+ * The exponential histogram table is `otel_metrics_exponential_histogram`:
+ * `defaultExpHistogramSuffix` in config.go is `_exponential_histogram`, though
+ * the README's option list says `otel_metrics_exp_histogram`. The code decides.
+ *
+ * With `create_schema: true` the exporter's traces exporter also creates a
+ * trace-id lookup table, `<traces>_trace_id_ts`, and a materialized view,
+ * `<traces>_trace_id_ts_mv`, that fills it from the traces table
+ * (`createTraceTables` in `exporter_traces.go`). The README's trace query
+ * reads the lookup table to bound a trace's time range. Both are declared
+ * here unless `traceIdLookup` is false.
+ *
+ * What differs from the exporter's DDL, none of it a column:
+ *
+ * - The engine is `MergeTree`, the exporter's default `table_engine`. A
+ *   replicated setup declares its own tables.
+ * - `IF NOT EXISTS` and `ON CLUSTER` are left out; the sql lexicon plans the
+ *   tables instead.
+ * - The metrics templates put `TTL` before `PARTITION BY`; here it follows
+ *   `ORDER BY`, as in the logs and traces templates. ClickHouse reads the
+ *   clauses the same in either order.
+ * - The exporter's JSON tables (`logs_json_table.sql`, `traces_json_table.sql`)
+ *   are used only behind the `clickhouse.json` feature gate (alpha, off by
+ *   default, `factory.go`) and are not declared.
+ *
+ * The database is not declared. Unqualified, the tables are created in the
+ * server's `default` database, which is the exporter's default `database`.
+ */
+import { Composite } from "@intentius/chant/composite";
+import { table, view } from "../clickhouse/entities.js";
+/** The exporter's default table names at v0.130.0 (`createDefaultConfig` in `config.go`). */
+export const OTEL_EXPORTER_DEFAULT_TABLES = Object.freeze({
+    logs: "otel_logs",
+    traces: "otel_traces",
+    gauge: "otel_metrics_gauge",
+    sum: "otel_metrics_sum",
+    summary: "otel_metrics_summary",
+    histogram: "otel_metrics_histogram",
+    exponentialHistogram: "otel_metrics_exponential_histogram",
+});
+const GO_UNITS_S = { ns: 1e-9, us: 1e-6, "µs": 1e-6, "μs": 1e-6, ms: 1e-3, s: 1, m: 60, h: 3600 };
+/** A Go duration in whole seconds, or an error naming the value. Go's `time.ParseDuration` has no day unit. */
+function goDurationSeconds(d) {
+    const text = d.trim();
+    if (/^0$/.test(text))
+        return 0;
+    if (!/^((\d+(\.\d*)?|\.\d+)(ns|us|µs|μs|ms|s|m|h))+$/.test(text)) {
+        throw new Error(`OtelTables: ttl ${JSON.stringify(d)} is not a Go duration such as 72h or 30m`);
+    }
+    let total = 0;
+    for (const part of text.matchAll(/(\d+(?:\.\d*)?|\.\d+)(ns|us|µs|μs|ms|s|m|h)/g))
+        total += Number(part[1]) * GO_UNITS_S[part[2]];
+    return Math.floor(total);
+}
+/**
+ * The TTL clause the exporter writes for `ttl` over `timeField`, or "" for none
+ * (`GenerateTTLExpr` in `internal/clickhouse.go` at v0.130.0).
+ */
+export function otelTtlClause(ttl, timeField) {
+    if (ttl === undefined)
+        return "";
+    const s = goDurationSeconds(ttl);
+    if (s <= 0)
+        return "";
+    if (s % 86400 === 0)
+        return `TTL ${timeField} + toIntervalDay(${s / 86400})`;
+    if (s % 3600 === 0)
+        return `TTL ${timeField} + toIntervalHour(${s / 3600})`;
+    if (s % 60 === 0)
+        return `TTL ${timeField} + toIntervalMinute(${s / 60})`;
+    return `TTL ${timeField} + toIntervalSecond(${s})`;
+}
+// The column lists of the exporter's create statements, as written there.
+const METRIC_HEAD = `
+    ResourceAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+    ResourceSchemaUrl String CODEC(ZSTD(1)),
+    ScopeName String CODEC(ZSTD(1)),
+    ScopeVersion String CODEC(ZSTD(1)),
+    ScopeAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+    ScopeDroppedAttrCount UInt32 CODEC(ZSTD(1)),
+    ScopeSchemaUrl String CODEC(ZSTD(1)),
+    ServiceName LowCardinality(String) CODEC(ZSTD(1)),
+    MetricName String CODEC(ZSTD(1)),
+    MetricDescription String CODEC(ZSTD(1)),
+    MetricUnit String CODEC(ZSTD(1)),
+    Attributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+    StartTimeUnix DateTime64(9) CODEC(Delta, ZSTD(1)),
+    TimeUnix DateTime64(9) CODEC(Delta, ZSTD(1)),`;
+const EXEMPLARS = `
+    Exemplars Nested (
+      FilteredAttributes Map(LowCardinality(String), String),
+      TimeUnix DateTime64(9),
+      Value Float64,
+      SpanId String,
+      TraceId String
+    ) CODEC(ZSTD(1)),`;
+const METRIC_INDEXES = `
+    INDEX idx_res_attr_key mapKeys(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+    INDEX idx_res_attr_value mapValues(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+    INDEX idx_scope_attr_key mapKeys(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+    INDEX idx_scope_attr_value mapValues(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+    INDEX idx_attr_key mapKeys(Attributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+    INDEX idx_attr_value mapValues(Attributes) TYPE bloom_filter(0.01) GRANULARITY 1`;
+/** The columns each metric table adds between the shared head and the indexes. */
+const METRIC_BODIES = {
+    gauge: `
+    Value Float64 CODEC(ZSTD(1)),
+    Flags UInt32 CODEC(ZSTD(1)),${EXEMPLARS}`,
+    sum: `
+    Value Float64 CODEC(ZSTD(1)),
+    Flags UInt32 CODEC(ZSTD(1)),${EXEMPLARS}
+    AggregationTemporality Int32 CODEC(ZSTD(1)),
+    IsMonotonic Boolean CODEC(Delta, ZSTD(1)),`,
+    summary: `
+    Count UInt64 CODEC(Delta, ZSTD(1)),
+    Sum Float64 CODEC(ZSTD(1)),
+    ValueAtQuantiles Nested (
+      Quantile Float64,
+      Value Float64
+    ) CODEC(ZSTD(1)),
+    Flags UInt32 CODEC(ZSTD(1)),`,
+    histogram: `
+    Count UInt64 CODEC(Delta, ZSTD(1)),
+    Sum Float64 CODEC(ZSTD(1)),
+    BucketCounts Array(UInt64) CODEC(ZSTD(1)),
+    ExplicitBounds Array(Float64) CODEC(ZSTD(1)),${EXEMPLARS}
+    Flags UInt32 CODEC(ZSTD(1)),
+    Min Float64 CODEC(ZSTD(1)),
+    Max Float64 CODEC(ZSTD(1)),
+    AggregationTemporality Int32 CODEC(ZSTD(1)),`,
+    exponentialHistogram: `
+    Count UInt64 CODEC(Delta, ZSTD(1)),
+    Sum Float64 CODEC(ZSTD(1)),
+    Scale Int32 CODEC(ZSTD(1)),
+    ZeroCount UInt64 CODEC(ZSTD(1)),
+    PositiveOffset Int32 CODEC(ZSTD(1)),
+    PositiveBucketCounts Array(UInt64) CODEC(ZSTD(1)),
+    NegativeOffset Int32 CODEC(ZSTD(1)),
+    NegativeBucketCounts Array(UInt64) CODEC(ZSTD(1)),${EXEMPLARS}
+    Flags UInt32 CODEC(ZSTD(1)),
+    Min Float64 CODEC(ZSTD(1)),
+    Max Float64 CODEC(ZSTD(1)),
+    AggregationTemporality Int32 CODEC(ZSTD(1)),`,
+};
+/** The logs, traces and metrics tables the OpenTelemetry Collector's clickhouse exporter writes, as it creates them at v0.130.0. */
+export const OtelTables = Composite((props) => {
+    const names = { ...OTEL_EXPORTER_DEFAULT_TABLES, ...props.tables };
+    const q = (name) => (props.database ? `${props.database}.${name}` : name);
+    const ttl = (field) => otelTtlClause(props.ttl, field);
+    const logs = table `
+    CREATE TABLE ${q(names.logs)} (
+      Timestamp DateTime64(9) CODEC(Delta(8), ZSTD(1)),
+      TimestampTime DateTime DEFAULT toDateTime(Timestamp),
+      TraceId String CODEC(ZSTD(1)),
+      SpanId String CODEC(ZSTD(1)),
+      TraceFlags UInt8,
+      SeverityText LowCardinality(String) CODEC(ZSTD(1)),
+      SeverityNumber UInt8,
+      ServiceName LowCardinality(String) CODEC(ZSTD(1)),
+      Body String CODEC(ZSTD(1)),
+      ResourceSchemaUrl LowCardinality(String) CODEC(ZSTD(1)),
+      ResourceAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+      ScopeSchemaUrl LowCardinality(String) CODEC(ZSTD(1)),
+      ScopeName String CODEC(ZSTD(1)),
+      ScopeVersion LowCardinality(String) CODEC(ZSTD(1)),
+      ScopeAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+      LogAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+      INDEX idx_trace_id TraceId TYPE bloom_filter(0.001) GRANULARITY 1,
+      INDEX idx_res_attr_key mapKeys(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_res_attr_value mapValues(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_scope_attr_key mapKeys(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_scope_attr_value mapValues(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_log_attr_key mapKeys(LogAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_log_attr_value mapValues(LogAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_body Body TYPE tokenbf_v1(32768, 3, 0) GRANULARITY 8
+    )
+    ENGINE = MergeTree
+    PARTITION BY toDate(TimestampTime)
+    PRIMARY KEY (ServiceName, TimestampTime)
+    ORDER BY (ServiceName, TimestampTime, Timestamp)
+    ${ttl("TimestampTime")}
+    SETTINGS index_granularity = 8192, ttl_only_drop_parts = 1`;
+    const traces = table `
+    CREATE TABLE ${q(names.traces)} (
+      Timestamp DateTime64(9) CODEC(Delta, ZSTD(1)),
+      TraceId String CODEC(ZSTD(1)),
+      SpanId String CODEC(ZSTD(1)),
+      ParentSpanId String CODEC(ZSTD(1)),
+      TraceState String CODEC(ZSTD(1)),
+      SpanName LowCardinality(String) CODEC(ZSTD(1)),
+      SpanKind LowCardinality(String) CODEC(ZSTD(1)),
+      ServiceName LowCardinality(String) CODEC(ZSTD(1)),
+      ResourceAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+      ScopeName String CODEC(ZSTD(1)),
+      ScopeVersion String CODEC(ZSTD(1)),
+      SpanAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)),
+      Duration UInt64 CODEC(ZSTD(1)),
+      StatusCode LowCardinality(String) CODEC(ZSTD(1)),
+      StatusMessage String CODEC(ZSTD(1)),
+      Events Nested (
+        Timestamp DateTime64(9),
+        Name LowCardinality(String),
+        Attributes Map(LowCardinality(String), String)
+      ) CODEC(ZSTD(1)),
+      Links Nested (
+        TraceId String,
+        SpanId String,
+        TraceState String,
+        Attributes Map(LowCardinality(String), String)
+      ) CODEC(ZSTD(1)),
+      INDEX idx_trace_id TraceId TYPE bloom_filter(0.001) GRANULARITY 1,
+      INDEX idx_res_attr_key mapKeys(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_res_attr_value mapValues(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_span_attr_key mapKeys(SpanAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_span_attr_value mapValues(SpanAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
+      INDEX idx_duration Duration TYPE minmax GRANULARITY 1
+    )
+    ENGINE = MergeTree
+    PARTITION BY toDate(Timestamp)
+    ORDER BY (ServiceName, SpanName, toDateTime(Timestamp))
+    ${ttl("toDateTime(Timestamp)")}
+    SETTINGS index_granularity = 8192, ttl_only_drop_parts = 1`;
+    const metric = (name, body) => table `
+    CREATE TABLE ${q(name)} (${METRIC_HEAD}${body}${METRIC_INDEXES}
+    )
+    ENGINE = MergeTree
+    PARTITION BY toDate(TimeUnix)
+    ORDER BY (ServiceName, MetricName, Attributes, toUnixTimestamp64Nano(TimeUnix))
+    ${ttl("toDateTime(TimeUnix)")}
+    SETTINGS index_granularity = 8192, ttl_only_drop_parts = 1`;
+    const members = {
+        logs,
+        traces,
+        metricsGauge: metric(names.gauge, METRIC_BODIES.gauge),
+        metricsSum: metric(names.sum, METRIC_BODIES.sum),
+        metricsSummary: metric(names.summary, METRIC_BODIES.summary),
+        metricsHistogram: metric(names.histogram, METRIC_BODIES.histogram),
+        metricsExponentialHistogram: metric(names.exponentialHistogram, METRIC_BODIES.exponentialHistogram),
+    };
+    if (props.traceIdLookup !== false) {
+        const traceIdTs = table `
+      CREATE TABLE ${q(`${names.traces}_trace_id_ts`)} (
+        TraceId String CODEC(ZSTD(1)),
+        Start DateTime CODEC(Delta, ZSTD(1)),
+        End DateTime CODEC(Delta, ZSTD(1)),
+        INDEX idx_trace_id TraceId TYPE bloom_filter(0.01) GRANULARITY 1
+      )
+      ENGINE = MergeTree
+      PARTITION BY toDate(Start)
+      ORDER BY (TraceId, Start)
+      ${ttl("toDateTime(Start)")}
+      SETTINGS index_granularity = 8192, ttl_only_drop_parts = 1`;
+        const traceIdTsView = view `
+      CREATE MATERIALIZED VIEW ${q(`${names.traces}_trace_id_ts_mv`)} TO ${traceIdTs} AS
+      SELECT
+        TraceId,
+        min(Timestamp) AS Start,
+        max(Timestamp) AS End
+      FROM ${traces}
+      WHERE TraceId != ''
+      GROUP BY TraceId`;
+        members.traceIdTs = traceIdTs;
+        members.traceIdTsView = traceIdTsView;
+    }
+    return members;
+}, "OtelTables");