docs: add V1 README, CHANGELOG, and package docs
Expand README with setup and API guidance, add CHANGELOG breaking section, and refresh package documentation for the V1 API surface. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -0,0 +1,24 @@
|
||||
# Changelog
|
||||
|
||||
## Unreleased (v1.0.0)
|
||||
|
||||
### Breaking changes
|
||||
|
||||
- Removed `UUID`, `NewUUID`, and `ParseUUID`.
|
||||
- Added `StringKSUID` and `BinaryKSUID` with distinct SQL encodings and shared GraphQL transit (`ksuid_str` JSON field, replacing `uuid_str`).
|
||||
- Removed `DBConfig.AutoMigrate`, `SQLOFunc`, and `JSONB.ToMap()`.
|
||||
- Replaced `Column` / `ColumnList` intersection interfaces with dialect-neutral type aliases.
|
||||
- `Apply*` and `Expr*` helpers now accept `Column` / `ColumnList` / `Expression` aliases instead of `mysql.*` types.
|
||||
|
||||
### Added
|
||||
|
||||
- Context-aware variants for all query and mutation helpers.
|
||||
- `Delete`, `DeleteAffected`, `WithTx`, `ContainsCol`, and `CurrentDialect()`.
|
||||
- Package documentation (`doc.go`), expanded README, and subpackage docs for `dbxm` / `dbxp`.
|
||||
- Comprehensive tests for KSUID types, CRUD helpers, column utilities, and module lifecycle.
|
||||
|
||||
### Changed
|
||||
|
||||
- Debug logger setup returns an error instead of panicking when `DebugLog` is enabled without a dialect logger blank import.
|
||||
- `DestName` skips logging when the database module is not initialized.
|
||||
- Source reorganized into domain-focused files (`query.go`, `exec.go`, `apply.go`, etc.).
|
||||
Reference in New Issue
Block a user