migrate

package

v1.62.4 Latest Latest Go to latest Published: Apr 14, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/alexfalkowski/migrieren

Documentation ¶

Index ¶

Variables
func NewMigrator(t trace.Tracer) migrator.Migrator
type Config
- func (c *Config) Database(name string) *Database
type Database
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

Constants ¶

This section is empty.

Variables ¶

View Source

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")
)

Functions ¶

func NewMigrator ¶ added in v1.3.0

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    string `yaml:"url,omitempty" json:"url,omitempty" toml:"url,omitempty"`
}

Database for migrate.

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 ¶ added in v1.4.0

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

Ping the migrator.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
migrator
telemetry
tracer

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