2026-05-13 13:01:56 +02:00
|
|
|
import { readFile } from 'node:fs/promises';
|
2026-05-10 23:51:24 +02:00
|
|
|
import { createDefaultLocalQueryExecutor, type KtxSqlQueryExecutorPort } from '@ktx/context/connections';
|
2026-05-13 13:01:56 +02:00
|
|
|
import {
|
|
|
|
|
createLocalKtxEmbeddingProviderFromConfig,
|
|
|
|
|
KtxIngestEmbeddingPortAdapter,
|
|
|
|
|
type KtxEmbeddingPort,
|
|
|
|
|
} from '@ktx/context';
|
2026-05-11 15:50:34 +02:00
|
|
|
import type { KtxSemanticLayerComputePort } from '@ktx/context/daemon';
|
2026-05-10 23:51:24 +02:00
|
|
|
import { loadKtxProject, type KtxLocalProject } from '@ktx/context/project';
|
2026-05-10 23:12:26 +02:00
|
|
|
import {
|
|
|
|
|
compileLocalSlQuery,
|
|
|
|
|
listLocalSlSources,
|
|
|
|
|
readLocalSlSource,
|
2026-05-13 13:01:56 +02:00
|
|
|
searchLocalSlSources,
|
2026-05-10 23:12:26 +02:00
|
|
|
validateLocalSlSource,
|
2026-05-13 15:41:10 +02:00
|
|
|
type LocalSlSourceSearchResult,
|
|
|
|
|
type LocalSlSourceSummary,
|
2026-05-10 23:12:26 +02:00
|
|
|
type SemanticLayerQueryInput,
|
2026-05-10 23:51:24 +02:00
|
|
|
} from '@ktx/context/sl';
|
2026-05-14 15:15:20 +02:00
|
|
|
import type { PrintListColumn } from './io/print-list.js';
|
2026-05-11 15:50:34 +02:00
|
|
|
import {
|
|
|
|
|
createManagedPythonSemanticLayerComputePort,
|
|
|
|
|
type KtxManagedPythonInstallPolicy,
|
|
|
|
|
} from './managed-python-command.js';
|
2026-05-10 23:12:26 +02:00
|
|
|
import { profileMark } from './startup-profile.js';
|
|
|
|
|
|
|
|
|
|
profileMark('module:sl');
|
|
|
|
|
|
|
|
|
|
type SlQueryFormat = 'json' | 'sql';
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
export type KtxSlArgs =
|
2026-05-13 15:41:10 +02:00
|
|
|
| { command: 'list'; projectDir: string; connectionId?: string; output?: string; json?: boolean }
|
|
|
|
|
| {
|
|
|
|
|
command: 'search';
|
|
|
|
|
projectDir: string;
|
|
|
|
|
connectionId?: string;
|
|
|
|
|
query: string;
|
|
|
|
|
limit?: number;
|
|
|
|
|
output?: string;
|
|
|
|
|
json?: boolean;
|
|
|
|
|
}
|
2026-05-10 23:12:26 +02:00
|
|
|
| { command: 'validate'; projectDir: string; connectionId: string; sourceName: string }
|
|
|
|
|
| {
|
|
|
|
|
command: 'query';
|
|
|
|
|
projectDir: string;
|
|
|
|
|
connectionId?: string;
|
2026-05-13 13:01:56 +02:00
|
|
|
query?: SemanticLayerQueryInput;
|
|
|
|
|
queryFile?: string;
|
2026-05-10 23:12:26 +02:00
|
|
|
format: SlQueryFormat;
|
|
|
|
|
execute: boolean;
|
|
|
|
|
maxRows?: number;
|
2026-05-11 15:50:34 +02:00
|
|
|
cliVersion: string;
|
|
|
|
|
runtimeInstallPolicy: KtxManagedPythonInstallPolicy;
|
2026-05-10 23:12:26 +02:00
|
|
|
};
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
interface KtxSlIo {
|
2026-05-10 23:12:26 +02:00
|
|
|
stdout: { write(chunk: string): void };
|
|
|
|
|
stderr: { write(chunk: string): void };
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
interface KtxSlDeps {
|
|
|
|
|
loadProject?: typeof loadKtxProject;
|
2026-05-13 13:01:56 +02:00
|
|
|
embeddingService?: KtxEmbeddingPort | null;
|
|
|
|
|
createEmbeddingProvider?: typeof createLocalKtxEmbeddingProviderFromConfig;
|
2026-05-10 23:51:24 +02:00
|
|
|
createSemanticLayerCompute?: () => KtxSemanticLayerComputePort;
|
2026-05-11 15:50:34 +02:00
|
|
|
createManagedSemanticLayerCompute?: (options: {
|
|
|
|
|
cliVersion: string;
|
|
|
|
|
installPolicy: KtxManagedPythonInstallPolicy;
|
|
|
|
|
io: KtxSlIo;
|
|
|
|
|
}) => Promise<KtxSemanticLayerComputePort>;
|
2026-05-10 23:51:24 +02:00
|
|
|
createQueryExecutor?: () => KtxSqlQueryExecutorPort;
|
2026-05-10 23:12:26 +02:00
|
|
|
}
|
|
|
|
|
|
2026-05-13 13:01:56 +02:00
|
|
|
function slSearchEmbeddingService(project: KtxLocalProject, deps: KtxSlDeps): KtxEmbeddingPort | null {
|
|
|
|
|
if ('embeddingService' in deps) {
|
|
|
|
|
return deps.embeddingService ?? null;
|
|
|
|
|
}
|
|
|
|
|
const provider = (deps.createEmbeddingProvider ?? createLocalKtxEmbeddingProviderFromConfig)(
|
|
|
|
|
project.config.ingest.embeddings,
|
|
|
|
|
);
|
|
|
|
|
return provider ? new KtxIngestEmbeddingPortAdapter(provider) : null;
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-14 15:15:20 +02:00
|
|
|
async function printSlSources(input: {
|
|
|
|
|
rows: ReadonlyArray<LocalSlSourceSummary>;
|
|
|
|
|
command: 'sl list';
|
|
|
|
|
output?: string;
|
|
|
|
|
json?: boolean;
|
|
|
|
|
io: KtxSlIo;
|
|
|
|
|
emptyMessage: string;
|
|
|
|
|
emptyHint?: string;
|
|
|
|
|
}): Promise<void>;
|
|
|
|
|
async function printSlSources(input: {
|
|
|
|
|
rows: ReadonlyArray<LocalSlSourceSearchResult>;
|
|
|
|
|
command: 'sl search';
|
|
|
|
|
output?: string;
|
|
|
|
|
json?: boolean;
|
|
|
|
|
io: KtxSlIo;
|
|
|
|
|
emptyMessage: string;
|
|
|
|
|
emptyHint?: string;
|
|
|
|
|
}): Promise<void>;
|
2026-05-13 15:41:10 +02:00
|
|
|
async function printSlSources(input: {
|
|
|
|
|
rows: ReadonlyArray<LocalSlSourceSummary | LocalSlSourceSearchResult>;
|
|
|
|
|
command: 'sl list' | 'sl search';
|
|
|
|
|
output?: string;
|
|
|
|
|
json?: boolean;
|
|
|
|
|
io: KtxSlIo;
|
|
|
|
|
emptyMessage: string;
|
2026-05-14 15:15:20 +02:00
|
|
|
emptyHint?: string;
|
2026-05-13 15:41:10 +02:00
|
|
|
}): Promise<void> {
|
|
|
|
|
const { resolveOutputMode } = await import('./io/mode.js');
|
2026-05-17 02:32:41 +02:00
|
|
|
const { createRankBadgeFormatter, printList } = await import('./io/print-list.js');
|
2026-05-13 15:41:10 +02:00
|
|
|
const mode = resolveOutputMode({ explicit: input.output, json: input.json, io: input.io });
|
2026-05-14 15:15:20 +02:00
|
|
|
|
|
|
|
|
if (input.command === 'sl search') {
|
|
|
|
|
const searchColumns: ReadonlyArray<PrintListColumn<LocalSlSourceSearchResult>> = [
|
|
|
|
|
{
|
|
|
|
|
key: 'score',
|
|
|
|
|
label: 'SCORE',
|
|
|
|
|
plain: 'score=',
|
|
|
|
|
role: 'badge',
|
2026-05-17 02:32:41 +02:00
|
|
|
prettyFormat: createRankBadgeFormatter(input.rows as ReadonlyArray<LocalSlSourceSearchResult>),
|
2026-05-14 15:15:20 +02:00
|
|
|
dim: true,
|
|
|
|
|
},
|
2026-05-13 15:41:10 +02:00
|
|
|
{ key: 'connectionId', label: 'CONNECTION', plain: '' },
|
|
|
|
|
{ key: 'name', label: 'NAME', plain: '' },
|
|
|
|
|
{ key: 'columnCount', label: 'COLS', plain: 'columns=', dim: true },
|
|
|
|
|
{ key: 'measureCount', label: 'MEASURES', plain: 'measures=', dim: true },
|
|
|
|
|
{ key: 'joinCount', label: 'JOINS', plain: 'joins=', dim: true },
|
|
|
|
|
{ key: 'description', label: 'DESCRIPTION', plain: false, optional: true, dim: true },
|
2026-05-14 15:15:20 +02:00
|
|
|
];
|
|
|
|
|
printList<LocalSlSourceSearchResult>({
|
|
|
|
|
rows: input.rows as ReadonlyArray<LocalSlSourceSearchResult>,
|
|
|
|
|
columns: searchColumns,
|
|
|
|
|
groupBy: 'connectionId',
|
|
|
|
|
emptyMessage: input.emptyMessage,
|
|
|
|
|
emptyHint: input.emptyHint,
|
|
|
|
|
unit: 'source',
|
|
|
|
|
command: input.command,
|
|
|
|
|
mode,
|
|
|
|
|
io: input.io,
|
|
|
|
|
});
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const listColumns: ReadonlyArray<PrintListColumn<LocalSlSourceSummary>> = [
|
|
|
|
|
{ key: 'connectionId', label: 'CONNECTION', plain: '' },
|
|
|
|
|
{ key: 'name', label: 'NAME', plain: '' },
|
|
|
|
|
{ key: 'columnCount', label: 'COLS', plain: 'columns=', dim: true },
|
|
|
|
|
{ key: 'measureCount', label: 'MEASURES', plain: 'measures=', dim: true },
|
|
|
|
|
{ key: 'joinCount', label: 'JOINS', plain: 'joins=', dim: true },
|
|
|
|
|
{ key: 'description', label: 'DESCRIPTION', plain: false, optional: true, dim: true },
|
|
|
|
|
];
|
|
|
|
|
printList<LocalSlSourceSummary>({
|
|
|
|
|
rows: input.rows as ReadonlyArray<LocalSlSourceSummary>,
|
|
|
|
|
columns: listColumns,
|
2026-05-13 15:41:10 +02:00
|
|
|
groupBy: 'connectionId',
|
|
|
|
|
emptyMessage: input.emptyMessage,
|
2026-05-14 15:15:20 +02:00
|
|
|
emptyHint: input.emptyHint,
|
|
|
|
|
unit: 'source',
|
2026-05-13 15:41:10 +02:00
|
|
|
command: input.command,
|
|
|
|
|
mode,
|
|
|
|
|
io: input.io,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-13 13:01:56 +02:00
|
|
|
async function readSlQueryFile(path: string): Promise<SemanticLayerQueryInput> {
|
|
|
|
|
const parsed = JSON.parse(await readFile(path, 'utf-8')) as unknown;
|
|
|
|
|
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
|
|
|
|
throw new Error(`${path} must contain a JSON object.`);
|
|
|
|
|
}
|
|
|
|
|
return parsed as SemanticLayerQueryInput;
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
export async function runKtxSl(args: KtxSlArgs, io: KtxSlIo = process, deps: KtxSlDeps = {}): Promise<number> {
|
2026-05-10 23:12:26 +02:00
|
|
|
try {
|
2026-05-10 23:51:24 +02:00
|
|
|
const project = await (deps.loadProject ?? loadKtxProject)({ projectDir: args.projectDir });
|
2026-05-10 23:12:26 +02:00
|
|
|
if (args.command === 'list') {
|
2026-05-13 15:41:10 +02:00
|
|
|
const sources = await listLocalSlSources(project, { connectionId: args.connectionId });
|
|
|
|
|
await printSlSources({
|
2026-05-10 23:12:26 +02:00
|
|
|
rows: sources,
|
|
|
|
|
emptyMessage: `No semantic-layer sources found in ${project.projectDir}`,
|
|
|
|
|
command: 'sl list',
|
2026-05-13 15:41:10 +02:00
|
|
|
output: args.output,
|
|
|
|
|
json: args.json,
|
2026-05-10 23:12:26 +02:00
|
|
|
io,
|
|
|
|
|
});
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
2026-05-13 15:41:10 +02:00
|
|
|
if (args.command === 'search') {
|
|
|
|
|
const sources = await searchLocalSlSources(project, {
|
2026-05-10 23:12:26 +02:00
|
|
|
connectionId: args.connectionId,
|
2026-05-13 15:41:10 +02:00
|
|
|
query: args.query,
|
|
|
|
|
embeddingService: slSearchEmbeddingService(project, deps),
|
|
|
|
|
limit: args.limit,
|
|
|
|
|
});
|
|
|
|
|
await printSlSources({
|
|
|
|
|
rows: sources,
|
|
|
|
|
emptyMessage: `No semantic-layer sources matched "${args.query}" in ${project.projectDir}`,
|
2026-05-14 15:15:20 +02:00
|
|
|
emptyHint: 'Run `ktx sl list` to inspect available sources.',
|
2026-05-13 15:41:10 +02:00
|
|
|
command: 'sl search',
|
|
|
|
|
output: args.output,
|
|
|
|
|
json: args.json,
|
|
|
|
|
io,
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
if (args.command === 'validate') {
|
|
|
|
|
const source = await readLocalSlSource(project, {
|
|
|
|
|
connectionId: args.connectionId,
|
|
|
|
|
sourceName: args.sourceName,
|
|
|
|
|
});
|
|
|
|
|
if (!source) {
|
|
|
|
|
throw new Error(`Semantic-layer source "${args.connectionId}/${args.sourceName}" was not found`);
|
|
|
|
|
}
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
const result = await validateLocalSlSource(source.yaml, {
|
|
|
|
|
project,
|
|
|
|
|
connectionId: args.connectionId,
|
|
|
|
|
sourceName: args.sourceName,
|
|
|
|
|
});
|
2026-05-10 23:12:26 +02:00
|
|
|
if (!result.valid) {
|
|
|
|
|
for (const error of result.errors) {
|
|
|
|
|
io.stderr.write(`${error}\n`);
|
|
|
|
|
}
|
|
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
io.stdout.write(`Valid semantic-layer source: ${args.connectionId}/${args.sourceName}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
if (args.command === 'query') {
|
2026-05-13 13:01:56 +02:00
|
|
|
const query = args.query ?? (args.queryFile ? await readSlQueryFile(args.queryFile) : undefined);
|
|
|
|
|
if (!query) {
|
|
|
|
|
throw new Error('sl query requires query input from --query-file or at least one --measure');
|
|
|
|
|
}
|
2026-05-11 15:50:34 +02:00
|
|
|
const compute = deps.createSemanticLayerCompute
|
|
|
|
|
? deps.createSemanticLayerCompute()
|
|
|
|
|
: await (deps.createManagedSemanticLayerCompute ?? createManagedPythonSemanticLayerComputePort)({
|
|
|
|
|
cliVersion: args.cliVersion,
|
|
|
|
|
installPolicy: args.runtimeInstallPolicy,
|
|
|
|
|
io,
|
|
|
|
|
});
|
2026-05-10 23:12:26 +02:00
|
|
|
const queryExecutor = args.execute ? (deps.createQueryExecutor ?? createDefaultLocalQueryExecutor)() : undefined;
|
2026-05-10 23:51:24 +02:00
|
|
|
const result = await compileLocalSlQuery(project as KtxLocalProject, {
|
2026-05-10 23:12:26 +02:00
|
|
|
connectionId: args.connectionId,
|
2026-05-13 13:01:56 +02:00
|
|
|
query,
|
2026-05-10 23:12:26 +02:00
|
|
|
compute,
|
|
|
|
|
execute: args.execute,
|
|
|
|
|
maxRows: args.maxRows,
|
|
|
|
|
queryExecutor,
|
|
|
|
|
});
|
|
|
|
|
if (args.format === 'sql') {
|
|
|
|
|
io.stdout.write(`${result.sql}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
io.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
2026-05-13 15:41:10 +02:00
|
|
|
const _exhaustive: never = args;
|
|
|
|
|
throw new Error(`Unsupported sl command: ${JSON.stringify(_exhaustive)}`);
|
2026-05-10 23:12:26 +02:00
|
|
|
} catch (error) {
|
|
|
|
|
io.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
}
|