migrationkit

Documentation

Index

• type Migration
  • func NewMigration(ctx context.Context, conf *MigrationConfig) *Migration
  • func (m *Migration) Close() error
  • func (m *Migration) Up() error
• type MigrationConfig

Types

type Migration

type Migration struct {
	*migrate.Migrate
	// contains filtered or unexported fields
}

func NewMigration

func NewMigration(ctx context.Context, conf *MigrationConfig) *Migration

func (*Migration) Close

func (m *Migration) Close() error

func (*Migration) Up

func (m *Migration) Up() error

type MigrationConfig

type MigrationConfig struct {
	// Source is the migration files source directory,
	// currently we only accept file system as source.
	//
	// Register more source types by importing other source packages.
	//
	// File System: https://github.com/golang-migrate/migrate/tree/master/source/file
	Source string `long:"source" env:"SOURCE" description:"the migration files source directory" required:"true"`
	// URL is the migration database URL,
	// currently we only accept Postgres as database.
	//
	// Register more database types by importing other database packages.
	//
	// Postgres: https://github.com/golang-migrate/migrate/tree/master/database/postgres
	URL string `long:"url" env:"URL" description:"the database url" required:"true"`
}