1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
// Copyright 2021-present The Atlas Authors. All rights reserved.
// This source code is licensed under the Apache 2.0 license found
// in the LICENSE file in the root directory of this source tree.
package sqlx
import (
"context"
"database/sql"
"errors"
"fmt"
"sort"
"ariga.io/atlas/sql/migrate"
"ariga.io/atlas/sql/schema"
)
type execPlanner interface {
ExecContext(context.Context, string, ...any) (sql.Result, error)
PlanChanges(context.Context, string, []schema.Change, ...migrate.PlanOption) (*migrate.Plan, error)
}
// ApplyChanges is a helper used by the different drivers to apply changes.
func ApplyChanges(ctx context.Context, changes []schema.Change, p execPlanner, opts ...migrate.PlanOption) error {
plan, err := p.PlanChanges(ctx, "apply", changes, opts...)
if err != nil {
return err
}
for _, c := range plan.Changes {
if _, err := p.ExecContext(ctx, c.Cmd, c.Args...); err != nil {
if c.Comment != "" {
err = fmt.Errorf("%s: %w", c.Comment, err)
}
return err
}
}
return nil
}
// DetachCycles takes a list of schema changes, and detaches
// references between changes if there is at least one circular
// reference in the changeset. More explicitly, it postpones fks
// creation, or deletes fks before deletes their tables.
func DetachCycles(changes []schema.Change) ([]schema.Change, error) {
sorted, err := sortMap(changes)
if err == errCycle {
return detachReferences(changes), nil
}
if err != nil {
return nil, err
}
planned := make([]schema.Change, len(changes))
copy(planned, changes)
sort.Slice(planned, func(i, j int) bool {
return sorted[table(planned[i])] < sorted[table(planned[j])]
})
return planned, nil
}
// detachReferences detaches all table references.
func detachReferences(changes []schema.Change) []schema.Change {
var planned, deferred []schema.Change
for _, change := range changes {
switch change := change.(type) {
case *schema.AddTable:
var (
ext []schema.Change
self []*schema.ForeignKey
)
for _, fk := range change.T.ForeignKeys {
if fk.RefTable == change.T {
self = append(self, fk)
} else {
ext = append(ext, &schema.AddForeignKey{F: fk})
}
}
if len(ext) > 0 {
deferred = append(deferred, &schema.ModifyTable{T: change.T, Changes: ext})
t := *change.T
t.ForeignKeys = self
change = &schema.AddTable{T: &t, Extra: change.Extra}
}
planned = append(planned, change)
case *schema.DropTable:
var fks []schema.Change
for _, fk := range change.T.ForeignKeys {
if fk.RefTable != change.T {
fks = append(fks, &schema.DropForeignKey{F: fk})
}
}
if len(fks) > 0 {
planned = append(planned, &schema.ModifyTable{T: change.T, Changes: fks})
t := *change.T
t.ForeignKeys = nil
change = &schema.DropTable{T: &t, Extra: change.Extra}
}
deferred = append(deferred, change)
case *schema.ModifyTable:
var fks, rest []schema.Change
for _, c := range change.Changes {
switch c := c.(type) {
case *schema.AddForeignKey:
fks = append(fks, c)
default:
rest = append(rest, c)
}
}
if len(fks) > 0 {
deferred = append(deferred, &schema.ModifyTable{T: change.T, Changes: fks})
}
if len(rest) > 0 {
planned = append(planned, &schema.ModifyTable{T: change.T, Changes: rest})
}
default:
planned = append(planned, change)
}
}
return append(planned, deferred...)
}
// errCycle is an internal error to indicate a case of a cycle.
var errCycle = errors.New("cycle detected")
// sortMap returns an index-map indicates the position of table in a topological
// sort in reversed order based on its references, and a boolean indicate if there
// is a non-self loop.
func sortMap(changes []schema.Change) (map[string]int, error) {
var (
visit func(string) bool
sorted = make(map[string]int)
progress = make(map[string]bool)
deps, err = dependencies(changes)
)
if err != nil {
return nil, err
}
visit = func(name string) bool {
if _, done := sorted[name]; done {
return false
}
if progress[name] {
return true
}
progress[name] = true
for _, ref := range deps[name] {
if visit(ref.Name) {
return true
}
}
delete(progress, name)
sorted[name] = len(sorted)
return false
}
for node := range deps {
if visit(node) {
return nil, errCycle
}
}
return sorted, nil
}
// dependencies returned an adjacency list of all tables and the table they depend on
func dependencies(changes []schema.Change) (map[string][]*schema.Table, error) {
deps := make(map[string][]*schema.Table)
for _, change := range changes {
switch change := change.(type) {
case *schema.AddTable:
for _, fk := range change.T.ForeignKeys {
if err := checkFK(fk); err != nil {
return nil, err
}
if fk.RefTable != change.T {
deps[change.T.Name] = append(deps[change.T.Name], fk.RefTable)
}
}
case *schema.DropTable:
for _, fk := range change.T.ForeignKeys {
if err := checkFK(fk); err != nil {
return nil, err
}
if isDropped(changes, fk.RefTable) {
deps[fk.RefTable.Name] = append(deps[fk.RefTable.Name], fk.Table)
}
}
case *schema.ModifyTable:
for _, c := range change.Changes {
switch c := c.(type) {
case *schema.AddForeignKey:
if err := checkFK(c.F); err != nil {
return nil, err
}
if c.F.RefTable != change.T {
deps[change.T.Name] = append(deps[change.T.Name], c.F.RefTable)
}
case *schema.ModifyForeignKey:
if err := checkFK(c.To); err != nil {
return nil, err
}
if c.To.RefTable != change.T {
deps[change.T.Name] = append(deps[change.T.Name], c.To.RefTable)
}
}
}
}
}
return deps, nil
}
func checkFK(fk *schema.ForeignKey) error {
var cause []string
if fk.Table == nil {
cause = append(cause, "child table")
}
if len(fk.Columns) == 0 {
cause = append(cause, "child columns")
}
if fk.RefTable == nil {
cause = append(cause, "parent table")
}
if len(fk.RefColumns) == 0 {
cause = append(cause, "parent columns")
}
if len(cause) != 0 {
return fmt.Errorf("missing %q for foreign key: %q", cause, fk.Symbol)
}
return nil
}
// table extracts a table from the given change.
func table(change schema.Change) (t string) {
switch change := change.(type) {
case *schema.AddTable:
t = change.T.Name
case *schema.DropTable:
t = change.T.Name
case *schema.ModifyTable:
t = change.T.Name
}
return
}
// isDropped checks if the given table is marked as a deleted in the changeset.
func isDropped(changes []schema.Change, t *schema.Table) bool {
for _, c := range changes {
if c, ok := c.(*schema.DropTable); ok && c.T.Name == t.Name {
return true
}
}
return false
}
// CheckChangesScope checks that changes can be applied
// on a schema scope (connection).
func CheckChangesScope(changes []schema.Change) error {
names := make(map[string]struct{})
for _, c := range changes {
var t *schema.Table
switch c := c.(type) {
case *schema.AddSchema, *schema.ModifySchema, *schema.DropSchema:
return fmt.Errorf("%T is not allowed when migration plan is scoped to one schema", c)
case *schema.AddTable:
t = c.T
case *schema.ModifyTable:
t = c.T
case *schema.DropTable:
t = c.T
default:
continue
}
if t.Schema != nil && t.Schema.Name != "" {
names[t.Schema.Name] = struct{}{}
}
for _, c := range t.Columns {
e, ok := c.Type.Type.(*schema.EnumType)
if ok && e.Schema != nil && e.Schema.Name != "" {
names[t.Schema.Name] = struct{}{}
}
}
}
if len(names) > 1 {
return fmt.Errorf("found %d schemas when migration plan is scoped to one", len(names))
}
return nil
}
|