Popularity
7.0
Growing
Activity
4.9
-
821
28
45

Description

A better ORM for Go.

It uses non-empty interfaces, code generation (go generate) and initialization-time reflection as opposed to interface{} and runtime reflection. It will be kept simple.

Programming language: Go
Tags: SQL     Database     ORM     Code Generation    
Latest version: v1.3.3

reform alternatives and similar packages

Based on the "ORM" category

Do you think we are missing an alternative of reform or a related project?

Add another 'ORM' Package

README

reform

Release GoDoc Gitter Travis CI Build Status AppVeyor Build status Coverage Report Go Report Card GolangCI

A better ORM for Go and database/sql.

It uses non-empty interfaces, code generation (go generate), and initialization-time reflection as opposed to interface{}, type system sidestepping, and runtime reflection. It will be kept simple.

Supported SQL dialects:

RDBMS Library and drivers Status
PostgreSQL github.com/lib/pq (postgres) Stable. Tested with all supported versions.
github.com/jackc/pgx/stdlib (pgx) Stable. Tested with all supported versions.
MySQL github.com/go-sql-driver/mysql (mysql) Stable. Tested with all supported versions.
SQLite3 github.com/mattn/go-sqlite3 (sqlite3) Stable.
Microsoft SQL Server github.com/denisenkom/go-mssqldb (sqlserver, mssql) Stable. Tested on Windows with: SQL2008R2SP2, SQL2012SP1, SQL2014, SQL2016. On Linux with: microsoft/mssql-server-linux:latest Docker image.

Notes:

Quickstart

  1. Make sure you are using Go 1.10+. Install or update reform package, reform and reform-db commands (see about versioning below):

    go get -u gopkg.in/reform.v1/...
    
  2. Use reform-db command to generate models for your existing database schema. For example:

    reform-db -db-driver=sqlite3 -db-source=example.sqlite3 init
    
  3. Update generated models or write your own – struct representing a table or view row. For example, store this in file person.go:

    //go:generate reform
    
    //reform:people
    type Person struct {
        ID        int32      `reform:"id,pk"`
        Name      string     `reform:"name"`
        Email     *string    `reform:"email"`
        CreatedAt time.Time  `reform:"created_at"`
        UpdatedAt *time.Time `reform:"updated_at"`
    }
    

    Magic comment //reform:people links this model to people table or view in SQL database. The first value in field's reform tag is a column name. pk marks primary key. Use value - or omit tag completely to skip a field. Use pointers (recommended) or sql.NullXXX types for nullable fields.

  4. Run reform [package or directory] or go generate [package or file]. This will create person_reform.go in the same package with type PersonTable and methods on Person.

  5. See documentation how to use it. Simple example:

    // Use reform.NewDB to create DB.
    
    // Save record (performs INSERT or UPDATE).
    person := &Person{
        Name:  "Alexey Palazhchenko",
        Email: pointer.ToString("alexey.palazhchenko@gmail.com"),
    }
    if err := DB.Save(person); err != nil {
        log.Fatal(err)
    }
    
    // ID is filled by Save.
    person2, err := DB.FindByPrimaryKeyFrom(PersonTable, person.ID)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(person2.(*Person).Name)
    
    // Delete record.
    if err = DB.Delete(person); err != nil {
        log.Fatal(err)
    }
    
    // Find records by IDs.
    persons, err := DB.FindAllFrom(PersonTable, "id", 1, 2)
    if err != nil {
        log.Fatal(err)
    }
    for _, p := range persons {
        fmt.Println(p)
    }
    

Background

reform was born during summer 2014 out of frustrations with existing Go ORMs. All of them have a method Save(record interface{}) which can be used like this:

orm.Save(User{Name: "gopher"})
orm.Save(&User{Name: "gopher"})
orm.Save(nil)
orm.Save("Batman!!")

Now you can say that last invocation is obviously invalid, and that it's not hard to make an ORM to accept both first and second versions. But there are two problems:

  1. Compiler can't check it. Method's signature in godoc will not tell us how to use it. We are essentially working against those tools by sidestepping type system.
  2. First version is still invalid, since one would expect Save() method to set record's primary key after INSERT, but this change will be lost due to passing by value.

First proprietary version of reform was used in production even before go generate announcement. This free and open-source version is the fourth milestone on the road to better and idiomatic API.

Versioning policy

We are following Semantic Versioning, using gopkg.in and filling a [changelog](CHANGELOG.md).

We use branch v1-stable (default on Github) for v1 development and tags v1.Y.Z for releases. All v1 releases are SemVer-compatible, breaking changes will not be applied. Canonical import path is gopkg.in/reform.v1. go get -u gopkg.in/reform.v1/... will install the latest released version. To install not yet released v1 version one can do checkout manually while preserving import path:

cd $GOPATH/src/gopkg.in/reform.v1
git fetch
git checkout origin/v1-stable
go install -v gopkg.in/reform.v1/reform

Additional packages

Caveats and limitations

  • There should be zero pk fields for Struct and exactly one pk field for Record. Composite primary keys are not supported (#114).
  • pk field can't be a pointer (== nil doesn't work).
  • Database row can't have a Go's zero value (0, empty string, etc.) in primary key column.

License

Code is covered by standard MIT-style license. Copyright (c) 2016-2018 Alexey Palazhchenko. See [LICENSE](LICENSE) for details. Note that generated code is covered by the terms of your choice.

The reform gopher was drawn by Natalya Glebova. Please use it only as reform logo. It is based on the original design by Renée French, released under Creative Commons Attribution 3.0 USA license.

Contributing

See [Contributing Guidelines](.github/CONTRIBUTING.md).


*Note that all licence references and agreements mentioned in the reform README section above are relevant to that project's source code only.