@carllee1983/dbcli 1.32.0 → 1.37.0

package/skills/dbcli/reference.md

@@ -616,6 +616,46 @@ dbcli assert "SELECT count(*) FROM orders" --expect "value > 100" --no-fail   #
 **Engines:** SQL only (PostgreSQL / MySQL / MariaDB)
 **Permission:** query-only+
 
+#### Verification artifact (--write-verification-artifact)
+
+Opt-in flag trio that persists a **VerificationArtifact JSON** (schema v1) under `<cwd>/.dbcli/verification/` after the assertion runs. The artifact is always written to `<cwd>/.dbcli/verification/` (relative to the current working directory), regardless of where the `--config` file is located.
+
+| Flag | Required | Description |
+| :--- | :--- | :--- |
+| `--write-verification-artifact` | opt-in | Trigger artifact write. No-op when no verdict has been produced. |
+| `--verification-subject <kind:name>` | yes (when flag is set) | Subject identifier. Format: `<kind>:<name>`. Allowed kinds: `recovery`, `task-pack`, `assertion`, `migration`, `backfill`, `manual`. |
+| `--verification-summary <text>` | no | Free-text summary line stored in the artifact. Default when pass: "Assertion verified the expected state." Default when fail: "Assertion did not verify the expected state." |
+
+**Output contract:**
+
+- `--format json` — `AssertVerdict` gains `verificationArtifactPath: string` pointing to the written file.
+- `--format table` — an extra `Verification artifact: <path>` line is printed after the verdict table.
+- A `--no-fail` assertion that fails still records status `not_verified` and stores `exitCode: 1` in evidence.
+
+**Planned vs Result evidence.** `dbcli skill tasks plan safe-backfill-verify --format json` returns a plan containing a `verification` block with `status: "planned"`. That block is the **planned** evidence definition — it describes which check will run. Running `assert --write-verification-artifact` on the actual data produces **result** evidence (`status: "verified"` or `status: "not_verified"`). The two records are distinct; `"planned"` does **not** indicate that verification has run or passed.
+
+> **Casting note:** Postgres returns `count(*)` and `sum()` as bigint (a string in the result set). `value ==` uses strict equality, so `"0" == 0` is false. Cast to `::int` (`count(*)::int`) to ensure numeric comparison works correctly.
+
+```bash
+dbcli assert "SELECT count(*)::int FROM orders WHERE status IS NULL" \
+  --expect "value == 0" \
+  --write-verification-artifact \
+  --verification-subject backfill:safe-backfill-verify
+
+dbcli assert "SELECT count(*)::int FROM orders WHERE status IS NULL" \
+  --expect "value == 0" \
+  --write-verification-artifact \
+  --verification-subject backfill:safe-backfill-verify \
+  --verification-summary "Post-backfill null-status count is zero."
+
+# --no-fail: exits 0 but still records not_verified on failure
+dbcli assert "SELECT count(*)::int FROM orders WHERE status IS NULL" \
+  --expect "value == 0" \
+  --no-fail \
+  --write-verification-artifact \
+  --verification-subject backfill:safe-backfill-verify
+```
+
 ### proxy
 
 Local-development **observability proxy** for MySQL/MariaDB/PostgreSQL. Inserts dbcli
@@ -1104,6 +1144,243 @@ Output reports: writer enabled/disabled, last write result, file-lock state, rot
 
 **Permission:** n/a
 
