migrations

package

v2.0.0-alpha.14 Latest Latest Go to latest Published: Jul 21, 2020 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package migrations implements the migrations subcommand structure.

This section is empty.

This section is empty.

func GenerateMigrationPlan(
	db *store.Context,
	direction types.Direction,
	migrations *types.Migrations,
) ([]*types.Migration, error)

GenerateMigrationPlan creates a migration plan based on difference with the current state recorded on the database and direction.

type Down struct {
	Driver interface {
		driver.WithMigrations
		driver.WithSource
	} `json:"driver" yaml:"driver"`
}

Down represents the database migration down command object.

func (r Down) Execute(name string, out io.Writer, args []string) error

Execute runs the command.

func (r Down) NewCommand(ctx context.Context, name string) *cobra.Command

NewCommand creates a new cobra.Command, configures it and returns it.

type Generate struct {
	Driver interface {
		driver.WithMigrations
		driver.WithSource
	} `json:"driver" yaml:"driver"`
}

Generate represents the generate command which allows for generating new templates of the database migrations file.

func (r Generate) Execute(name string, out io.Writer, args []string) error

Execute runs the command.

func (r Generate) NewCommand(ctx context.Context, name string) *cobra.Command

NewCommand returns a new cobra.Command generate command object.

type Report struct {
	Driver interface {
		driver.WithMigrations
		driver.WithSource
	} `json:"driver" yaml:"driver"`
}

Report represents the database migration report command object.

func (r Report) Execute(name string, out io.Writer, args []string) error

Execute runs the command.

func (r Report) NewCommand(ctx context.Context, name string) *cobra.Command

NewCommand creates a new cobra.Command, configures it and returns it.

type Up struct {
	Driver interface {
		driver.WithMigrations
		driver.WithSource
	} `json:"driver" yaml:"driver"`
}

Up represents the database up command object.

func (r Up) Execute(name string, out io.Writer, args []string) error

Execute runs the command.

func (r Up) NewCommand(ctx context.Context, name string) *cobra.Command

NewCommand creates a new cobra.Command, configures it and returns it.