zmigrate

Documentation

Index

• Variables
• type Config
• type Migrator
  • func New(source fs.ReadDirFS, db zsql.DB, config *Config) *Migrator
  • func (m *Migrator) GetSchema() (schema drivers.Schema, err error)
  • func (m *Migrator) ToVersion(version int) (err error)
• type Seed
• type SeedHandler
• type Seeder
  • func NewSeeder(db zsql.DB, config *SeederConfig) (s *Seeder, err error)
  • func (s *Seeder) AddSeed(name string, version int, handler SeedHandler) *Seeder
  • func (s *Seeder) SeedTo(name string, targetVersion int) (err error)
• type SeederConfig

Variables

var (
	ErrInvalidVersion   = errors.New("invalid version number")
	ErrMigrationChanged = errors.New("a migration has changed since it was originally run")
)

Types

type Config

type Config struct {
	Table           string
	SkipTransaction bool
}

type Migrator

type Migrator struct {
	Source fs.ReadDirFS

	Driver drivers.Driver
	// contains filtered or unexported fields
}

func New

func New(source fs.ReadDirFS, db zsql.DB, config *Config) *Migrator

func (*Migrator) GetSchema

func (m *Migrator) GetSchema() (schema drivers.Schema, err error)

Get a schema representation based on the underlying driver

func (*Migrator) ToVersion

func (m *Migrator) ToVersion(version int) (err error)

Migrate up or down to a specific state in the db. This allows you to work on your schema without ruining existing environments by locking it to a version.

type Seed

type Seed struct {
	Name    string
	Version int
	Handler SeedHandler
}

type SeedHandler

type SeedHandler func(ctx context.Context, tx zsql.Tx, seed Seed) error

type Seeder

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

func NewSeeder

func NewSeeder(db zsql.DB, config *SeederConfig) (s *Seeder, err error)

func (*Seeder) AddSeed

func (s *Seeder) AddSeed(name string, version int, handler SeedHandler) *Seeder

Add a seed handler for the specified name/version

func (*Seeder) SeedTo

func (s *Seeder) SeedTo(name string, targetVersion int) (err error)

Seed the given name to the specified version. Does nothing if the version is already satisfied. Can only seed forwards and not backwards

type SeederConfig

type SeederConfig struct {
	TableName string
}