migrator

package module

v1.6.2 Latest Latest Go to latest Published: Nov 6, 2023 License: MIT Imports: 8 Imported by: 2

Details

This section is empty.

View Source

var (
	ErrMigrationsBadType = errors.New("migrations must be slice of struct")
)

This section is empty.

type Migration struct {
	Version int
	Name    string
	Up      string
	Down    string
}

func (m Migration) FileName(optionalDelta ...int) string

func (m Migration) String(optionalDelta ...int) string

type Migrations []Migration

type Migrator struct {
	Scope  string
	DB     db.DB
	Logger logger.Logger
	// contains filtered or unexported fields
}

func NewMigrator(optionalScope ...string) *Migrator

func (m *Migrator) CanonicalScope() string

CanonicalScope returns valid scope name.

func (m *Migrator) Migrate() (err error)

Migrate executes the up SQL for all the migrations that have not yet been run.

func (m *Migrator) NewMigration(models ...PsqlModel) (Migrations, error)

NewMigration generates migration file based on the differences between schemas in the database and psql models.

func (m *Migrator) Rollback() (err error)

Rollback executes the down SQL of last migration.

func (m *Migrator) SetConnection(dbConn db.DB)

func (m *Migrator) SetLogger(logger logger.Logger)

func (m *Migrator) SetMigrations(migrations interface{}) error

SetMigrations imports migrations.

func (m *Migrator) Versions() (migrated, unmigrated []int)

Versions returns version numbers of migrations that have been run and not yet been run.

type PsqlModel interface {
	Columns() []string
	ColumnDataTypes() map[string]string
	TableName() string
	Schema() string
	DropSchema() string
}