migration

package

v0.0.0-...-73c04d8 Latest Latest Go to latest Published: Aug 19, 2025 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Skyrin/go-lib

Links

Open Source Insights

Documentation ¶

Overview ¶

Package migration provides automatic database migration capabilities Basic Usage sample:

Errors should be handled, but ignored for example code migrator, _ := migration.NewMigrator(db *sql.Connection) _ = migrator.AddMigrationList(arc.GetMigrationList()) // See below _ = migrator.Upgrade()

Example package that defines migrations var migrations embed.FS

const (

MIGRATION_CODE = "arc"

)

// GetMigrationList returns this packages migration list

func GetMigrationList() (ml *migration.List) {
	return migration.NewList(MIGRATION_CODE, migration.MIGRATION_PATH, migrations)
}

Index ¶

Constants
type File
- func (f *File) GetVersionFromName() (v int, err error)
type List
- func NewList(code, path string, migrations embed.FS) (l *List)
- func (l List) GetLatestMigrationFiles(v int) (fList []*File, err error)
type Migrator
- func NewMigrator(ctx context.Context, db *sql.Connection) (m *Migrator, err error)
- func (m *Migrator) AddMigrationList(ctx context.Context, ml *List) (err error)
- func (m *Migrator) Upgrade(ctx context.Context) (err error)

Constants ¶

View Source

const (
	ECode010201 = e.Code0102 + "01"
	ECode010202 = e.Code0102 + "02"
	ECode010203 = e.Code0102 + "03"
	ECode010204 = e.Code0102 + "04"
	ECode010205 = e.Code0102 + "05"
	ECode010206 = e.Code0102 + "06"
)

View Source

const (
	MIGRATION_TABLE = "skyrin_migration"
	MIGRATION_PATH  = "db/migrations"
	MIGRATION_CODE  = "migration"

	ECode010101 = e.Code0101 + "01"
	ECode010102 = e.Code0101 + "02"
	ECode010103 = e.Code0101 + "03"
	ECode010104 = e.Code0101 + "04"
	ECode010105 = e.Code0101 + "05"
	ECode010106 = e.Code0101 + "06"
	ECode010107 = e.Code0101 + "07"
	ECode010108 = e.Code0101 + "08"
	ECode010109 = e.Code0101 + "09"
	ECode01010A = e.Code0101 + "0A"
	ECode01010B = e.Code0101 + "0B"
	ECode01010C = e.Code0101 + "0C"
	ECode01010D = e.Code0101 + "0D"
	ECode01010E = e.Code0101 + "0E"
	ECode01010F = e.Code0101 + "0F"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type File ¶

type File struct {
	Name    string
	Version int
	SQL     []byte
}

func (*File) GetVersionFromName ¶

func (f *File) GetVersionFromName() (v int, err error)

GetVersionFromName parse the name for the version. The name is expected to have the version first as a 0 padded number and then an underscore. The rest of the name can be anything.

type List ¶

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

func NewList ¶

func NewList(code, path string, migrations embed.FS) (l *List)

NewList initialize a new list

func (List) GetLatestMigrationFiles ¶

func (l List) GetLatestMigrationFiles(v int) (fList []*File, err error)

GetLatestMigrationFiles gets all migration files after the specified version from the migration list's embeded file system

type Migrator ¶

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

func NewMigrator ¶

func NewMigrator(ctx context.Context, db *sql.Connection) (m *Migrator, err error)

NewMigrator initializes a new migrator

func (*Migrator) AddMigrationList ¶

func (m *Migrator) AddMigrationList(ctx context.Context, ml *List) (err error)

AddMigrationList adds a migration list to the migrator

func (*Migrator) Upgrade ¶

func (m *Migrator) Upgrade(ctx context.Context) (err error)

Upgrade runs upgrades on all migration lists

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
model
sqlmodel

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL