gograte

README

Gograte: Database Migration Tool

Motivations

This project is highly inspired by Goose which is also a database migration tool. I was susprised by the simplicity of this tool. So, I wanted to build by myself. This project includes most of the features Goose offers.

Install

go install github.com/Shin-Thant/gograte/cmd/gograte@latest

This will install the gograte binary to your $GOPATH/bin directory.

Guides

Move to cmd/gograte directory and run go install. Then you are good to go. Move to your project and use those commands.

1. Init your migration.

   gograte init
   

2. Create your migration sql file.

   gograte create first
   

   This will create sql file in this format [timestamp]-[name].sql
3. Migrate with this commands.

   gograte migrate [db_driver] [db_url] [action]
   

   Action option can be the followings.
   1. up
   2. up-one
   3. up-to (example up-to [version])
   4. down
   5. down-one
   6. down-to (example down-to [version])
4. Help

   gograte --help
   

Documentation

Index

• Variables
• func Create(args []string)
• func CreateMigrationTableIfNotExist(db *sql.DB) (sql.Result, error)
• func GetSQLDriver(driver string) string
• func Init()
• func Migrate(args []string)
• func NewMigrationRecord() *migrationRecord
• func Status(args []string)
• func ValidateDbDriver(inputDriver string) bool
• func ValidateMigrationFilePaths(paths []string) []migrationFile
• type ValidData
  • func (v *ValidData) String() string

Variables

var ACTION = 3

var DB_URL = 2

var DRIVER = 1

argument indexes

var MIGRATION = 1

argument indexes

var QUERY_ALL_MIGRATIONS = `SELECT * FROM _gograte_db_versions ORDER BY created_at ASC;`

var QUERY_APPLIED_MIGRATIONS = `SELECT * FROM _gograte_db_versions WHERE is_applied = true ORDER BY created_at DESC;`

var QUERY_NON_APPLIED_MIGRATIONS = `SELECT * FROM _gograte_db_versions WHERE is_applied = false ORDER BY created_at ASC;`

var QUERY_ONE_APPLIED_MIGRATION = `SELECT * FROM _gograte_db_versions WHERE is_applied = true ORDER BY created_at DESC LIMIT 1;`

var UsageMessage = `` /* 1144-byte string literal not displayed */

var VERSION = 4

Functions

func Create

func Create(args []string)

func CreateMigrationTableIfNotExist

func CreateMigrationTableIfNotExist(db *sql.DB) (sql.Result, error)

func GetSQLDriver

func GetSQLDriver(driver string) string

func Init

func Init()

func Migrate

func Migrate(args []string)

func NewMigrationRecord

func NewMigrationRecord() *migrationRecord

func Status

func Status(args []string)

func ValidateDbDriver

func ValidateDbDriver(inputDriver string) bool

func ValidateMigrationFilePaths

func ValidateMigrationFilePaths(paths []string) []migrationFile

Types

type ValidData

type ValidData []string

var ACTIONS ValidData = []string{"up", "down", "up-one", "down-one", "up-to", "down-to"}

var DB_DRIVERS ValidData = []string{"mysql", "postgres", "sqlite3"}

func (*ValidData) String

func (v *ValidData) String() string