[POC] Schema migration API

Gopkg.toml

@@ -28,3 +28,7 @@
 [prune]
   go-tests = true
   unused-packages = true
+
+[[constraint]]
+  name = "github.com/mattn/go-sqlite3"
+  version = "1.14.2"

README.md

@@ -20,7 +20,7 @@ REL is golang orm-ish database layer for layered architecture. It's testable and
 - Multi adapter.
 - Soft Deletion.
 - Pagination.
-
+- Schema Migration.
 
 ## Install
 

adapter.go

@@ -18,4 +18,6 @@ type Adapter interface {
 	Begin(ctx context.Context) (Adapter, error)
 	Commit(ctx context.Context) error
 	Rollback(ctx context.Context) error
+
+	Apply(ctx context.Context, migration Migration) error
 }

adapter/mysql/mysql.go

@@ -25,19 +25,26 @@ type Adapter struct {
 	*sql.Adapter
 }
 
-var _ rel.Adapter = (*Adapter)(nil)
+var (
+	_ rel.Adapter = (*Adapter)(nil)
 
-// New is mysql adapter constructor.
+	// Config for mysql adapter.
+	Config = sql.Config{
+		DropIndexOnTable: true,
+		Placeholder:      "?",
+		EscapeChar:       "`",
+		IncrementFunc:    incrementFunc,
+		ErrorFunc:        errorFunc,
+		MapColumnFunc:    sql.MapColumn,
+	}
+)
+
+// New mysql adapter using existing connection.
 func New(database *db.DB) *Adapter {
 	return &Adapter{
 		Adapter: &sql.Adapter{
-			Config: &sql.Config{
-				Placeholder:   "?",
-				EscapeChar:    "`",
-				IncrementFunc: incrementFunc,
-				ErrorFunc:     errorFunc,
-			},
-			DB: database,
+			Config: Config,
+			DB:     database,
 		},
 	}
 }

adapter/mysql/mysql_test.go

