golang/ent
1
0
Fork 0
mirror of https://github.com/ent/ent.git synced 2026-05-24 09:31:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc/website/blog: versioned migrations (#2387)

Browse Source 
* doc/md: clarify when feature flag is needed for versioned migrations

* doc/website/blog: introduction

* doc/md: more blog post

* Apply suggestions from code review

Co-authored-by: Hila Kashai <73284641+hilakashai@users.noreply.github.com>

* doc/website/blog: move explanation about versioned migration purpose up

* doc/website/blog: apply CR

* doc/website/blog: reword desription of versioned migrations

* doc/website/blog: typos

* doc/website/blog: last minute changes pre publish

Co-authored-by: Hila Kashai <73284641+hilakashai@users.noreply.github.com>
This commit is contained in:
MasseElch
2022-03-14 14:47:13 +01:00
committed by GitHub
parent 7328355e17
commit 41db628df3
2 changed files with 372 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/md/versioned-migrations.md
View File

@@ -10,10 +10,13 @@ tool you like (like golang-migrate, Flyway, liquibase).
![atlas-versioned-migration-process](https://entgo.io/images/assets/migrate-atlas-versioned.png)
## Configuration
## Generating Versioned Migration Files
In order to have Ent make the necessary changes to your code, you have to enable this feature with one of the two
options:
### From Client
If you want to use an instantiated Ent client to create new migration files, you have to enable the versioned
migrations feature flag in order to have Ent make the necessary changes to the generated code. Depending on how you
execute the Ent code generator, you have to use one of the two options:
1. If you are using the default go generate configuration, simply add the `--feature sql/versioned-migration` to
the `ent/generate.go` file as follows:
@@ -47,12 +50,8 @@ func main() {
}
```
## Generating Versioned Migration Files
### From Client
After regenerating the project, there will be an extra `Diff` method on the Ent client that you can use to inspect the
connected database, compare it with the schema definitions and create sql statements needed to migrate the database to
connected database, compare it with the schema definitions and create SQL statements needed to migrate the database to
the graph.
```go
@@ -95,7 +94,7 @@ You can then create a new set of migration files by simply calling `go run -mod=
### From Graph
You can also generate new migration files without an instantiated Ent client. This can be useful if you want to make the
migration file creation part of a go generate workflow.
migration file creation part of a go generate workflow. Note, that in this case enabling the feature flag is optional.
```go
package main