Gorma is a storage generator for goa.
Gorma uses a custom goa
DSL to generate a working storage system for your API.
Gorma generates Go code that uses gorm to access your database, therefore it is quite opinionated about how the data access layer is generated.
By default, a primary key field is created as type int
with name ID. Also Gorm's magic date stamp fields created_at
, updated_at
and deleted_at
are created. Override this behavior with the Automatic* DSL functions on the Store.
Write a storage definition using DSL from the dsl
package. Example:
var sg = StorageGroup("MyStorageGroup", func() {
Description("This is the global storage group")
Store("mysql", gorma.MySQL, func() {
Description("This is the mysql relational store")
Model("Bottle", func() {
BuiltFrom(BottlePayload)
RenderTo(Bottle)
Description("This is the bottle model")
Field("Vintage", gorma.Integer, func() {
SQLTag("index")
})
})
})
})
See the dsl
GoDoc for all the details and options.
From the root of your application, issue the goagen
command as follows:
goagen --design=github.com/gopheracademy/congo/design gen --pkg-path=github.com/goadesign/gorma
Be sure to replace github.com/gopheracademy/congo/design
with the design package of your goa
application.