simplemigrate

README

simple-migrate

Migrations in a couple of clicks. You will need a 'versions' table, a sample is given in the project directory.

Usage:

  // create db connection (*sql.DB)..
  // conn := ...

  handler := simplemigrate.NewMigrationHandler(simplemigrate.MigrationTask{
		ScriptsDir: "./migrations/",
		DBDriver:   conn,
		DBName:     "mydb",
	})
	err := handler.Run()
  if err != nil {
    // handle error
  }

The 'migrations' folder should contain the ".sql" files with the migrations. For example:

000_tables.sql
001_modify_users.sql
002_add_counter.sql

Documentation

Index

• type MigrationHandler
  • func NewMigrationHandler(task MigrationTask) *MigrationHandler
  • func (m *MigrationHandler) Run() error
• type MigrationTask

Types

type MigrationHandler

type MigrationHandler struct {
	Data MigrationTask
}

MigrationHandler - migration handler

func NewMigrationHandler

func NewMigrationHandler(task MigrationTask) *MigrationHandler

NewMigrationHandler - create new migration handler. dir with slash. for example: ./migrations/

func (*MigrationHandler) Run

func (m *MigrationHandler) Run() error

Run migrations

type MigrationTask

type MigrationTask struct {
	ScriptsDir string
	DBDriver   *sql.DB
	DBName     string
}

MigrationTask - migration task data container