Timothy Messier
79866a287f
This adds the ability to define hooks that will run prior to a schema migration. The hooks should only be used when a migration would fail due to data being in an invalid state, likely due to a bug in the previous schema definition. For example if a column was missing a constraint, and a new migration is attempting to add the constraint, there might already be values that violate the new constraint. In such cases, we would want the user to make a decision to address the data, and need to provide them with details about what data is problematic in case they want to manually address the problem. To help the user, if there is a sane way to address the data, we should provide an option to automatically "repair" the data, allowing the migration to continue. However, this still should be an explicit opt-in from the user, and we need to clearly describe what the repair option would do to the user so they understand the consequences of opting in. To accomplish this each migration can be provided a hook that contains a CheckFunc, RepairFunc, and RepairDescription. These functions must operate at the point-in-time of the migration immediately preceding the current migration, as as such they should not use and domain packages or repositories, instead they should use direct sql with the sql library. The description is used to explain what the RepairFunc will do. Hooks should be defined in `internal/db/schema/migrations/oss/oss.go` and registered with the schema edition. See the example in `internal/db/schema/manager_example_test.go` for more details.
49 lines
1.2 KiB
Go
49 lines
1.2 KiB
Go
package schema
|
|
|
|
import "github.com/hashicorp/boundary/internal/db/schema/internal/edition"
|
|
|
|
// getOpts - iterate the inbound Options and return a struct.
|
|
func getOpts(opt ...Option) options {
|
|
opts := getDefaultOptions()
|
|
for _, o := range opt {
|
|
o(&opts)
|
|
}
|
|
return opts
|
|
}
|
|
|
|
// Option - how Options are passed as arguments.
|
|
type Option func(*options)
|
|
|
|
// options = how options are represented
|
|
type options struct {
|
|
withEditions edition.Editions
|
|
withDeleteLog bool
|
|
withRepairMigrations map[string]map[int]bool
|
|
}
|
|
|
|
func getDefaultOptions() options {
|
|
return options{}
|
|
}
|
|
|
|
// WithEditions provides an optional migration states.
|
|
func WithEditions(editions edition.Editions) Option {
|
|
return func(o *options) {
|
|
o.withEditions = editions
|
|
}
|
|
}
|
|
|
|
// WithDeleteLog provides an option to specify the deletion of log entries.
|
|
func WithDeleteLog(del bool) Option {
|
|
return func(o *options) {
|
|
o.withDeleteLog = del
|
|
}
|
|
}
|
|
|
|
// WithRepairMigrations provides an option to specify the set of migrations
|
|
// that should run their repair functions if there is a failure on a prehook check.
|
|
func WithRepairMigrations(r RepairMigrations) Option {
|
|
return func(o *options) {
|
|
o.withRepairMigrations = r
|
|
}
|
|
}
|