How volatiletech/sqlboiler works
SQLBoiler is a database-first Go ORM generator. The principal workflow is to invoke its CLI with a database driver, inspect an existing schema, and generate tailored Go model code from templates. Generated models then provide typed query construction and database execution, with documented relationship/eager-loading, hooks, transaction, and custom database-type capabilities. The graph separates generation from the runtime support library. Some subsystem links are documented rather than directly visible in the sampled excerpts; those are marked dashed where implementation wiring is unverified.
Main entry points: interface.go Driver metadata API · main.go SQLBoiler CLI · boilingcore.go Generation state · output.go Output rendering
Components 22
Code generation
- SQLBoiler CLI
main.go - Generation state
boilingcore/boilingcore.go - Generation config
boilingcore/config.go - Template system
boilingcore/templates.go - Output rendering
boilingcore/output.go - Import mapping
importers/imports.go
Schema drivers
- Driver metadata API
drivers/interface.go - PostgreSQL driver
drivers/sqlboiler-psql/driver/psql.go - MySQL driver
drivers/sqlboiler-mysql/driver/mysql.go - MSSQL driver
drivers/sqlboiler-mssql/driver/mssql.go - SQLite driver
drivers/sqlboiler-sqlite3/driver/sqlite3.go
ORM runtime
- DB executor
boil/db.go - Query modifiers
queries/qm/query_mods.go - Query execution
queries/query.go - Eager loading
queries/eager_load.go - Model reflection
queries/reflect.go - Model hooks
boil/hooks.go
Database types
- Extended DB types
types/array.go - PostgreSQL geo types
types/pgeo/main.go
Other components
- Developer
- Existing database
- Generated Go models
Connections 26
- Developer → SQLBoiler CLI: runs
- SQLBoiler CLI → Driver metadata API: selects driver
main.go - SQLBoiler CLI → Generation state: starts generation
main.go - SQLBoiler CLI → Generation config: provides options
- PostgreSQL driver → Existing database: reads schema
drivers/sqlboiler-psql/driver/psql.go - MySQL driver → Existing database: reads schema
drivers/sqlboiler-mysql/driver/mysql.go - MSSQL driver → Existing database: reads schema
- SQLite driver → Existing database: reads schema
- Driver metadata API → PostgreSQL driver: defines contract
drivers/sqlboiler-psql/driver/psql.go - Driver metadata API → MySQL driver: defines contract
drivers/sqlboiler-mysql/driver/mysql.go - Driver metadata API → MSSQL driver: defines contract
drivers/sqlboiler-mssql/driver/mssql.go - Driver metadata API → SQLite driver: defines contract
drivers/sqlboiler-sqlite3/driver/sqlite3.go - Generation state → Driver metadata API: loads metadata
boilingcore/boilingcore.go - Generation state → Template system: uses templates
boilingcore/boilingcore.go - Generation state → Output rendering: generates files
boilingcore/boilingcore.go - Output rendering → Import mapping: formats imports
boilingcore/output.go - Output rendering → Generated Go models: writes code
- Generated Go models → Query modifiers: builds queries
- Query modifiers → Query execution: modifies query
queries/qm/query_mods.go - Query execution → DB executor: executes SQL
queries/query.go - Query execution → Driver metadata API: uses dialect
queries/query.go - Generated Go models → Eager loading: loads relations
- Generated Go models → Model hooks: runs hooks
- Generated Go models → Model reflection: maps records
- Generated Go models → Extended DB types: uses column types
- Generated Go models → PostgreSQL geo types: uses geo types