golang

Documentation

Index

• func New(source *Source, updateVersion UpdateVersion, applied AppliedVersions, ...) (m.Driver, error)
• type AppliedVersions
• type Config
  • func NewConfig() *Config
  • func (c *Config) Get(key interface{}) interface{}
  • func (c *Config) Set(key, val interface{})
• type Driver
  • func (g *Driver) Close() error
  • func (g *Driver) Migrate(migration *m.PlannedMigration) error
  • func (g *Driver) Versions() ([]string, error)
• type Source
  • func NewSource() *Source
  • func (s *Source) AddMigration(file string, direction m.Direction, migration func(c *Config) error)
  • func (s *Source) GetMigrationFile(file string) (io.Reader, error)
  • func (s *Source) ListMigrationFiles() ([]string, error)
• type UpdateVersion

Functions

func New

func New(source *Source, updateVersion UpdateVersion, applied AppliedVersions, config *Config) (m.Driver, error)

NewGolang creates a new Go migration driver. It requires a source a function for saving the executed migration version, a function for deleting a version that was migrated downwards, a function for listing all applied migrations and optionally a configuration.

Types

type AppliedVersions

type AppliedVersions func(config *Config) ([]string, error)

type Config

type Config struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig() *Config

NewGolangConfig creates a concurrency-safe configuration map for passing configuration data and things like database handlers to your migrations.

func (*Config) Get

func (c *Config) Get(key interface{}) interface{}

Get retrieves a value from the configuration using the key.

func (*Config) Set

func (c *Config) Set(key, val interface{})

Set adds a new key-value pair to the configuration.

type Driver

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

func (*Driver) Close

func (g *Driver) Close() error

func (*Driver) Migrate

func (g *Driver) Migrate(migration *m.PlannedMigration) error

func (*Driver) Versions

func (g *Driver) Versions() ([]string, error)

Version returns all applied migration versions

type Source

type Source struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewSource

func NewSource() *Source

NewGolangSource creates a source for storing Go functions as migrations.

func (*Source) AddMigration

func (s *Source) AddMigration(file string, direction m.Direction, migration func(c *Config) error)

AddMigration adds a new migration to the source. The file parameter follows the same conventions as you would use for a physical file for other types of migrations, however you should omit the file extension. Example: 1_init.up and 1_init.down

func (*Source) GetMigrationFile

func (s *Source) GetMigrationFile(file string) (io.Reader, error)

GetMigrationFile retrieves a migration given the filename.

func (*Source) ListMigrationFiles

func (s *Source) ListMigrationFiles() ([]string, error)

ListMigrationFiles lists the available migrations in the source

type UpdateVersion

type UpdateVersion func(id string, direction m.Direction, config *Config) error