entlite

Entlite

Entity-first generator for SQLC and Proto files. Maps DB and Protobuf types automatically to maintain a single source of truth in Go services.

Documentation: docs/ — getting started, reference, examples.

TODO

• Wire buf lint into the pipeline, it needs the proto package and rpc response type decisions first

• Implement DefaultFunc for sql generation

• Explore google AIP https://google.aip.dev/ - read it through first and decide which parts fit, query and rpc naming is the open one

• Add mcp for visual testing of examples/

• Fix Optional() with Validate() - generated code passes a pointer to a value func and does not compile

• Fix Time().Optional() on postgres/mysql - sqlToGo/goFromSQL have no time case, sqlc gives sql.NullTime but the wrapper declares *time.Time, so the converter does not compile. Needs a NullTimeToPtr helper

• Add postgres and mysql optional examples

• Fix filter.Optional() - it only makes the proto field optional, the sql keeps a plain comparison, so an omitted value filters on the zero value instead of being skipped. Needs sqlc.narg() with an IS NULL guard. The doc comment and the 03-optional readme both claim it is skipped

• Implement Queries Having()

• Aggregate a row count per group, Count() already means the total next to a page

• Min()/Max() of a time column, sqlite cannot cast a timestamp back, postgres and mysql can

• DeleteBy(...) query

• Create queries example with complicated edge case queries

• Figure out enums

• Create /internal/naming/ to have in one place consistant naming

• Figure out migration

Folder structure

ent/
├── schema/            # you write: one file per entity
├── logic/             # you write: Go funcs for DefaultFunc and Validate
├── contract/          # the input for sqlc and buf
│   ├── proto/         # generated: schema.proto, plus your custom .proto
│   └── sqlc/          # generated: schema.sql, queries.sql, plus your custom .sql
├── gen/               # the output, rewritten on every run
│   ├── db/            # generated: typed wrapper, pointers instead of null types
│   │   └── internal/  # generated: raw sqlc output, never import it
│   ├── pb/            # generated: proto messages and the connect service
│   └── ts/            # generated: TypeScript client
├── buf.yaml
├── buf.gen.yaml
├── buf.lock
├── sqlc.yaml          # dialect and sqlc settings
└── generate.go        # the go:generate lines that run the pipeline

Get started

sql dialect flag: postgresql (default) or sqlite or mysql arguments: entity names

go run github.com/guntisdev/entlite/cmd/entlite new --dialect sqlite User Post

Examples

Launch example

Each example has a Makefile that generates types, bundles the JavaScript and starts the web server

cd examples/01-basic-entity/sqlite
make run

The postgresql and mysql variants run their database from docker-compose.yml, make run starts it and waits until it is ready. Use make down to stop it and drop its data

cd examples/01-basic-entity/postgresql
make run

Individual steps are available as make gen, make web and (for postgresql/mysql) make db. make clean removes node_modules, the bundle and the database

Doing it by hand, generate types

cd examples/01-basic-entity/sqlite
cd ent/
go generate

Build JavaScript

cd web/
npm install
npm run build

Run go web server

go run main.go

Release

# Tag and push version
git tag v0.0.3
git push origin v0.0.3

# Force Go proxy cache update
GOPROXY=https://proxy.golang.org GOPRIVATE= go list -m github.com/guntisdev/entlite@v0.0.3

# Update CLI tool & library dependencies in projects
go install github.com/guntisdev/entlite/cmd/entlite@v0.0.3
go get github.com/guntisdev/entlite@v0.0.3