docs: document SQL archive queries

This commit is contained in:
Vincent Koc 2026-05-06 01:54:34 -07:00
parent cf21d32fc7
commit 957854482a
No known key found for this signature in database
2 changed files with 18 additions and 0 deletions

View File

@ -60,6 +60,22 @@ notcrawl report
notcrawl sql "select count(*) from pages;"
```
## SQL
Use `notcrawl sql` for exact counts, joins, and database/page inventory queries
when normal CLI reads are too coarse. The command only allows read-only
`select`, `with`, and `pragma` queries.
Useful examples:
```bash
notcrawl sql "select count(*) as pages from pages;"
notcrawl sql "select parent_table, count(*) as pages from pages group by parent_table order by pages desc;"
notcrawl sql "select title, last_edited_time from pages order by coalesce(last_edited_time, created_time, 0) desc limit 20;"
```
Do not use SQL to mutate the archive.
When the installed CLI lacks a new feature, build or run from
`~/GIT/_Perso/notcrawl` before concluding the feature is missing.

View File

@ -4,6 +4,8 @@
- Add a repo-local `notcrawl` agent skill for local archive, freshness, query,
and verification workflows.
- Document `notcrawl sql` read-only query examples in the repo-local agent
skill so agents can do exact archive counts and inventory checks safely.
- Replace the single validation workflow with CI jobs for dependencies,
formatting/vet, tests, CLI control-surface smoke checks, and GoReleaser
snapshot builds.