Merge pull request #7 from ShkrutDenis/develop

Develop

Author: ShkrutDenis

README.md

@@ -49,5 +49,14 @@ Module uses next variables for creating a connection with DB:
 - DB_DRIVER
 - DB_USER
 - DB_PASSWORD
-- DB_CONNECTION - format `host:port`
+- DB_HOST
+- DB_PORT
 - DB_NAME
+
+if `DB_HOST` and `DB_PORT` doesn’t exist, will be used a `DB_CONNECTION` with next format: `host:port`
+
+By default, module load env file from the current directory with name `.env`. For use custom env file you can use next flags: `--env-path` and `--env-file`
+
+#### Examples
+
+You can found few examples with create migration in `/examples` repository folder.

db/db.go

@@ -34,10 +34,13 @@ func NewConnector() *Connector {
 }
 
 func NewConfig() *ConnectionConfig {
-	var host, port string
-	connectionParts := strings.Split(os.Getenv("DB_CONNECTION"), ":")
-	if len(connectionParts) == 2 {
-		host, port = connectionParts[0], connectionParts[1]
+	host := os.Getenv("DB_HOST")
+	port := os.Getenv("DB_PORT")
+	if host == "" && port == "" {
+		connectionParts := strings.Split(os.Getenv("DB_CONNECTION"), ":")
+		if len(connectionParts) == 2 {
+			host, port = connectionParts[0], connectionParts[1]
+		}
 	}
 
 	return &ConnectionConfig{

entry.go

@@ -1,47 +1,60 @@
 package go_migrations
 
 import (
+	"flag"
 	"github.com/ShkrutDenis/go-migrations/db"
 	"github.com/ShkrutDenis/go-migrations/model"
 	"github.com/ShkrutDenis/go-migrations/store"
 	"github.com/jmoiron/sqlx"
 	"github.com/joho/godotenv"
 	"log"
+	"os"
 )
 
 var connection *sqlx.DB
-var lastBatch int
-var firstRun = false
+var config *Config
 
-func init() {
-	err := godotenv.Load()
-	if err != nil {
-		log.Println("Error loading .env file")
-	}
+type Config struct {
+	IsRollback bool
+	EnvPath    string
+	EnvFile    string
 
-	connector := db.NewConnector()
-	connection, err = connector.Connect()
-	if err != nil {
-		log.Fatal(err)
+	lastBatch int
+	firstRun  bool
+}
+
+func (c *Config) GetEnvFullPath() string {
+	if c.EnvPath == "" {
+		return c.EnvFile
 	}
+	_, err := os.Stat(c.EnvPath + "/" + c.EnvFile)
+	if os.IsNotExist(err) {
+		return c.EnvPath + "\\" + c.EnvFile
+	}
+	return c.EnvPath + "/" + c.EnvFile
+}
 
-	lastBatch = model.GetLastBatch(connection)
-	firstRun = model.CreateMigrationsTable(connection)
+func init() {
+	config = &Config{}
 }
 
-func Migrate(migs []store.Migratable) {
+func Run(migs []store.Migratable) {
+	parseFlags()
+	prepare()
+
+	if config.IsRollback {
+		store.RegisterMigrations(migs)
+		rollBack()
+		return
+	}
+
 	for _, m := range migs {
 		upOrIgnore(m)
 	}
 }
 
-func Rollback(migs []store.Migratable) {
-	store.RegisterMigrations(migs)
-	rollBack()
-}
-
 func rollBack() {
-	forRollback := model.GetLastMigrations(connection, lastBatch)
+	forRollback := model.GetLastMigrations(connection, config.lastBatch)
 	for _, m := range forRollback {
 		forRun := store.FindMigration(m.Name)
 		if forRun == nil {
@@ -51,15 +64,40 @@ func rollBack() {
 		forRun.Down(connection)
 		log.Println("Rolled back", forRun.GetName())
 	}
-	model.RemoveLastBatch(connection, lastBatch)
+	model.RemoveLastBatch(connection, config.lastBatch)
 }
 
 func upOrIgnore(migration store.Migratable) {
-	if !firstRun && model.MigrationExist(connection, migration.GetName()) {
+	if !config.firstRun && model.MigrationExist(connection, migration.GetName()) {
 		return
 	}
 	log.Println("Migrating", migration.GetName())
 	migration.Up(connection)
-	model.AddMigrationRaw(connection, migration.GetName(), lastBatch+1)
+	model.AddMigrationRaw(connection, migration.GetName(), config.lastBatch+1)
 	log.Println("Migrated", migration.GetName())
 }
+
+func parseFlags() {
+	isRollback := flag.Bool("rollback", false, "Flag for init rollback.")
+	envPath := flag.String("env-path", "", "Path to .env file.")
+	envFile := flag.String("env-file", ".env", "Env file name.")
+	flag.Parse()
+	config.IsRollback = *isRollback
+	config.EnvPath = *envPath
+	config.EnvFile = *envFile
+}
+
+func prepare() {
+	err := godotenv.Load(config.GetEnvFullPath())
+	if err != nil {
+		log.Println("Error loading .env file")
+	}
+
+	connector := db.NewConnector()
+	connection, err = connector.Connect()
+	if err != nil {
+		log.Fatal(err)
+	}
+	config.lastBatch = model.GetLastBatch(connection)
+	config.firstRun = model.CreateMigrationsTable(connection)
+}

examples/change_table.go

@@ -0,0 +1,34 @@
+package list
+
+import (
+	"github.com/ShkrutDenis/go-migrations/builder"
+	"github.com/jmoiron/sqlx"
+)
+
+type ChangeExampleTable struct {}
+
+func (m *ChangeExampleTable) GetName() string {
+	// Name of migration.
+	// It will be stored to DB, must be unique.
+	return "ChangeExampleTable"
+}
+
+func (m *ChangeExampleTable) Up(con *sqlx.DB) {
+	// Change existed table
+	table := builder.ChangeTable("example", con)
+	// For change column, just declare new column and call method Change().
+	table.String("name", 100).Default("new value").NotNull().Change()
+	// Remove unique condition
+	table.Column("email").Type("varchar(50)").NotUnique().Change()
+	// Add default timestamps (created_at nad updated_at)
+	table.WithTimestamps()
+	// Execute queries
+	table.MustExec()
+}
+
+func (m *ChangeExampleTable) Down(con *sqlx.DB) {
+	table := builder.ChangeTable("example", con)
+	table.String("name", 100).Nullable().Default("value")
+	table.Column("email").Type("varchar(50)").Unique()
+	table.MustExec()
+}

examples/create_table.go

@@ -0,0 +1,35 @@
+package list
+
+import (
+	"github.com/ShkrutDenis/go-migrations/builder"
+	"github.com/jmoiron/sqlx"
+)
+
+type CreateExampleTable struct {}
+
+func (m *CreateExampleTable) GetName() string {
+	// Name of migration.
+	// It will be stored to DB, must be unique.
+	return "CreateExampleTable"
+}
+
+func (m *CreateExampleTable) Up(con *sqlx.DB) {
+	// Create new table
+	table := builder.NewTable("example", con)
+	// Add primary key. It will be created column with type int and autoincrement.
+	table.PrimaryKey("id")
+	// Nullable column with default value. String(,n) => varchar(n).
+	table.String("name", 100).Nullable().Default("value")
+	// Builder has few predefined methods with type declaration.
+	// Any way, you can use Column().Type() methods for create column with any type.
+	table.Integer("count").Default("0")
+	// Unique column
+	table.Column("email").Type("varchar(50)").Unique()
+	// Execute queries
+	table.MustExec()
+}
+
+func (m *CreateExampleTable) Down(con *sqlx.DB) {
+	// Drop table
+	builder.DropTable("example", con).MustExec()
+}

examples/foreign_key.go

@@ -0,0 +1,31 @@
+package list
+
+import (
+	"github.com/ShkrutDenis/go-migrations/builder"
+	"github.com/jmoiron/sqlx"
+)
+
+type ForeignKeyExampleTable struct {}
+
+func (m *ForeignKeyExampleTable) GetName() string {
+	// Name of migration.
+	// It will be stored to DB, must be unique.
+	return "ForeignKeyExampleTable"
+}
+
+func (m *ForeignKeyExampleTable) Up(con *sqlx.DB) {
+	// Create new table
+	table := builder.NewTable("fk_example", con)
+	// Add primary key. It will be created column with type int and autoincrement.
+	table.PrimaryKey("id")
+	// Add foreign key. First you need add column then add foreign key.
+	table.Integer("example_id")
+	table.ForeignKey("example_id").Reference("example").On("id").OnDelete("cascade").OnUpdate("cascade")
+	// Execute queries
+	table.MustExec()
+}
+
+func (m *ForeignKeyExampleTable) Down(con *sqlx.DB) {
+	// Drop table
+	builder.DropTable("fk_example", con).MustExec()
+}

model/migration.go

@@ -58,6 +58,7 @@ func RemoveLastBatch(connection *sqlx.DB, lastBatch int) {
 	connection.MustExec(removeBatchSQL(), lastBatch)
 }
 
+// SQL queries functions
 func checkTableExitSQL() string {
 	switch os.Getenv("DB_DRIVER") {
 	case "mysql":

template/migrations/entry.go

@@ -1,26 +1,13 @@
 package main
 
 import (
-	"flag"
 	gm "github.com/ShkrutDenis/go-migrations"
 	gmStore "github.com/ShkrutDenis/go-migrations/store"
 	"github.com/ShkrutDenis/go-migrations/template/migrations/list"
 )
 
-var isRollback *bool
-
-func init() {
-	isRollback = flag.Bool("rollback", false, "")
-	flag.Parse()
-}
-
 func main() {
-	if *isRollback {
-		gm.Rollback(getMigrationsList())
-		return
-	}
-
-	gm.Migrate(getMigrationsList())
+	gm.Run(getMigrationsList())
 }
 
 func getMigrationsList() []gmStore.Migratable {