ktx/examples/README.md

38 lines
1.3 KiB
Markdown
Raw Normal View History

2026-05-10 23:51:24 +02:00
# ktx examples
2026-05-10 23:12:26 +02:00
## 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.
2026-05-10 23:12:26 +02:00
For normal context building, use the public connection-centric commands:
2026-05-10 23:12:26 +02:00
```bash
ktx ingest <connectionId>
ktx ingest --all
2026-05-10 23:12:26 +02:00
```
The copied project initializes its own Git repository on first use.
## orbit-relationship-verification
2026-05-10 23:51:24 +02:00
`orbit-relationship-verification/` is a checked-in KTX project used by
2026-05-10 23:12:26 +02:00
`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, managed daemon batch SQL analysis, bounded pattern
WorkUnit shards, and no-WorkUnit idempotency for unchanged bucketed table
inputs and pattern shards.
2026-05-10 23:12:26 +02:00
## package-artifacts
`package-artifacts/` documents the artifact smoke checks. Those checks create
temporary projects instead of storing sample projects in this directory.