Migrate

db migration based on sql-migrate, only use migrate.Up.

Usage

sql files

prepare sql files before migrate

mkdir db

cat <<EOF > db/2022120710-user.sql
-- +migrate Up
-- SQL in section 'Up' is executed when this migration is applied
CREATE TABLE user
(
	id       BIGINT UNSIGNED AUTO_INCREMENT COMMENT 'auto increment id' PRIMARY KEY,
	username VARCHAR(191) NULL COMMENT 'user login name'
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4
COLLATE = utf8mb4_general_ci;
EOF


cat <<EOF > db/2022120711-role.sql
-- +migrate Up
-- SQL in section 'Up' is executed when this migration is applied
CREATE TABLE role
(
	id   BIGINT UNSIGNED AUTO_INCREMENT COMMENT 'auto increment id' PRIMARY KEY,
	name VARCHAR(50) NULL COMMENT 'name'
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4
COLLATE = utf8mb4_general_ci;
EOF

caution: must set file header!
-- +migrate Up
-- SQL in section 'Up' is executed when this migration is applied

Do

go get -u github.com/go-cinch/common/migrate

import (
	"embed"
	"fmt"
	"github.com/go-cinch/common/migrate"
)

//go:embed db
var db embed.FS

func main() {
	err := migrate.Do(
		migrate.WithUri("root:root@tcp(127.0.0.1:3306)/test?parseTime=true"),
		migrate.WithFs(db),
		migrate.WithFsRoot("db"),
	)
	fmt.Println(err)
}

Options

• WithCtx - context
• WithDriver - database driver, default mysql
• WithUri - database uri, if database not exist will auto create, default root:root@tcp(127.0.0.1:3306) /test?charset=utf8mb4&parseTime=True&timeout=10000ms
• WithLockName - lock name, will set unique lock before exec sql script, default MigrationLock
• WithChangeTable - change history table name, default schema_migrations
• WithBefore - callback function, custom callback before exec sql script, after acquired migration lock
• WithFs - embed files
• WithFsRoot - embed root path