migrations

package

v1.3.3 Latest Latest Go to latest Published: Apr 1, 2024 License: GPL-3.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Run(ctx context.Context, logger *zap.Logger, opt Options) (applied int, err error)

Run executes the default migrations.

type CompletedFunc func(rw basedb.ReadWriter) error

CompletedFunc is a function that marks a migration as completed.

type Migration struct {
	Name string
	Run  MigrationFunc
}

Migration is a named MigrationFunc.

type MigrationFunc func(ctx context.Context, logger *zap.Logger, opt Options, key []byte, completed CompletedFunc) error

MigrationFunc is a function that performs a migration.

type Migrations []Migration

Migrations is a slice of named migrations, meant to be executed from first to last (order is significant).

func (m Migrations) Run(ctx context.Context, logger *zap.Logger, opt Options) (applied int, err error)

Run executes the migrations.

type Options struct {
	Db          basedb.Database
	NodeStorage operatorstorage.Storage
	DbPath      string
	Network     beacon.Network
}

Options is the options for running migrations.