migrations

Documentation

Index

• type Config
  • func (c Config) Validate() error
• type DBDriver
  • func (d DBDriver) Valid() bool
• type Migration
  • func New(l initLogger, conf Config) (*Migration, error)
  • func (s *Migration) Down(ctx context.Context, steps int) error
  • func (s *Migration) Drop(ctx context.Context) error
  • func (s *Migration) Up(ctx context.Context, steps int) error
  • func (s *Migration) Version(ctx context.Context) (uint, bool, error)

Types

type Config

type Config struct {
	DBDriver            DBDriver
	Addr                string
	DBName              string
	User                string
	Password            string
	DisableConfirmation bool
}

func (Config) Validate

func (c Config) Validate() error

type DBDriver

type DBDriver string

const (
	DBDriverPostgres DBDriver = "postgres"
	DBDriverMySQL    DBDriver = "mysql"
)

func (DBDriver) Valid

func (d DBDriver) Valid() bool

Valid checks if the DBDriver is valid.

type Migration

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

func New

func New(l initLogger, conf Config) (*Migration, error)

func (*Migration) Down

func (s *Migration) Down(ctx context.Context, steps int) error

Down rolls back the database schema by the specified number of steps.

func (*Migration) Drop

func (s *Migration) Drop(ctx context.Context) error

Drop removes all database schema.

func (*Migration) Up

func (s *Migration) Up(ctx context.Context, steps int) error

Up applies the database schema by the specified number of steps.

func (*Migration) Version

func (s *Migration) Version(ctx context.Context) (uint, bool, error)

Version returns the current database schema version.