migrations

Documentation

Overview

Package migrations implements upgrade migration handlers.

Index

• Constants
• Variables
• func Register(name string, handler Handler)
• type Context
  • func NewContext(upgrade *upgradeApi.PendingUpgrade, dataDir string) *Context
• type Handler
  • func GetHandler(name string) (Handler, error)

Constants

const (
	// DummyUpgradeHandler is the name of the dummy upgrade, for use in the upgrade descriptor.
	DummyUpgradeHandler = "__e2e-test-valid"
)

const (
	// ModuleName is the migration module name.
	ModuleName = "upgrade-migrations"
)

Variables

var (

	// ErrMissingMigrationHandler is error returned when a migration handler is not registered.
	ErrMissingMigrationHandler = fmt.Errorf("missing migration handler")
)

var (
	TestEntity entity.Entity
)

Functions

func Register

func Register(name string, handler Handler)

Register registers a new migration handler, by upgrade name.

Types

type Context

type Context struct {
	// Upgrade is the currently pending upgrade structure.
	Upgrade *upgradeApi.PendingUpgrade

	// DataDir is the node's data directory.
	DataDir string

	Logger *logging.Logger
}

Context defines the common context used by migration handlers.

func NewContext

func NewContext(upgrade *upgradeApi.PendingUpgrade, dataDir string) *Context

NewContext returns a new upgrade migration context.

type Handler

type Handler interface {
	// StartupUpgrade is called by the upgrade manager to perform
	// the node startup portion of the upgrade.
	StartupUpgrade(*Context) error

	// ConsensusUpgrade is called by the upgrade manager to perform
	// the consensus portion of the upgrade. The interface argument is
	// a private structure passed to Backend.ConsensusUpgrade by the
	// consensus backend.
	//
	// This method will be called twice, once in BeginBlock and once in
	// EndBlock.
	ConsensusUpgrade(*Context, interface{}) error
}

Handler is the interface used by migration handlers.

func GetHandler

func GetHandler(name string) (Handler, error)

GetHandler returns the handler associated with the upgrade described in the context.