Load GORM schemas into an Atlas project.
- Declarative migrations - use a Terraform-like
atlas schema apply --env gormto apply your GORM schema to the database. - Automatic migration planning - use
atlas migrate diff --env gormto automatically plan a migration from
the current database version to the GORM schema.
Install Atlas from macOS or Linux by running:
curl -sSf https://atlasgo.sh | shSee atlasgo.io for more installation options.
Install the provider by running:
go get -u ariga.io/atlas-provider-gormIf all of your GORM models exist in a single package, and either embed gorm.Model or contain gorm struct tags,
you can use the provider directly to load your GORM schema into Atlas.
In your project directory, create a new file named atlas.hcl with the following contents:
data "external_schema" "gorm" {
program = [
"go",
"run",
"-mod=mod",
"ariga.io/atlas-provider-gorm",
"load",
"--path", "./path/to/models",
"--dialect", "mysql", // | postgres | sqlite
]
}
env "gorm" {
src = data.external_schema.gorm.url
dev = "docker://mysql/8/dev"
migration {
dir = "file://migrations"
}
format {
migrate {
diff = "{{ sql . \" \" }}"
}
}
}If you want to use the provider as a Go file, you can use the provider as follows:
Create a new program named loader/main.go with the following contents:
package main
import (
"io"
"os"
"ariga.io/atlas-provider-gorm/gormschema"
_ "ariga.io/atlas-go-sdk/recordriver"
"github.com/<yourorg>/<yourrepo>/path/to/models"
)
func main() {
stmts, err := gormschema.New("mysql").Load(&models.User{}, &models.Pet{})
if err != nil {
fmt.Fprintf(os.Stderr, "failed to load gorm schema: %v\n", err)
os.Exit(1)
}
io.WriteString(os.Stdout, stmts)
}In your project directory, cr
8A53
eate a new file named atlas.hcl with the following contents:
data "external_schema" "gorm" {
program = [
"go",
"run",
"-mod=mod",
"./loader",
]
}
env "gorm" {
src = data.external_schema.gorm.url
dev = "docker://mysql/8/dev"
migration {
dir = "file://migrations"
}
format {
migrate {
diff = "{{ sql . \" \" }}"
}
}
}To supply custom gorm.Config{} object to the provider use the Go Program Mode with
the WithConfig option. For example, to disable foreign keys:
loader := New("sqlite", WithConfig(
&gorm.Config{
DisableForeignKeyConstraintWhenMigrating: true,
},
))For a full list of options, see the GORM documentation.
Once you have the provider installed, you can use it to apply your GORM schema to the database:
You can use the atlas schema apply command to plan and apply a migration of your database to
your current GORM schema. This works by inspecting the target database and comparing it to the
GORM schema and creating a migration plan. Atlas will prompt you to confirm the migration plan
before applying it to the database.
atlas schema apply --env gorm -u "mysql://root:password@localhost:3306/mydb"Where the -u flag accepts the URL to the
target database.
Atlas supports a versioned migration
workflow, where each change to the database is versioned and recorded in a migration file. You can use the
atlas migrate diff command to automatically generate a migration file that will migrate the database
from its latest revision to the current GORM schema.
atlas migrate diff --env gorm The provider supports the following databases:
- MySQL
- PostgreSQL
- SQLite
This project is licensed under the Apache License 2.0.