migrate

Documentation

Index

• Variables
• func NewMigrator(t trace.Tracer) migrator.Migrator
• type Config
  • func (c *Config) Database(name string) *Database
• type Database
  • func (d *Database) GetURL() (string, error)
• type Migrator
  • func (m *Migrator) Migrate(ctx context.Context, source, db string, version uint64) ([]string, error)
  • func (m *Migrator) Ping(ctx context.Context, source, db string) error
• type URL

Variables

var (
	// ErrInvalidConfig for source or db.
	ErrInvalidConfig = errors.New("invalid config")

	// ErrInvalidMigration happened.
	ErrInvalidMigration = errors.New("invalid migration")

	// ErrInvalidPing happened.
	ErrInvalidPing = errors.New("invalid ping")
)

var Module = fx.Options(
	fx.Provide(NewMigrator),
)

Module for fx.

Functions

func NewMigrator

func NewMigrator(t trace.Tracer) migrator.Migrator

NewMigrator for databases.

Types

type Config

type Config struct {
	Databases []*Database `yaml:"databases,omitempty" json:"databases,omitempty" toml:"databases,omitempty"`
}

Config for migrate.

func (*Config) Database

func (c *Config) Database(name string) *Database

Database by name.

type Database

type Database struct {
	Name   string `yaml:"name,omitempty" json:"name,omitempty" toml:"name,omitempty"`
	Source string `yaml:"source,omitempty" json:"source,omitempty" toml:"source,omitempty"`
	URL    URL    `yaml:"url,omitempty" json:"url,omitempty" toml:"url,omitempty"`
}

Database for migrate.

func (*Database) GetURL

func (d *Database) GetURL() (string, error)

GetURL for database.

type Migrator

type Migrator struct{}

Migrator using migrate.

func (*Migrator) Migrate

func (m *Migrator) Migrate(ctx context.Context, source, db string, version uint64) ([]string, error)

Migrate a database to a version and returning the database logs.

func (*Migrator) Ping

func (m *Migrator) Ping(ctx context.Context, source, db string) error

Ping the migrator.

type URL

type URL string

URL for migrate.