migrationflag

Documentation

Index

• Variables
• type Facade
  • func NewFacade(apiCaller base.APICaller, newWatcher NewWatcherFunc, options ...Option) *Facade
  • func (facade *Facade) Phase(ctx context.Context, uuid string) (migration.Phase, error)
  • func (facade *Facade) Watch(ctx context.Context, uuid string) (watcher.NotifyWatcher, error)
• type NewWatcherFunc
• type Option

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

Types

type Facade

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

Facade lets a client watch and query a model's migration phase.

func NewFacade

func NewFacade(apiCaller base.APICaller, newWatcher NewWatcherFunc, options ...Option) *Facade

NewFacade returns a Facade backed by the supplied api caller.

func (*Facade) Phase

func (facade *Facade) Phase(ctx context.Context, uuid string) (migration.Phase, error)

Phase returns the current migration.Phase for the supplied model UUID.

func (*Facade) Watch

func (facade *Facade) Watch(ctx context.Context, uuid string) (watcher.NotifyWatcher, error)

Watch returns a NotifyWatcher that will inform of potential changes to the result of Phase for the supplied model UUID.

type NewWatcherFunc

type NewWatcherFunc func(base.APICaller, params.NotifyWatchResult) watcher.NotifyWatcher

NewWatcherFunc exists to let us unit test Facade without patching.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.