migrate

package

v0.4.0 Latest Latest Go to latest Published: Jan 5, 2021 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wawandco/oxplugins

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DownPlugin(configFile io.Reader, migrations packd.Walkable) plugins.Plugin
func UpPlugin(configFile io.Reader, migrations packd.Walkable) plugins.Plugin
type MigrateDown
type MigrateUp
type Migrator
type Plugin

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCouldNotFindConnection = errors.New("could not find connection by name")
	ErrNotEnoughArgs          = errors.New("not enough args, please specify direction p.e ox pop migrate up")
	ErrInvalidInstruction     = errors.New("invalid instruction for migrate command")
)

Functions ¶

func DownPlugin ¶ added in v0.4.0

func DownPlugin(configFile io.Reader, migrations packd.Walkable) plugins.Plugin

func UpPlugin ¶ added in v0.4.0

func UpPlugin(configFile io.Reader, migrations packd.Walkable) plugins.Plugin

Types ¶

type MigrateDown ¶

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

func (*MigrateDown) Flags ¶

func (mu *MigrateDown) Flags() *pflag.FlagSet

func (MigrateDown) HelpText ¶ added in v0.4.0

func (mu MigrateDown) HelpText() string

func (MigrateDown) Name ¶

func (mu MigrateDown) Name() string

func (MigrateDown) ParentName ¶ added in v0.4.0

func (mu MigrateDown) ParentName() string

func (*MigrateDown) ParseFlags ¶

func (mu *MigrateDown) ParseFlags(args []string)

func (*MigrateDown) Run ¶ added in v0.4.0

func (mu *MigrateDown) Run(ctx context.Context, root string, args []string) error

Run will run migrations on the current folder, it will look for the migrations folder and attempt to run the migrations using internal pop tooling

type MigrateUp ¶

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

func (*MigrateUp) Flags ¶

func (mu *MigrateUp) Flags() *pflag.FlagSet

func (MigrateUp) HelpText ¶ added in v0.4.0

func (mu MigrateUp) HelpText() string

func (MigrateUp) Name ¶

func (mu MigrateUp) Name() string

func (MigrateUp) ParentName ¶ added in v0.4.0

func (mu MigrateUp) ParentName() string

func (*MigrateUp) ParseFlags ¶

func (mu *MigrateUp) ParseFlags(args []string)

func (*MigrateUp) Run ¶ added in v0.4.0

func (mu *MigrateUp) Run(ctx context.Context, root string, args []string) error

Run will run migrations on the current folder, it will look for the migrations folder and attempt to run the migrations using internal pop tooling

type Migrator ¶

type Migrator interface {
	CommandName() string
	RunMigrations(ctx context.Context, root string, args []string) error
}

Migrator type allows to identify migration runner plugins.

type Plugin ¶

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

func (Plugin) HelpText ¶

func (m Plugin) HelpText() string

HelpText resturns the help Text of build function

func (*Plugin) Name ¶

func (m *Plugin) Name() string

func (*Plugin) ParentName ¶

func (m *Plugin) ParentName() string

func (*Plugin) Receive ¶

func (m *Plugin) Receive(pls []plugins.Plugin)

func (*Plugin) Run ¶

func (m *Plugin) Run(ctx context.Context, root string, args []string) error

func (*Plugin) Subcommands ¶ added in v0.4.0

func (m *Plugin) Subcommands() []plugins.Command

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL