mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
159 lines
6.5 KiB
Text
159 lines
6.5 KiB
Text
---
|
|
title: "ktx ingest"
|
|
description: "Build or refresh KTX context from configured connections."
|
|
---
|
|
|
|
`ktx ingest` builds or refreshes KTX context from configured connections.
|
|
Database connections build schema context. Context-source connections ingest
|
|
metadata from tools such as dbt, Looker, Metabase, MetricFlow, LookML, and
|
|
Notion. The current public command is connection-centric: pass one
|
|
`connectionId`, or pass `--all`.
|
|
|
|
## Command signature
|
|
|
|
```bash
|
|
ktx ingest [options] [connectionId]
|
|
ktx ingest text [options] [files...]
|
|
```
|
|
|
|
Use a connection id to build one configured connection. Use `--all` to build
|
|
every configured connection. Database connections run before context-source
|
|
connections when you use `--all`.
|
|
|
|
## `ktx ingest` Options
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--all` | Ingest all configured connections | `false` |
|
|
| `--fast` | Use deterministic database schema ingest | Stored connection default, or `fast` |
|
|
| `--deep` | Use AI-enriched database ingest | Stored connection default, or `fast` |
|
|
| `--query-history` | Include database query-history usage patterns | Stored connection default |
|
|
| `--no-query-history` | Skip database query-history usage patterns for this run | Stored connection default |
|
|
| `--query-history-window-days <days>` | BigQuery/Snowflake query-history lookback window for this run | Stored connection default |
|
|
| `--plain` | Print plain text output | `true` |
|
|
| `--json` | Print JSON output | `false` |
|
|
| `--yes` | Install required managed runtime features without prompting | `false` |
|
|
| `--no-input` | Disable interactive terminal input | - |
|
|
|
|
`--fast` and `--deep` are mutually exclusive. Depth flags apply only to
|
|
database connections. Query-history flags apply only to database connections
|
|
that support query history. The window flag applies to BigQuery and Snowflake;
|
|
Postgres reads the current `pg_stat_statements` aggregate data instead of a
|
|
time-windowed history table. Query-history ingest runs after schema ingest and
|
|
requires deep ingest readiness.
|
|
|
|
When `--all` selects both databases and context sources, database ingest runs
|
|
first, then source ingest and memory updates run for source connections.
|
|
|
|
Some ingest paths use the managed KTX Python runtime. Query-history ingest uses
|
|
it for SQL analysis, and Looker source ingest uses it for Looker identifier
|
|
parsing. In an interactive terminal, `ktx ingest` prompts before installing the
|
|
required runtime features. Use `--yes` to install them without prompting, or
|
|
use `--no-input` to fail fast with install guidance.
|
|
|
|
## `ktx ingest text` Options
|
|
|
|
Use `ktx ingest text` to capture free-form text artifacts into KTX memory.
|
|
Provide files, pass `--text` one or more times, or use `-` as a file argument to
|
|
read one item from stdin.
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--text <content>` | Text content to ingest; repeat for a batch | `[]` |
|
|
| `--connection-id <connectionId>` | Optional KTX connection id for semantic-layer capture | - |
|
|
| `--user-id <id>` | Memory user id for capture attribution | `local-cli` |
|
|
| `--json` | Print JSON output | `false` |
|
|
| `--fail-fast` | Stop after the first failed text item | `false` |
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
# Build one database or source connection
|
|
ktx ingest warehouse
|
|
|
|
# Force deterministic database schema ingest
|
|
ktx ingest warehouse --fast
|
|
|
|
# Force AI-enriched database ingest
|
|
ktx ingest warehouse --deep
|
|
|
|
# Include query-history usage patterns
|
|
ktx ingest warehouse --deep --query-history
|
|
# Set the lookback window for BigQuery or Snowflake query history
|
|
ktx ingest warehouse --query-history-window-days 30
|
|
|
|
# Build a source connection
|
|
ktx ingest notion
|
|
|
|
# Build all configured connections
|
|
ktx ingest --all
|
|
ktx ingest --all --deep
|
|
|
|
# Capture local Markdown notes into memory
|
|
ktx ingest text docs/revenue-notes.md --connection-id warehouse
|
|
|
|
# Capture one stdin item
|
|
printf "Refunds are excluded from net revenue." | ktx ingest text -
|
|
```
|
|
|
|
## Output
|
|
|
|
Plain output summarizes each target and the operations that ran.
|
|
|
|
```text
|
|
Ingest finished
|
|
|
|
Source Database schema Query history Source ingest Memory update
|
|
warehouse done done skipped skipped
|
|
notion skipped skipped done done
|
|
```
|
|
|
|
Use `--json` when a script or agent needs the selected plan and per-target
|
|
results.
|
|
|
|
## Inspect source ingest traces
|
|
|
|
Source ingest writes persistent JSONL traces for postmortem debugging. Plain
|
|
ingest output prints the trace path near the report, run, and job identifiers
|
|
when a trace is available:
|
|
|
|
```text
|
|
Report: report-abc123
|
|
Run: run-abc123
|
|
Job: job-abc123
|
|
Trace: .ktx/ingest-traces/job-abc123/trace.jsonl
|
|
```
|
|
|
|
The trace file lives under the project directory at
|
|
`.ktx/ingest-traces/<jobId>/trace.jsonl`. Each line is a JSON event with the
|
|
job id, run id, sync id, connection id, source key, phase, event name, timing,
|
|
state snapshot, decision context, and error details. Failed runs also write a
|
|
stored ingest report with `status: "failed"`, `failure.phase`,
|
|
`failure.message`, and the same trace path.
|
|
|
|
Use `jq` or line-oriented tools to inspect a trace:
|
|
|
|
```bash
|
|
jq -c '. | {at, level, phase, event, durationMs, data, error}' \
|
|
.ktx/ingest-traces/<jobId>/trace.jsonl
|
|
```
|
|
|
|
KTX writes `debug` trace events by default. Set `KTX_INGEST_TRACE_LEVEL` to
|
|
`error`, `info`, `debug`, or `trace` before running ingest to change the trace
|
|
verbosity:
|
|
|
|
```bash
|
|
KTX_INGEST_TRACE_LEVEL=trace ktx ingest metabase
|
|
```
|
|
|
|
## Common errors
|
|
|
|
| Error | Cause | Recovery |
|
|
|-------|-------|----------|
|
|
| Connection not configured | The connection id is not present in `ktx.yaml` | Add the connection with `ktx setup` or update `ktx.yaml` |
|
|
| Deep readiness is missing | `--deep` or query history needs model, embedding, and scan-enrichment configuration | Run `ktx setup` or rerun with `--fast` |
|
|
| Query history is unsupported | The selected database driver does not support query history | Run schema ingest without query-history flags |
|
|
| Python runtime is missing | The selected ingest target needs runtime-backed SQL analysis or source parsing | Accept the interactive prompt, rerun with `--yes`, or run the suggested `ktx dev runtime install` command |
|
|
| No ingest target was selected | No connection id was provided and `--all` was omitted | Run `ktx ingest <connectionId>` or `ktx ingest --all` |
|
|
| Source options were ignored | Depth and query-history flags were supplied for a non-database source | Omit database-only flags when ingesting source connections |
|
|
| Text ingest stops early | `--fail-fast` was used and one item failed | Fix the failed item or rerun without `--fail-fast` to collect all failures |
|