@@ -15,58 +15,6 @@ import (
 
 var ctx = context.TODO()
 
-func init() {
-	adapter, err := Open(dsn())
-	paranoid.Panic(err, "failed to open database connection")
-
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS extras;`, nil)
-	paranoid.Panic(err, "failed dropping extras table")
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS addresses;`, nil)
-	paranoid.Panic(err, "failed dropping addresses table")
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS users;`, nil)
-	paranoid.Panic(err, "failed dropping users table")
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS composites;`, nil)
-	paranoid.Panic(err, "failed dropping composites table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE users (
-		id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
-		name VARCHAR(30) NOT NULL DEFAULT '',
-		gender VARCHAR(10) NOT NULL DEFAULT '',
-		age INT NOT NULL DEFAULT 0,
-		note varchar(50),
-		created_at DATETIME,
-		updated_at DATETIME
-	);`, nil)
-	paranoid.Panic(err, "failed creating users table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE addresses (
-		id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
-		user_id INT UNSIGNED,
-		name VARCHAR(60) NOT NULL DEFAULT '',
-		created_at DATETIME,
-		updated_at DATETIME,
-		FOREIGN KEY (user_id) REFERENCES users(id)
-	);`, nil)
-	paranoid.Panic(err, "failed creating addresses table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE extras (
-		id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
-		slug VARCHAR(30) DEFAULT NULL UNIQUE,
-		user_id INT UNSIGNED,
-		SCORE INT,
-		CONSTRAINT extras_user_id_fk FOREIGN KEY (user_id) REFERENCES users(id)
-	);`, nil)
-	paranoid.Panic(err, "failed creating extras table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE composites (
-		primary1 INT UNSIGNED,
-		primary2 INT UNSIGNED,
-		data VARCHAR(255) DEFAULT NULL,
-		PRIMARY KEY (primary1, primary2)
-	);`, nil)
-	paranoid.Panic(err, "failed creating composites table")
-}
-
 func dsn() string {
 	if os.Getenv("MYSQL_DATABASE") != "" {
 		return os.Getenv("MYSQL_DATABASE") + "?charset=utf8&parseTime=True&loc=Local"
@@ -82,6 +30,14 @@ func TestAdapter_specs(t *testing.T) {
 
 	repo := rel.New(adapter)
 
+	// Prepare tables
+	teardown := specs.Setup(t, repo)
+	defer teardown()
+
+	// Migration Specs
+	// - Rename column is only supported by MySQL 8.0
+	specs.Migrate(t, repo, specs.SkipRenameColumn)
+
 	// Query Specs
 	specs.Query(t, repo)
 	specs.QueryJoin(t, repo)

adapter/postgres/postgres.go

@@ -15,6 +15,7 @@ package postgres
 import (
 	"context"
 	db "database/sql"
+	"time"
 
 	"github.com/Fs02/rel"
 	"github.com/Fs02/rel/adapter/sql"
@@ -25,20 +26,26 @@ type Adapter struct {
 	*sql.Adapter
 }
 
-var _ rel.Adapter = (*Adapter)(nil)
+var (
+	_ rel.Adapter = (*Adapter)(nil)
+
+	// Config for postgres adapter.
+	Config = sql.Config{
+		Placeholder:         "$",
+		EscapeChar:          "\"",
+		Ordinal:             true,
+		InsertDefaultValues: true,
+		ErrorFunc:           errorFunc,
+		MapColumnFunc:       mapColumnFunc,
+	}
+)
 
-// New is postgres adapter constructor.
+// New postgres adapter using existing connection.
 func New(database *db.DB) *Adapter {
 	return &Adapter{
 		Adapter: &sql.Adapter{
-			Config: &sql.Config{
-				Placeholder:         "$",
-				EscapeChar:          "\"",
-				Ordinal:             true,
-				InsertDefaultValues: true,
-				ErrorFunc:           errorFunc,
-			},
-			DB: database,
+			Config: Config,
+			DB:     database,
 		},
 	}
 }
@@ -144,3 +151,33 @@ func errorFunc(err error) error {
 		return err
 	}
 }
+
+func mapColumnFunc(column *rel.Column) (string, int, int) {
+	var (
+		typ  string
+		m, n int
+	)
+
+	// postgres specific
+	column.Unsigned = false
+	if column.Default == "" {
+		column.Default = nil
+	}
+
+	switch column.Type {
+	case rel.ID:
+		typ = "SERIAL NOT NULL PRIMARY KEY"
+	case rel.DateTime:
+		typ = "TIMESTAMPTZ"
+		if t, ok := column.Default.(time.Time); ok {
+			column.Default = t.Format("2006-01-02 15:04:05")
+		}
+	case rel.Int, rel.BigInt, rel.Text:
+		column.Limit = 0
+		typ, m, n = sql.MapColumn(column)
+	default:
+		typ, m, n = sql.MapColumn(column)
+	}
+
+	return typ, m, n
+}

adapter/postgres/postgres_test.go

@@ -16,68 +16,16 @@ import (
 var ctx = context.TODO()
 
 func init() {
-	adapter, err := Open(dsn())
-	paranoid.Panic(err, "failed to open database connection")
-	defer adapter.Close()
-
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS extras;`, nil)
-	paranoid.Panic(err, "failed dropping extras table")
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS addresses;`, nil)
-	paranoid.Panic(err, "failed dropping addresses table")
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS users;`, nil)
-	paranoid.Panic(err, "failed dropping users table")
-	_, _, err = adapter.Exec(ctx, `DROP TABLE IF EXISTS composites;`, nil)
-	paranoid.Panic(err, "failed dropping composites table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE users (
-		id SERIAL NOT NULL PRIMARY KEY,
-		slug VARCHAR(30) DEFAULT NULL,
-		name VARCHAR(30) NOT NULL DEFAULT '',
-		gender VARCHAR(10) NOT NULL DEFAULT '',	
-		age INT NOT NULL DEFAULT 0,
-		note varchar(50),
-		created_at TIMESTAMPTZ,
-		updated_at TIMESTAMPTZ,
-		UNIQUE(slug)
-	);`, nil)
-	paranoid.Panic(err, "failed creating users table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE addresses (
-		id SERIAL NOT NULL PRIMARY KEY,
-		user_id INTEGER REFERENCES users(id),
-		name VARCHAR(60) NOT NULL DEFAULT '',
-		created_at TIMESTAMPTZ,
-		updated_at TIMESTAMPTZ
-	);`, nil)
-	paranoid.Panic(err, "failed creating addresses table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE extras (
-		id SERIAL NOT NULL PRIMARY KEY,
-		slug VARCHAR(30) DEFAULT NULL UNIQUE,
-		user_id INTEGER REFERENCES users(id),
-		score INTEGER DEFAULT 0 CHECK (score>=0 AND score<=100)
-	);`, nil)
-	paranoid.Panic(err, "failed creating extras table")
-
-	_, _, err = adapter.Exec(ctx, `CREATE TABLE composites (
-		primary1 SERIAL NOT NULL,
-		primary2 SERIAL NOT NULL,
-		data VARCHAR(255) DEFAULT NULL,
-		PRIMARY KEY (primary1, primary2)
-	);`, nil)
-	paranoid.Panic(err, "failed creating composites table")
-
 	// hack to make sure location it has the same location object as returned by pq driver.
-	time.Local, err = time.LoadLocation("Asia/Jakarta")
-	paranoid.Panic(err, "failed loading time location")
+	time.Local, _ = time.LoadLocation("Asia/Jakarta")
 }
 
 func dsn() string {
 	if os.Getenv("POSTGRESQL_DATABASE") != "" {
 		return os.Getenv("POSTGRESQL_DATABASE") + "?sslmode=disable&timezone=Asia/Jakarta"
 	}
 
-	return "postgres://rel@localhost:9920/rel_test?sslmode=disable&timezone=Asia/Jakarta"
+	return "postgres://rel@localhost:5432/rel_test?sslmode=disable&timezone=Asia/Jakarta"
 }
 
 func TestAdapter_specs(t *testing.T) {
@@ -87,6 +35,13 @@ func TestAdapter_specs(t *testing.T) {
 
 	repo := rel.New(adapter)
 
+	// Prepare tables
+	teardown := specs.Setup(t, repo)
+	defer teardown()
+
+	// Migration Specs
+	specs.Migrate(t, repo)
+
 	// Query Specs
 	specs.Query(t, repo)
 	specs.QueryJoin(t, repo)