+### verify
+
+Run a verification scenario. `verify` **runs** verification scenarios (safe-backfill,
+migration) and never executes writes/DDL. `verification` **inspects and manages** the
+local result artifacts those scenarios produce under `.dbcli/verification/`.
+
+```bash
+# Preflight (default): read-only guards + the exact after-write command. No artifact.
+dbcli verify safe-backfill \
+  --table users \
+  --query "UPDATE users SET status = 1 WHERE status IS NULL" \
+  --verify-query "SELECT count(*)::int AS n FROM users WHERE status IS NULL" \
+  --expect "value == 0"
+
+# After-write: re-run guards, run the read-back assertion, write a v1 artifact.
+dbcli verify safe-backfill ... --after-write
+
+# JSON for agents.
+dbcli verify safe-backfill ... --format json
+```
+
+Options: `--table` (req), `--query` (req, analyzed not executed), `--verify-query`
+(req, **plain SELECT only**), `--expect` (req), `--after-write`, `--format <table|json>`,
+`--subject-name <name>`, `--summary <text>`.
+
+Guard constraints (fail closed): `--verify-query` must be a **plain `SELECT`** —
+`EXPLAIN`/`EXPLAIN ANALYZE`, `SHOW`, `DESCRIBE`, and data-modifying CTEs are rejected
+(on PostgreSQL `EXPLAIN ANALYZE <write>` actually performs the write). The `--query`
+**UPDATE target must equal `--table`**, compared schema-aware (`public.users` ≠
+`audit.users`). The persisted artifact stores only a bounded, literal-free label of the
+verify-query and `--expect` — string, numeric, and dollar-quoted literals are stripped,
+so raw SQL/values are never written to disk. The printed after-write
+command is shell-escaped and carries through `--subject-name`/`--summary`/non-default
+`--format`. For repeated backfills on the same table, pass a unique `--subject-name` so
+each operation is independently traceable (the subject defaults to `backfill:<table>`).
+
+Status: `ready`/`blocked` in preflight (no artifact); `verified`, `not_verified`,
+`blocked`, or `indeterminate` in after-write (artifact written). `blocked` = a guard
+failed (blacklist/schema/plan/verify-query-not-plain-SELECT/target-table-mismatch);
+`not_verified` = the read-back contradicted `--expect`; `indeterminate` = the assertion
+could not produce a trustworthy verdict. Inspect the result with
+`dbcli verification show <artifact-id>`.
+
+#### `verify migration`
+
+Preflight or after-write verification for a schema migration. **This command never
+executes DDL** — it analyzes the proposed `ALTER TABLE`, runs read-only guards, and
+(in after-write mode) records evidence after you apply the migration externally.
+
+```bash
+# Preflight: read-only guards + the exact after-write command. Returns ready or blocked.
+dbcli verify migration \
+  --table users \
+  --ddl "ALTER TABLE users ADD COLUMN verified_at TIMESTAMPTZ" \
+  --verify-query "SELECT count(*)::int AS n FROM users WHERE verified_at IS NOT NULL" \
+  --expect "value == 0"
+
+# After the migration is applied externally, record evidence:
+dbcli verify migration ... --after-write
+
+# JSON for agents.
+dbcli verify migration ... --format json
+```
+
+| Option | Required | Description |
+| --- | --- | --- |
+| `--table <table>` | yes | Table affected by the migration. |
+| `--ddl <sql>` | yes | Proposed migration DDL, analyzed but never executed. MVP accepts `ALTER TABLE` only. |
+| `--verify-query <sql>` | yes | Plain `SELECT` for post-migration read-back verification. |
+| `--expect <expr>` | yes | Assertion expression for the read-back result. |
+| `--after-write` | no | Run the post-migration assertion and write a v1 artifact. |
+| `--format <table\|json>` | no | Output format, default `table`. |
+| `--subject-name <name>` | no | Artifact subject name. Default is the table name. |
+| `--summary <text>` | no | Optional artifact summary override. |
+
+Preflight returns `ready` or `blocked` and prints the exact after-write command;
+**`ready` is not `verified`** — it only means the guards passed. After-write maps the
+read-back assertion to `verified` / `not_verified` / `indeterminate`, and a failed
+guard to `blocked`. `CREATE TABLE`, `DROP TABLE`, `CREATE INDEX`, and multi-statement
+DDL are blocked in the MVP.
+
+The `ALTER TABLE` target may be `table`, `schema.table`, or `catalog.schema.table`.
+Each segment is a simple unquoted name (`[A-Za-z_][A-Za-z0-9_]*`) or a quoted
+identifier — double-quoted (`"…"`), backtick-quoted (`` `…` ``), or bracket-quoted
+(`[…]`) — so `"user accounts"` or `"tenant-1"."orders"` are accepted. Targets that
+cannot be fully parsed under this contract (unterminated quotes, unsupported escapes,
+or more than three parts) are blocked before the after-write assertion with a
+"could not be parsed" reason, distinct from the `must match --table` mismatch reason.
+
+### verification
+
+(v1.33.0+) Local **VerificationArtifact** inspection and lifecycle surface over
+`<cwd>/.dbcli/verification/` (always relative to the current working directory,
+regardless of `--config` location). `list`, `show`, and `summary` are read-only;
+`prune` is a local lifecycle command — dry-run by default, deleting only with
+`--execute --force`. Requires no database connection and performs no audit writes.
+
+**Subcommands:** `list` · `show` · `summary` · `prune`
+
+#### `verification list`
+
+List verification artifacts on disk, with optional filters.
+
+```bash
+dbcli verification list --format json
+dbcli verification list --status verified
+dbcli verification list --subject backfill
+dbcli verification list --subject backfill:safe-backfill-verify
+dbcli verification list --limit 20 --format json
+dbcli verification list --include-invalid --format json
+```
+
+| Flag | Purpose | Default |
+|---|---|---|
+| `--format <json\|table>` | Output format. | `json` |
+| `--limit <n>` | Maximum number of entries to return. | `20` |
+| `--status <status>` | Filter by status. One of: `verified`, `not_verified`, `indeterminate`, `blocked`. | all |
+| `--subject <kind[:name]>` | Filter by subject kind or exact `kind:name`. Allowed kinds: `recovery`, `task-pack`, `assertion`, `migration`, `backfill`, `manual`. | all |
+| `--include-invalid` | Surface malformed artifact files (normally skipped silently). Invalid files are returned as a separate top-level `invalid` array in JSON output, each entry shaped `{ "path": "...", "filename": "...", "error": "..." }`. When off, `invalid` is `[]`. | off |
+
+**Missing directory:** if `.dbcli/verification/` does not exist, exits `0` with an
+empty result (list: `[]`, summary: zero counts).
+
+**Malformed files:** by default, files that cannot be parsed as valid VerificationArtifact
+JSON are silently skipped. Pass `--include-invalid` to surface them.
+
+#### `verification show`
+
+Print a single verification artifact by its id (the artifact's `id` field) or by
+the path to the artifact file.
+
+```bash
+dbcli verification show abc123 --format json
+dbcli verification show abc123 --format table
+dbcli verification show .dbcli/verification/abc123.json --format json
+```
+
+| Flag | Purpose | Default |
+|---|---|---|
+| `<id-or-path>` | Positional. The artifact `id` (format `ver_<base36>_<hex>`), a unique id prefix, the artifact filename, or a path to the file inside `.dbcli/verification/`. | required |
+| `--format <json\|table>` | Output format. | `json` |
+
+**Exit codes:**
+- `0` — artifact found and valid.
+- `1` — id or path not found, or the artifact file is malformed (parse error).
+
+#### `verification summary`
+
+Aggregate verification artifacts into status counts, optionally filtered.
+
+```bash
+dbcli verification summary --format json
+dbcli verification summary --status not_verified --format json
+dbcli verification summary --subject migration --format json
+dbcli verification summary --subject migration:add-status-column --format json
+```
+
+| Flag | Purpose | Default |
+|---|---|---|
+| `--format <json\|table>` | Output format. | `json` |
+| `--status <status>` | Filter to a single status before summarising. | all |
+| `--subject <kind[:name]>` | Filter by subject kind or exact `kind:name`. | all |
+| `--latest-only` | Narrow to the latest matching valid artifact plus status counts; the `subjects` breakdown is omitted. Missing artifacts return exit `0` with `latest: null`. | off |
+
+**Output shape (JSON):**
+```json
+{
+  "storageDir": "/abs/path/.dbcli/verification",
+  "latest": {
+    "path": "...",
+    "id": "ver_...",
+    "createdAt": "2026-06-19T01:02:03.000Z",
+    "status": "verified",
+    "subject": { "kind": "backfill", "name": "safe-backfill-verify" },
+    "summary": "..."
+  },
+  "counts": { "total": 4, "verified": 2, "not_verified": 1, "indeterminate": 0, "blocked": 1, "invalid": 0 },
+  "subjects": [
+    { "subject": { "kind": "backfill", "name": "safe-backfill-verify" }, "total": 3, "latestStatus": "verified", "latestCreatedAt": "2026-06-19T01:02:03.000Z" }
+  ]
+}
+```
+
+`latest` is `null` when no valid artifacts match the filters.
+
+#### `verification prune`
+
+Preview or delete local verification artifacts under `<cwd>/.dbcli/verification/` by
+explicit retention criteria. **Dry-run by default**; deletes only with `--execute --force`.
+
+```bash
+dbcli verification prune --older-than 30d --format json          # preview candidates
+dbcli verification prune --older-than 30d --execute --force      # delete after preview
+dbcli verification prune --older-than 90d --status verified --keep-latest 50 --execute --force
+```
+
+| Option | Default | Meaning |
+| --- | --- | --- |
+| `--format <format>` | `json` | `json` or `table`. JSON is the authoritative contract. |
+| `--older-than <Nd>` | required | Minimum age in whole days (`7d`, `30d`, `365d`). |
+| `--keep-latest <n>` | `20` | Always protect the latest N valid artifacts across all subjects/statuses before filters. `0` protects none. |
+| `--status <status>` | none | Select only valid artifacts with this status. |
+| `--subject <kind:name>` | none | Select only valid artifacts with this subject. |
+| `--include-invalid` | `false` | Also select malformed `verification-*.json` files, by file mtime. |
+| `--execute` | `false` | Delete instead of preview. Requires `--force`. |
+| `--force` | `false` | Acknowledge deletion; required with `--execute`. |
+
+Safety: deletion is scoped to regular `verification-*.json` files inside
+`.dbcli/verification/`; symlinks, directories, and path escapes are skipped with a
+reason. No database connection is opened and no audit entry is written. JSON output
+includes `storageDir`, `dryRun`, `cutoff`, `criteria`, `protected`, `candidates`,
+`deleted`, and `skipped`.
+
+**Statuses:**
+
+| Status | Meaning |
+|---|---|
+| `verified` | The assertion ran and evidence matched the expected state. |
+| `not_verified` | The assertion ran and evidence contradicted the expected state. |
+| `indeterminate` | The assertion ran but evidence was ambiguous (JSON parse failure, missing field, gate skip). |
+| `blocked` | Verification could not run due to config, permission, schema, placeholder, or safety gates. |
+
+**Subject kinds:**
+
+| Kind | Produced by |
+|---|---|
+| `recovery` | Post-recovery verification assertions. |
+| `task-pack` | Assertions generated by task pack plans. |
+| `assertion` | General-purpose inline assertions. |
+| `migration` | Schema migration pre/post checks. |
+| `backfill` | Data backfill verification assertions. |
+| `manual` | Manually triggered or ad-hoc verification runs. |
+
+**Storage root:** `<cwd>/.dbcli/verification/` (cwd-relative; independent of `--config`).
+
+**Permission:** n/a
+
 ### doctor
 
 Run diagnostic checks on environment, configuration, connection, and data.