migrator

README

migrator

Extends golang-migrate to support create database, currently only for postgres.

Documentation

Index

• type Migrator
  • func NewPostgres(migrations embed.FS, ...) (Migrator, error)
• type PostgresMigrator
  • func (m *PostgresMigrator) CreateDb() error
  • func (m *PostgresMigrator) Down() (err error)
  • func (m *PostgresMigrator) Migrate(version uint) (err error)
  • func (m *PostgresMigrator) Up() (err error)

Types

type Migrator

type Migrator interface {
	CreateDb() error
	Up() (err error)
	Down() (err error)
	Migrate(version uint) (err error)
}

func NewPostgres

func NewPostgres(migrations embed.FS,
	migrationsPath,
	dbConnectionString,
	createSecurityFile,
	createSchemaFile string,
	createDb bool,
	logger logger.Logger) (Migrator, error)

NewPostgres returns an instance of migrator

type PostgresMigrator

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

func (*PostgresMigrator) CreateDb

func (m *PostgresMigrator) CreateDb() error

CreateDb attempts to create the database if it does not exists

func (*PostgresMigrator) Down

func (m *PostgresMigrator) Down() (err error)

Down migrates all the way down

func (*PostgresMigrator) Migrate

func (m *PostgresMigrator) Migrate(version uint) (err error)

Migrate to a specific version either up or down

func (*PostgresMigrator) Up

func (m *PostgresMigrator) Up() (err error)

Up migrates all the way up, usually go for local environments