mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-13 08:15:14 +02:00
00cdf2de90
Align the tree with AGENTS.md/CLAUDE.md conventions: - Rewrite user-facing strings, docs, and tests to lowercase `ktx` (no bare uppercase `KTX` tokens remain outside literal identifiers). - Drop the legacy `historicSql` migration path and its now-unused helpers, per the no-backward-compat rule. - Remove `as unknown as` / `any` casts: narrow `BaseTool` generics to `z.ZodObject`, add a typed `createLookerClient`, and delete the dead `getParametersSchema`/`toAnthropicFormat` pre-AI-SDK helpers. - Use `InvalidArgumentError` for Commander parse failures. - Finish the adapter→connector prose conversion in the `ktx.yaml` docs while keeping the literal `adapters` config key.
37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# ktx examples
|
|
|
|
## local-warehouse
|
|
|
|
`local-warehouse/` is a contributor fixture for local CLI smoke tests. It uses
|
|
the internal fake ingest adapter so tests can exercise memory-flow behavior
|
|
without a live database or external service.
|
|
|
|
For normal context building, use the public connection-centric commands:
|
|
|
|
```bash
|
|
ktx ingest <connectionId>
|
|
ktx ingest --all
|
|
```
|
|
|
|
The copied project initializes its own Git repository on first use.
|
|
|
|
## orbit-relationship-verification
|
|
|
|
`orbit-relationship-verification/` is a checked-in **ktx** project used by
|
|
`pnpm run relationships:verify-orbit`. It points the `orbit` SQLite connection
|
|
at the Orbit-style no-declared-constraint relationship fixture and verifies that
|
|
relationship enrichment writes nine accepted joins without requiring a local
|
|
warehouse credential.
|
|
|
|
## postgres-historic
|
|
|
|
`postgres-historic/` is a manual Docker-backed smoke for Postgres
|
|
query-history ingest via `pg_stat_statements`. It verifies setup, staged
|
|
query-history artifacts, **ktx** daemon batch SQL analysis, bounded pattern
|
|
WorkUnit shards, and no-WorkUnit idempotency for unchanged bucketed table
|
|
inputs and pattern shards.
|
|
|
|
## package-artifacts
|
|
|
|
`package-artifacts/` documents the artifact smoke checks. Those checks create
|
|
temporary projects instead of storing sample projects in this directory.
|