migration

Documentation

Index

• Constants
• func Formatter(pattern string, args ...any)
• func MigrationCommand(driver Migration, autExec ...string) *cobra.Command
• func NewMigrationFile(root, name, ext string, stages ...string) error
• type FS
  • func NewDirFS(root, ext string) (FS, error)
  • func NewEmbedFS(f embed.FS, root, ext string) (FS, error)
  • func (files FS) Copy() FS
  • func (files FS) ExcludeMigrated(names ...string) FS
  • func (files FS) Filter(names ...string) FS
  • func (files FS) FilterMigrated(names ...string) FS
  • func (files FS) Len() int
  • func (files FS) Less(i, j int) bool
  • func (files FS) Reverse() FS
  • func (files FS) Swap(i, j int)
• type File
  • func (file File) Content() string
  • func (file File) DownScripts(stage string) (string, error)
  • func (file File) Extension() string
  • func (file File) HumanizedName() string
  • func (file File) Is(name string) bool
  • func (file File) Name() string
  • func (file File) Timestamp() int64
  • func (file File) UpScripts(stage string) (string, error)
• type Migrated
• type Migration
  • func NewDirMigration(db *sqlx.DB, root, ext string) (Migration, error)
  • func NewEmbedMigration(db *sqlx.DB, fs embed.FS, root, ext string) (Migration, error)
  • func NewMigration(db *sqlx.DB, fs FS, root, ext string) Migration
• type Summary
  • func (summary Summary) GroupByFile() map[string][]string
  • func (summary Summary) GroupByStage() map[string][]string
  • func (summary Summary) IsEmpty() bool
  • func (summary Summary) Names() []string

Constants

const (
	RESET     = "\033[0m"
	BOLD      = "\033[1m"
	UNDERLINE = "\033[4m"
	STRIKE    = "\033[9m"
	ITALIC    = "\033[3m"
)

const (
	RED    = "\033[31m"
	GREEN  = "\033[32m"
	YELLOW = "\033[33m"
	BLUE   = "\033[34m"
	PURPLE = "\033[35m"
	CYAN   = "\033[36m"
	GRAY   = "\033[37m"
	WHITE  = "\033[37m"
)

Functions

func Formatter

func Formatter(pattern string, args ...any)

styling patterns

{R}: RESET, {B}: BOLD ,{U}: UNDERLINE ,{S}: STRIKE {I}: ITALIC ,{r}: RED ,{g}: GREEN ,{y}: YELLOW

{b}: BLUE ,{p}: PURPLE ,{c}: CYAN ,{m}: GRAY {w}: WHITE

func MigrationCommand

func MigrationCommand(driver Migration, autExec ...string) *cobra.Command

MigrationCommand migration cli commands

func NewMigrationFile

func NewMigrationFile(root, name, ext string, stages ...string) error

NewMigrationFile generate new migration file

Types

type FS

type FS []File

FS migration file system

func NewDirFS

func NewDirFS(root, ext string) (FS, error)

NewDirFS generate new migration filesystem from directory

func NewEmbedFS

func NewEmbedFS(f embed.FS, root, ext string) (FS, error)

NewEmbedFS generate new migration filesystem from embedded files

func (FS) Copy

func (files FS) Copy() FS

Copy create a new fresh copy from file system

func (FS) ExcludeMigrated

func (files FS) ExcludeMigrated(names ...string) FS

ExcludeMigrated exclude files from file system

func (FS) Filter

func (files FS) Filter(names ...string) FS

Filter filter files by name

func (FS) FilterMigrated

func (files FS) FilterMigrated(names ...string) FS

FilterMigrated exclude files from file system

func (FS) Len

func (files FS) Len() int

Len get files length

func (FS) Less

func (files FS) Less(i, j int) bool

Less check if name timestamp is smaller

func (FS) Reverse

func (files FS) Reverse() FS

Reverse reverse array order

func (FS) Swap

func (files FS) Swap(i, j int)

Swap swap item i and j

type File

type File struct {
	// contains filtered or unexported fields
}

File migration file

func (File) Content

func (file File) Content() string

Content get file content

func (File) DownScripts

func (file File) DownScripts(stage string) (string, error)

DownScripts get down section scripts

func (File) Extension

func (file File) Extension() string

Extension get file extension

func (File) HumanizedName

func (file File) HumanizedName() string

HumanizedName get file readable name withut timestamp and extension

func (File) Is

func (file File) Is(name string) bool

Is Compare file name in humanize format

func (File) Name

func (file File) Name() string

Name get file full name

func (File) Timestamp

func (file File) Timestamp() int64

Get timestamp part of filename

func (File) UpScripts

func (file File) UpScripts(stage string) (string, error)

UpScripts get up section scripts

type Migrated

type Migrated struct {
	Name  string `db:"name"`
	Stage string `db:"stage"`
}

type Migration

type Migration interface {
	// Root Get Root directory
	Root() string
	// Extension Get file extension
	Extension() string
	// Path get full path of file
	Path(name string) string
	// Init initialize database migration
	Init() error
	// Summary get migration summery
	Summary() (Summary, error)
	// StageSummary get migration summery for stage
	StageSummary(stage string) (Summary, error)
	// Up run migration stage
	//
	// pass only to run migrate on certain files only
	Up(stage string, only ...string) ([]string, error)
	// Down rollback migration stage
	//
	// pass only to run rollback on certain files only
	Down(stage string, only ...string) ([]string, error)
}

func NewDirMigration

func NewDirMigration(db *sqlx.DB, root, ext string) (Migration, error)

NewDirMigration create new migration instance from physical dir files

func NewEmbedMigration

func NewEmbedMigration(db *sqlx.DB, fs embed.FS, root, ext string) (Migration, error)

NewEmbedMigration create new migration instance from embedded files

func NewMigration

func NewMigration(db *sqlx.DB, fs FS, root, ext string) Migration

NewMigration create new migration instance

type Summary

type Summary []Migrated

func (Summary) GroupByFile

func (summary Summary) GroupByFile() map[string][]string

GroupByFile group migrated files by file name

func (Summary) GroupByStage

func (summary Summary) GroupByStage() map[string][]string

GroupByStage group migrated files by stage

func (Summary) IsEmpty

func (summary Summary) IsEmpty() bool

IsEmpty check if summary is empty

func (Summary) Names

func (summary Summary) Names() []string

Names get migrated files