You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d715c7e
Browse filesBrowse the repository at this point in the historyBrowse files
feat(plan): will-run / won't-run summary and a clearer Renames section (#1602)
* feat(plan): will run and won't run in the plan index, Renames and migrations apart, and renames marked in the plan JSON (CHI-1563)
* fix(plan): bring the summary's migration step count through the server client, and keep read failures to their group
- The server client copied a plan summary's fields one by one and dropped
migration_steps, so the Renames and migrations section lost its data
moves and its step count on a real server. It is now required on every
summary and copied; a summary without it is refused.
- A browser test runs the plan page through the real server client
against a faked control server (e2e/support/fake-plans.ts), covering
migration_steps, origin_model, old_name and is_rename; it fails when the
client drops the step count again.
- A failed read is kept to its group, warnings included, and to paging or
filtering in Renames and migrations; a re-plan clears them all.
- The static demo's plan previews predated plan summaries and paged
sections; they are recorded again from DuckShop on sqb dev through the
summary, rows and diff reads (scripts/record-demo-plans.mjs).
* docs(plan): regenerate the docs skill pages for the plan and migrations docs
* refactor(plan): one-line doc comments, the rename reason with the plan output constants, and branch-free test helpers
Copy file name to clipboardExpand all lines: src/sqlbuild/.agents/skills/sqlbuild/references/docs/cli/plan.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@ Seeds (1)
125
125
126
126
When query, function, or schema changes are detected, the plan lists each affected model under its own change with its backfill action. A model that calls a changed function directly appears under `Function changed` with `cause: function <name> changed`; models further downstream continue forward. See [Replay decisions](../concepts/planning/replay-decisions.md).
127
127
128
-
In `sqb plan --json`, each model's `reason` is its own change. A direct caller of a changed function has `"reason": "function_changed"` and a `changed_functions` list, and a renamed model whose query also changed has `"reason": "renamed"` and `"query_changed": true`. A changed model also carries the detail the text plan prints under it: `query_diff` when its query changed and the previous query is known, and `config_diff` when its config changed, each as unified diff lines, and `schema_findings` for added, removed, or retyped columns.
128
+
In `sqb plan --json`, each model's `reason` is its own change. A direct caller of a changed function has `"reason": "function_changed"` and a `changed_functions` list, and a renamed model whose query also changed has `"reason": "renamed"` and `"query_changed": true`. A renamed model's row names the model it was renamed from in `origin_model` and what stays at the old name in `old_name` (the same object as its migration's; see [Model migrations](../concepts/models/migrations.md); absent when the migration has none), and that rename's own entry in `migrations` has `"is_rename": true`; every other migration has `"is_rename": false`. A changed model also carries the detail the text plan prints under it: `query_diff` when its query changed and the previous query is known, and `config_diff` when its config changed, each as unified diff lines, and `schema_findings` for added, removed, or retyped columns.
129
129
130
130
Warnings and maintenance notices, such as `migrate_from can be removed`, are listed in a `Warnings` section before the final `Plan complete` line. `sqb plan --json` output is unchanged.
0 commit comments