lbsadmin/bee
1
0
Fork 0
mirror of https://github.com/beego/bee.git synced 2024-11-22 20:20:55 +00:00
Code Issues Releases Activity

Merge pull request #43 from ZhengYang/master

Browse Source 
add comments for functions
This commit is contained in:
astaxie 2014-08-13 13:07:35 +08:00
commit bf6bada32e
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
migrate.go
View File

@ -59,6 +59,7 @@ func init() {
cmdMigrate.Flag.Var(&mConn, "conn", "connection string used by the driver to connect to a database instance") cmdMigrate.Flag.Var(&mConn, "conn", "connection string used by the driver to connect to a database instance")
} }
// runMigration is the entry point for starting a migration
func runMigration(cmd *Command, args []string) { func runMigration(cmd *Command, args []string) {
crupath, _ := os.Getwd() crupath, _ := os.Getwd()
@ -106,22 +107,27 @@ func runMigration(cmd *Command, args []string) {
ColorLog("[SUCC] Migration successful!\n") ColorLog("[SUCC] Migration successful!\n")
} }
// migrateUpdate does the schema update
func migrateUpdate(crupath, driver, connStr string) { func migrateUpdate(crupath, driver, connStr string) {
migrate("upgrade", crupath, driver, connStr) migrate("upgrade", crupath, driver, connStr)
} }
// migrateRollback rolls back the latest migration
func migrateRollback(crupath, driver, connStr string) { func migrateRollback(crupath, driver, connStr string) {
migrate("rollback", crupath, driver, connStr) migrate("rollback", crupath, driver, connStr)
} }
// migrateReset rolls back all migrations
func migrateReset(crupath, driver, connStr string) { func migrateReset(crupath, driver, connStr string) {
migrate("reset", crupath, driver, connStr) migrate("reset", crupath, driver, connStr)
} }
// migrationRefresh rolls back all migrations and start over again
func migrateRefresh(crupath, driver, connStr string) { func migrateRefresh(crupath, driver, connStr string) {
migrate("refresh", crupath, driver, connStr) migrate("refresh", crupath, driver, connStr)
} }
// migrate generates source code, build it, and invoke the binary who does the actual migration
func migrate(goal, crupath, driver, connStr string) { func migrate(goal, crupath, driver, connStr string) {
dir := path.Join(crupath, "database", "migrations") dir := path.Join(crupath, "database", "migrations")
binary := "m" binary := "m"
@ -142,6 +148,8 @@ func migrate(goal, crupath, driver, connStr string) {
removeTempFile(dir, binary) removeTempFile(dir, binary)
} }
// checkForSchemaUpdateTable checks the existence of migrations table.
// It checks for the proper table structures and creates the table using MYSQL_MIGRATION_DDL if it does not exist.
func checkForSchemaUpdateTable(db *sql.DB) { func checkForSchemaUpdateTable(db *sql.DB) {
if rows, err := db.Query("SHOW TABLES LIKE 'migrations'"); err != nil { if rows, err := db.Query("SHOW TABLES LIKE 'migrations'"); err != nil {
ColorLog("[ERRO] Could not show migrations table: %s\n", err) ColorLog("[ERRO] Could not show migrations table: %s\n", err)
@ -191,6 +199,7 @@ func checkForSchemaUpdateTable(db *sql.DB) {
} }
} }
// getLatestMigration retrives latest migration with status 'update'
func getLatestMigration(db *sql.DB) (file string, createdAt int64) { func getLatestMigration(db *sql.DB) (file string, createdAt int64) {
sql := "SELECT name, created_at FROM migrations where status = 'update' ORDER BY id_migration DESC LIMIT 1" sql := "SELECT name, created_at FROM migrations where status = 'update' ORDER BY id_migration DESC LIMIT 1"
if rows, err := db.Query(sql); err != nil { if rows, err := db.Query(sql); err != nil {
@ -216,6 +225,7 @@ func getLatestMigration(db *sql.DB) (file string, createdAt int64) {
return return
} }
// writeMigrationSourceFile create the source file based on MIGRATION_MAIN_TPL
func writeMigrationSourceFile(dir, source, driver, connStr string, latestTime int64, latestName string, task string) { func writeMigrationSourceFile(dir, source, driver, connStr string, latestTime int64, latestName string, task string) {
os.Chdir(dir) os.Chdir(dir)
if f, err := os.OpenFile(source, os.O_CREATE|os.O_EXCL|os.O_RDWR, 0666); err != nil { if f, err := os.OpenFile(source, os.O_CREATE|os.O_EXCL|os.O_RDWR, 0666); err != nil {
@ -235,6 +245,7 @@ func writeMigrationSourceFile(dir, source, driver, connStr string, latestTime in
} }
} }
// buildMigrationBinary changes directory to database/migrations folder and go-build the source
func buildMigrationBinary(dir, binary string) { func buildMigrationBinary(dir, binary string) {
os.Chdir(dir) os.Chdir(dir)
cmd := exec.Command("go", "build", "-o", binary) cmd := exec.Command("go", "build", "-o", binary)
@ -245,6 +256,7 @@ func buildMigrationBinary(dir, binary string) {
} }
} }
// runMigrationBinary runs the migration program who does the actual work
func runMigrationBinary(dir, binary string) { func runMigrationBinary(dir, binary string) {
os.Chdir(dir) os.Chdir(dir)
cmd := exec.Command("./" + binary) cmd := exec.Command("./" + binary)
@ -257,6 +269,7 @@ func runMigrationBinary(dir, binary string) {
} }
} }
// removeTempFile removes a file in dir
func removeTempFile(dir, file string) { func removeTempFile(dir, file string) {
os.Chdir(dir) os.Chdir(dir)
if err := os.Remove(file); err != nil { if err := os.Remove(file); err != nil {
@ -265,6 +278,7 @@ func removeTempFile(dir, file string) {
} }
} }
// formatShellErrOutput formats the error shell output
func formatShellErrOutput(o string) { func formatShellErrOutput(o string) {
for _, line := range strings.Split(o, "\n") { for _, line := range strings.Split(o, "\n") {
if line != "" { if line != "" {
@ -273,6 +287,7 @@ func formatShellErrOutput(o string) {
} }
} }
// formatShellOutput formats the normal shell output
func formatShellOutput(o string) { func formatShellOutput(o string) {
for _, line := range strings.Split(o, "\n") { for _, line := range strings.Split(o, "\n") {
if line != "" { if line != "" {