migration

package

v0.32.0 Latest Latest Go to latest Published: Jun 16, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Package migration helps with migrating deprecated config options.

`panic` is only used for programmer errors, meaning they will only trigger during development.

This section is empty.

This section is empty.

func Migrate(logger *logrus.Entry, optPrefix string, deprecated any, newOptions map[string]Migrator) bool

Migrate checks each field of `deprecated` to see if a migration can and should be run.

Each field must be a pointer: this allows knowing if the user has set a value in the config.

type Dest struct {
	Value   reflect.Value
	Default any
	// contains filtered or unexported fields
}

func To[T any](newName string, newContainerStruct *T) *Dest

To creates a new `Dest` from an option name (relative to the `Migrate` prefix) and the struct containing that option.

func (d *Dest) IsDefault() bool

func (d *Dest) Name() string

func (d *Dest) String() string

type Migrator struct {
	// contains filtered or unexported fields
}

func Apply[T any](dest *Dest, apply func(oldValue T)) Migrator

Apply calls `apply` with the deprecated value casted to `T`.

func Move(dest *Dest) Migrator

Move copies the deprecated option's value to `dest`.