GOMODULES
/
goose
mirror of https://github.com/pressly/goose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: improve optimization comment

pull/820/head
Mike Fridman 2024-09-03 09:45:57 -04:00
parent 929ea3ab72
commit 198457304d
No known key found for this signature in database
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
provider.go
View File

@ -360,10 +360,18 @@ func (p *Provider) up(
} }
apply = p.migrations apply = p.migrations
} else { } else {
// optimize(mf): Listing all migrations from the database isn't great. This is only required // optimize(mf): Listing all migrations from the database isn't great.
// to support the allow missing (out-of-order) feature. For users that don't use this //
// feature, we could just query the database for the current max version and then apply // The ideal implementation would be to query for the current max version and then apply
// migrations greater than that version. // migrations greater than that version. However, a nice property of the current
// implementation is that we can make stronger guarantees about unapplied migrations.
//
// In cases where users do not use out-of-order migrations, we want to surface an error if
// there are older unapplied migrations. See https://github.com/pressly/goose/issues/761 for
// more details.
//
// And in cases where users do use out-of-order migrations, we need to build a list of older
// migrations that need to be applied, so we need to query for all migrations anyways.
dbMigrations, err := p.store.ListMigrations(ctx, conn) dbMigrations, err := p.store.ListMigrations(ctx, conn)
if err != nil { if err != nil {
return nil, err return nil, err