Thanks to visit codestin.com
Credit goes to github.com

Skip to content

doc: remove references to removed WithAtlas option #4473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
takanakahiko wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: remove references to removed WithAtlas option #4473

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 5 additions & 41 deletions doc/md/migrate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,49 +225,13 @@ func main() {
}
```

## Atlas Integration
### `Diff` and `Apply` Hooks

Starting with v0.10, Ent supports running migration with [Atlas](https://atlasgo.io), which is a more robust
migration framework that covers many features that are not supported by current Ent migrate package. In order
to execute a migration with the Atlas engine, use the `WithAtlas(true)` option.

```go {21}
package main

import (
"context"
"log"

"<project>/ent"
"<project>/ent/migrate"

"entgo.io/ent/dialect/sql/schema"
)

func main() {
client, err := ent.Open("mysql", "root:pass@tcp(localhost:3306)/test")
if err != nil {
log.Fatalf("failed connecting to mysql: %v", err)
}
defer client.Close()
ctx := context.Background()
// Run migration.
err = client.Schema.Create(ctx, schema.WithAtlas(true))
if err != nil {
log.Fatalf("failed creating schema resources: %v", err)
}
}
```

In addition to the standard options (e.g. `WithDropColumn`, `WithGlobalUniqueID`), the Atlas integration provides additional
options for hooking into schema migration steps.
Ent also provides hooks to intercept and modify the `Diff` and `Apply` steps of the migration process.

![atlas-migration-process](https://entgo.io/images/assets/migrate-atlas-process.png)


#### Atlas `Diff` and `Apply` Hooks

Here are two examples that show how to hook into the Atlas `Diff` and `Apply` steps.
Here are two examples that show how to hook into the `Diff` and `Apply` steps.

```go
package main
Expand Down Expand Up @@ -331,7 +295,7 @@ func main() {
}
```

#### `Diff` Hook Example
### `Diff` Hook Example

In case a field was renamed in the `ent/schema`, Ent won't detect this change as renaming and will propose `DropColumn`
and `AddColumn` changes in the diff stage. One way to get over this is to use the
Expand Down Expand Up @@ -384,7 +348,7 @@ func renameColumnHook(next schema.Differ) schema.Differ {
}
```

#### `Apply` Hook Example
### `Apply` Hook Example

The `Apply` hook allows accessing and mutating the migration plan and its raw changes (SQL statements), but in addition
to that it is also useful for executing custom SQL statements before or after the plan is applied. For example, changing
Expand Down