Skip to content

refactor!: pre-v1.0 API design — var to func, Tx symmetry, ToSQL, Distinct #25

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
kolkov merged 2 commits into from
Jul 3, 2026
Merged

refactor!: pre-v1.0 API design — var to func, Tx symmetry, ToSQL, Distinct #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b986ab
refactor!: pre-v1.0 API design — var to func, Tx symmetry, ToSQL, Wit…
kolkov Jul 3, 2026
ef26930
docs: add CHANGELOG entry for v0.12.0 breaking API changes
kolkov Jul 3, 2026
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
20 changes: 20 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [0.12.0] - Unreleased

### Breaking Changes (pre-v1.0 API cleanup)

- **`var` → `func`** — All 32 exported expression builders and error helpers are now proper functions (`func Eq(col string, value interface{}) Expression` instead of `var Eq = core.Eq`). Improves godoc, prevents accidental reassignment. `ErrNotFound` remains `var` (sentinel error value).
- **`Distinct(bool)` → `Distinct()`** — No parameter, always enables DISTINCT. Remove `Distinct(false)` calls (omit the method instead).
- **`QueryParams()` deprecated** — Use `Params()` instead. `QueryParams()` still works but marked deprecated.

### Added

- **`Tx.BatchInsert()`** — Batch insert operations now available in transactions
- **`Tx.BatchUpdate()`** — Batch update operations now available in transactions
- **`Tx.Upsert()`** — Upsert operations now available in transactions
- **`Tx.NewQuery()`** — Raw SQL queries now available in transactions
- **`ToSQL()`** on `UpsertQuery`, `BatchInsertQuery`, `BatchUpdateQuery` — All 6 query types now support SQL preview for debugging
- **`ModelQuery.WithContext(ctx)`** — Per-operation context support on Model API
- **`Query.Params()`** — Canonical method for retrieving query parameters

---

## [0.11.2] - Unreleased

### Security
Expand Down
Loading
Loading