Skip to content

docs: recommend pinning both the expand and build snapshots #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mpyw merged 1 commit into from
Aug 18, 2026
Merged

docs: recommend pinning both the expand and build snapshots #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,17 @@ snapshots and for pre-execution inspection with `EXPLAIN`.
expanded, err := bisql.ExpandFile(sqlFS, "users/search.sql")
```

> [!TIP]
> Pin **two snapshots per query** as a regression guard:
>
> - **Expansion** — the `Expand`/`ExpandFile` output (`@include` resolved, still two-way).
> Dialect- and parameter-independent; isolates *what was composed*.
> - **Build** — the `SQL` + `Args` (or the values-embedded `SQLWithArgs`) for representative
> parameters, per dialect; captures *what an input produces*.
>
> The sample project under [`testdata/example`](testdata/example) does this: one
> `<name>.expanded.sql` per query, one `<name>.<case>.embedded.sql` per case.

## Authoring rules

Because the engine removes nothing implicitly, a template author observes the following rules.
Expand Down
Loading