migration

Documentation

Index

• Constants
• func CancelStep(ctx context.Context, es *eventstore.Eventstore, step *SetupStep) error
• func Migrate(ctx context.Context, es *eventstore.Eventstore, migration Migration) (err error)
• func SetupMapper(event eventstore.Event) (eventstore.Event, error)
• type Migration
• type RepeatableMigration
• type SetupStep
  • func LastStuckStep(ctx context.Context, es *eventstore.Eventstore) (*SetupStep, error)
  • func (s *SetupStep) Payload() interface{}
  • func (s *SetupStep) UniqueConstraints() []*eventstore.UniqueConstraint
• type Step
• type StepState
• type StepStates
  • func (*StepStates) Query() *eventstore.SearchQueryBuilder
  • func (s *StepStates) Reduce() error

Constants

const (
	StartedType = eventstore.EventType("system.migration.started")
	DoneType    = eventstore.EventType("system.migration.done")

	SystemAggregate   = eventstore.AggregateType("system")
	SystemAggregateID = "SYSTEM"
)

Functions

func CancelStep

func CancelStep(ctx context.Context, es *eventstore.Eventstore, step *SetupStep) error

func Migrate

func Migrate(ctx context.Context, es *eventstore.Eventstore, migration Migration) (err error)

func SetupMapper

func SetupMapper(event eventstore.Event) (eventstore.Event, error)

Types

type Migration

type Migration interface {
	String() string
	Execute(ctx context.Context, startedEvent eventstore.Event) error
}

type RepeatableMigration

type RepeatableMigration interface {
	Migration
	Check(lastRun map[string]interface{}) bool
}

type SetupStep

type SetupStep struct {
	eventstore.BaseEvent `json:"-"`

	Name    string `json:"name"`
	Error   any    `json:"error,omitempty"`
	LastRun any    `json:"lastRun,omitempty"`
	// contains filtered or unexported fields
}

SetupStep is the command pushed on the eventstore

func LastStuckStep

func LastStuckStep(ctx context.Context, es *eventstore.Eventstore) (*SetupStep, error)

func (*SetupStep) Payload

func (s *SetupStep) Payload() interface{}

func (*SetupStep) UniqueConstraints

func (s *SetupStep) UniqueConstraints() []*eventstore.UniqueConstraint

type Step

type Step struct {
	*SetupStep
	// contains filtered or unexported fields
}

type StepState

type StepState int32

const (
	StepStarted StepState = iota
	StepDone
	StepFailed
)

type StepStates

type StepStates struct {
	eventstore.ReadModel
	Steps []*Step
}

func (*StepStates) Query

func (*StepStates) Query() *eventstore.SearchQueryBuilder

Query implements eventstore.QueryReducer.

func (*StepStates) Reduce

func (s *StepStates) Reduce() error

Reduce implements eventstore.QueryReducer.