migrations

package

v2.3.6+incompatible Latest Latest Go to latest Published: Sep 15, 2021 License: AGPL-3.0 Imports: 2 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/bsinou/cells

Links

Open Source Insights

Documentation ¶

Index ¶

func Apply(ctx context.Context, current *version.Version, target *version.Version, ...) (*version.Version, error)
func FirstRun() *version.Version
type Migration

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Apply ¶

func Apply(ctx context.Context, current *version.Version, target *version.Version, migrations []*Migration) (*version.Version, error)

ApplyMigrations browse migrations upward on downward and apply them sequentially. It returns a version to be saved as the current valid version of the service, or nil if no changes were necessary. In specific case where current version is 0.0.0 (first run), it only applies first run migration (if any) and returns target version.

func FirstRun ¶

func FirstRun() *version.Version

FirstRun returns version "zero".

Types ¶

type Migration ¶

type Migration struct {
	TargetVersion *version.Version
	Up            func(ctx context.Context) error
	Down          func(ctx context.Context) error
}

Migration defines a target version and functions to upgrade and/or downgrade.

Source Files ¶

View all Source files

migrations.go

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