migrationminion

Documentation

Index

• Variables
• type Client
  • func NewClient(caller base.APICaller, options ...Option) *Client
  • func (c *Client) Report(ctx context.Context, migrationId string, phase migration.Phase, success bool) error
  • func (c *Client) Watch(ctx context.Context) (watcher.MigrationStatusWatcher, error)
• type Option

Variables

var WithTracer = base.WithTracer

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

Types

type Client

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

func NewClient

func NewClient(caller base.APICaller, options ...Option) *Client

NewClient returns a new Client based on an existing API connection.

func (*Client) Report

func (c *Client) Report(ctx context.Context, migrationId string, phase migration.Phase, success bool) error

Report allows a migration minion to report if it successfully completed its activities for a given migration phase.

func (*Client) Watch

func (c *Client) Watch(ctx context.Context) (watcher.MigrationStatusWatcher, error)

Watch returns a watcher which reports when the status changes for the migration for the model associated with the API connection.

type Option

type Option = base.Option

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