commands

Documentation

Index

• Constants
• Variables
• func CommandAll(cfg config.MigConfig) result.Response
• func CommandCreate(cfg config.MigConfig, name string) result.Response
• func CommandDown(cfg config.MigConfig) result.Response
• func CommandInit(cfg config.MigConfig) result.Response
• func CommandList(cfg config.MigConfig) result.Response
• func CommandLock(cfg config.MigConfig) result.Response
• func CommandStatus(cfg config.MigConfig) result.Response
• func CommandUnlock(cfg config.MigConfig) result.Response
• func CommandUp(cfg config.MigConfig) result.Response
• func CommandUpto(cfg config.MigConfig, target string) result.Response
• func CommandVersion(cfg config.MigConfig) result.Response
• func Dispatch(cfg config.MigConfig, subcommands []string) result.Response
• func SanitizeName(name string) string
• type CommandCreateResult
• type CommandUpFamilyResult
• type CommandUpResult
• type CommandUptoResult
• type CommandVersionResult
• type MigrationName
• type StatusResponse

Constants

const TEMPLATE = `` /* 183-byte string literal not displayed */

Variables

var BuildTime string // set at compile time

var DESCRIBE = database.QueryBox{
	Postgres: `SELECT
	table_name,
	column_name,
	data_type
FROM
	information_schema.columns
WHERE
	table_name = 'migrations' OR table_name = 'migrations_lock'
ORDER BY
	table_name, column_name;`,
	Mysql:  `DESC migrations;`,
	Sqlite: `pragma table_info('migrations');`,
}

var EXIST_LOCK = database.QueryBox{
	Postgres: `SELECT EXISTS (
	SELECT FROM
		pg_tables
	WHERE
		schemaname = 'public' AND
		tablename  = 'migrations_lock'
	) AS table_exists;`,
	Mysql:  `CALL sys.table_exists(DATABASE(), 'migrations_lock', @table_type); SELECT @table_type LIKE 'BASE TABLE';`,
	Sqlite: `SELECT COUNT(name) >= 1 AS table_is_present FROM sqlite_master WHERE type='table' AND name='migrations_lock';`,
}

var EXIST_MIGRATIONS = database.QueryBox{
	Postgres: `SELECT EXISTS (
SELECT FROM
	pg_tables
WHERE
	schemaname = 'public' AND
	tablename  = 'migrations'
) AS table_exists;`,
	Mysql:  `CALL sys.table_exists(DATABASE(), 'migrations', @table_type); SELECT @table_type LIKE 'BASE TABLE';`,
	Sqlite: `SELECT COUNT(name) >= 1 AS table_is_present FROM sqlite_master WHERE type='table' AND name='migrations';`,
}

var LOCK_STATUS = database.QueryBox{
	Postgres: `SELECT is_locked FROM migrations_lock WHERE index = 1;`,
	Mysql:    `SELECT is_locked FROM migrations_lock WHERE ` + "`index`" + ` = 1;`,
	Sqlite:   `SELECT is_locked FROM migrations_lock WHERE "index" = 1;`,
}

var Version string // set at compile time

Functions

func CommandAll

func CommandAll(cfg config.MigConfig) result.Response

func CommandCreate

func CommandCreate(cfg config.MigConfig, name string) result.Response

func CommandDown

func CommandDown(cfg config.MigConfig) result.Response

func CommandInit

func CommandInit(cfg config.MigConfig) result.Response

func CommandList

func CommandList(cfg config.MigConfig) result.Response

func CommandLock

func CommandLock(cfg config.MigConfig) result.Response

func CommandStatus

func CommandStatus(cfg config.MigConfig) result.Response

Provide a narrative to the user about the current status of mig Inspired by `git status` and `brew doctor`

func CommandUnlock

func CommandUnlock(cfg config.MigConfig) result.Response

func CommandUp

func CommandUp(cfg config.MigConfig) result.Response

func CommandUpto

func CommandUpto(cfg config.MigConfig, target string) result.Response

func CommandVersion

func CommandVersion(cfg config.MigConfig) result.Response

func Dispatch

func Dispatch(cfg config.MigConfig, subcommands []string) result.Response

func SanitizeName

func SanitizeName(name string) string

Types

type CommandCreateResult

type CommandCreateResult struct {
	Filename string `json:"filename"`
}

type CommandUpFamilyResult

type CommandUpFamilyResult struct {
	MigrationBatch int                        `json:"batch"`
	Migrations     *[]migrations.MigrationRow `json:"migrations"`
}

type CommandUpResult

type CommandUpResult struct {
	MigrationBatch int                      `json:"batch"`
	Migration      *migrations.MigrationRow `json:"migration"`
}

type CommandUptoResult

type CommandUptoResult struct {
	History []migrations.MigrationRowStatus `json:"history"`
}

type CommandVersionResult

type CommandVersionResult struct {
	Version   string `json:"version"`
	BuildTime string `json:"build_time"`
}

type MigrationName

type MigrationName struct {
	Migration string `json:"migration"`
}

type StatusResponse

type StatusResponse struct {
	Locked bool `json:"locked"`
	Status any  `json:"status"`
}