Task 0.5 of clean-analyst-bootstrap. Greenfield rewrite — no fallback, no aliases. Existing dev environments lose their cached PAT and must re-authenticate. Env var renames (hard cutover): - DA_CONFIG_DIR -> AGNES_CONFIG_DIR - DA_SERVER -> AGNES_SERVER - DA_SERVER_URL -> AGNES_SERVER_URL (test-only stale ref, not in spec) - DA_NO_UPDATE_CHECK -> AGNES_NO_UPDATE_CHECK - DA_LOCAL_DIR -> AGNES_LOCAL_DIR - DA_TOKEN -> AGNES_TOKEN - DA_STREAM_RETRIES -> AGNES_STREAM_RETRIES Config dir rename: ~/.config/da/ -> ~/.config/agnes/ (across code, comments, docstrings, error messages, install templates, dev scripts). Stale `da X` references in CLI source (and adjacent app/, tests/): swept docstrings, comments, help text, and error messages where the verb survives the rewrite (init, pull, push, catalog, status, diagnose, auth, admin, skills, query, schema, describe, explore, disk-info, snapshot, login, logout, whoami, server, setup) and replaced `da X` with `agnes X`. Intentionally kept `da sync`, `da fetch`, `da analyst`, `da metrics` — those verbs are removed in later tasks; the legacy strings will be detected by `_LEGACY_STRINGS` (added in Task 2). Test fixes: - TestCLIVersion now asserts output starts with `agnes ` (was `da `). Test results: 2675 passed, 25 skipped (full pytest run, excluding 9 pre-existing test_db.py / test_user_management.py / test_e2e_extract.py / test_cli_binary_rename.py failures unrelated to this rename).
5.5 KiB
| name | description |
|---|---|
| agnes-data-querying | Use when querying any data in Agnes — discovery first, estimate before fetch, materialize scoped subsets locally |
Querying Agnes data
When asked about ANY data in Agnes, follow this protocol: discover → choose tool → fetch (with estimate) → query locally → clean up.
Discovery first
Before writing ANY query, understand what's available:
agnes catalog --json | jq <filter> # know what's available
agnes schema <table> # learn columns + types
agnes describe <table> -n 5 # see real values for shape
Never write SELECT * FROM <table> blindly. For local-mode tables it's wasteful; for remote-mode tables it can blow up at 225M+ rows.
Choose the right tool
Tables in agnes catalog have a query_mode:
| Mode | Means | How to query |
|---|---|---|
local |
parquet synced on laptop | agnes query "SELECT …" directly |
remote (BigQuery) |
parquet NOT on laptop | da fetch subset → snapshot, OR agnes query --remote one-shot |
For remote tables, you MUST either:
da fetcha filtered subset → query the local snapshot (preferred), ORagnes query --remotefor one-shot server-side execution, ORagnes query --register-bqfor hybrid joins (rare; see docs)
The da fetch workflow (preferred for remote tables)
1. Estimate first
Always estimate before fetching:
da fetch web_sessions_example \
--select event_date,country_code,session_id \
--where "event_date >= DATE_SUB(CURRENT_DATE(), INTERVAL 30 DAY)
AND country_code = 'CZ'" \
--estimate
Output tells you scan cost, expected rows, and local bytes — so you know if it's reasonable.
2. If reasonable, fetch to snapshot
da fetch web_sessions_example \
--select event_date,country_code,session_id \
--where "event_date >= DATE_SUB(CURRENT_DATE(), INTERVAL 30 DAY)
AND country_code = 'CZ'" \
--as cz_recent
3. Query the local snapshot
agnes query "SELECT event_date, COUNT(*) FROM cz_recent GROUP BY 1 ORDER BY 1"
Heuristics for da fetch
| Requirement | Why |
|---|---|
Always --select specific columns |
Avoid implicit SELECT * on remote (expensive) |
Always --where for remote tables |
Otherwise add --limit to keep result bounded |
Always --estimate first if unsure |
Partition/clustering metadata + shape matters; dry runs are free |
| Reuse snapshots across questions | agnes snapshot list before fetching — existing snapshot? Skip the fetch |
BigQuery SQL flavor for --where
For source_type=bigquery (per agnes catalog), use BigQuery SQL syntax:
| Syntax | Example |
|---|---|
| Date literal | DATE '2026-01-01' (NOT '2026-01-01'::date) |
| Timestamp literal | TIMESTAMP '2026-01-01 00:00:00 UTC' |
| Now | CURRENT_DATE(), CURRENT_TIMESTAMP() |
| Date arithmetic | DATE_SUB(CURRENT_DATE(), INTERVAL 30 DAY) |
| Regex | REGEXP_CONTAINS(col, r'pattern') (raw string!) |
| NULL check | col IS NOT NULL (standard) |
| Cast | CAST(x AS INT64) (NOT INT) |
For source_type=keboola / source_type=jira (local), use DuckDB SQL in your agnes query calls — there's no --where on local since fetch is implicit.
Snapshot hygiene
- Reuse snapshots across questions in the same conversation
- Use descriptive names:
cz_recent,orders_q1_us,sessions_today - Drop with
agnes snapshot drop <name>when done with a topic - Check total cache size with
agnes disk-info
When NOT to use da fetch
| Scenario | Use instead |
|---|---|
Single aggregate on remote BASE TABLE (SELECT COUNT(*)) |
agnes query --remote "SELECT COUNT(*) FROM web_sessions_example" — cheap, no fetch needed (Storage Read API pushes the COUNT into BQ) |
| Single aggregate on remote VIEW/MATERIALIZED_VIEW | Same syntax works (#160) but the BQ jobs API can't push WHERE/COUNT into the view body. Cost guardrail (default 5 GiB) catches expensive scans → 400 remote_scan_too_large with da fetch suggestion. Pivot to da fetch <id> --where '<predicate>' if rejected. |
| Throwaway exploration with raw BQ syntax | agnes query --remote "SELECT … FROM <registered_id>" — direct bq."<dataset>"."<table>" paths are now registry-gated (403 bq_path_not_registered if not registered). Register first or use the catalog id. |
| Cross-table JOIN with both remote | Use da fetch for one side + agnes query --remote for the other; full cross-remote JOIN needs design (see #101) |
When the table you need isn't in agnes catalog
The catalog reads from system.duckdb::table_registry — entries land there only via admin registration, not auto-discovery. If agnes catalog doesn't show what the user is asking about:
- Tell the user the table isn't registered
- Hand off to an admin (or, if you have admin role yourself, follow the agnes-table-registration skill)
- Don't
agnes query --remoteyour way around it — the catalog gap means the registry doesn't track this dataset, RBAC can't gate it, and quotas don't apply
Protocol summary
- Discover:
agnes catalog,agnes schema,agnes describe - Check query_mode: local (direct) or remote (fetch or --remote)?
- For remote:
--estimatefirst, thenda fetchwith--select+--where - Snapshot name: descriptive (
cz_recent), reuse across questions - Query:
agnes queryagainst snapshot; DuckDB SQL syntax - Cleanup:
agnes snapshot dropwhen done;agnes disk-infoto check size