reform
A better ORM for Go, based on non-empty interfaces and code generation via go generate.
What is reform?
reform is an ORM (Object-Relational Mapper) for Go and the standard `database/sql` package. It provides a type-safe, idiomatic alternative to traditional Go ORMs by leveraging Go's type system and code generation, avoiding runtime reflection and empty interfaces. This approach results in better performance, compile-time safety, and clearer APIs for database interactions.
Go developers building applications that require type-safe, performant database interactions with PostgreSQL, MySQL, SQLite3, or Microsoft SQL Server. It is suited for teams prioritizing compile-time checks and idiomatic Go design over runtime flexibility.
Developers choose reform over other Go ORMs because it eliminates runtime reflection and empty interfaces (`interface{}`), using code generation and non-empty interfaces for full compiler validation and better tooling support. Its focus on simplicity and leveraging Go's native type system provides a more predictable and efficient database layer.
Overview
A better ORM for Go, based on non-empty interfaces and code generation.
Use Cases
Best For
- Building Go applications that require compile-time type safety for database operations, avoiding runtime errors common with reflective ORMs.
- Generating boilerplate code for existing database schemas using the `reform-db` command to quickly scaffold type-safe models.
- Implementing CRUD operations with straightforward methods like `Save`, `FindByPrimaryKey`, `FindAll`, and `Delete` across supported SQL dialects (PostgreSQL, MySQL, SQLite3, Microsoft SQL Server).
- Working with nullable database fields using Go pointers or `sql.NullXXX` types without sacrificing type safety.
- Integrating database layers in projects where performance is critical, as reform's code generation minimizes runtime overhead compared to reflection-based ORMs.
- Developing in teams that value idiomatic Go APIs and clear documentation, as reform's design avoids the pitfalls of type system sidestepping.
Not Ideal For
- Applications requiring composite primary keys, as reform explicitly does not support them.
- Projects that rely on dynamic, runtime-generated SQL queries without pre-defined models, since reform's type-safe approach depends on code generation.
- Teams needing built-in database migration tools, as reform focuses solely on ORM functionality without schema management features.
- Systems with frequent database schema changes that demand automatic model updates, as reform requires manual regeneration of code after schema alterations.
Pros & Cons
Pros
Uses non-empty interfaces instead of `interface{}`, enabling full compiler checks and better IDE support, which catches errors early as described in the README's philosophy.
Generates boilerplate via `go generate` or the `reform` command, eliminating runtime reflection for better performance and compile-time validation, as highlighted in the key features.
Supports PostgreSQL, MySQL, SQLite3, and MS SQL Server with stable, tested drivers, ensuring reliable cross-database use as detailed in the README's dialect table.
Provides simple methods like Save, FindByPrimaryKey, and Delete for common operations, making database interactions straightforward and Go-idiomatic, as shown in the quickstart example.
Cons
reform explicitly does not support composite primary keys, limiting its use with databases that rely on multi-column primary keys, as stated in the caveats section.
Changes to the database schema require regenerating models with `go generate` or the reform command, adding manual steps and potential sync issues in evolving projects.
While efficient for basic CRUD, reform lacks built-in support for complex joins, aggregations, or subqueries, often necessitating raw SQL for advanced operations beyond its simple API.
Frequently Asked Questions
Related Projects
GORMThe fantastic ORM library for Golang, aims to be developer friendly
entAn entity framework for Go
SQLBoilerGenerate a Go ORM tailored to your database schema.
bunSQL-first Golang ORM
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.