migration

package

v0.7.0 Latest Latest Go to latest Published: Feb 28, 2024 License: MIT Imports: 13 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/infiniteloopcloud/go

Links

Open Source Insights

README ¶

Migration

Commonly used migration tools

Usage

package main

import (
	"context"
	"embed"

	"github.com/infiniteloopcloud/migration"
)

//go:embed files
var Files embed.FS

func main() {
	ctx := context.Background()

	// Library usage
	migration.Get(ctx, "database connection string", Files)

	// Executable usage
	migration.MigrationTool("database connection string", false, Files)
}

Documentation ¶

Index ¶

func FromEmbeds(opts Opts, embeds ...embed.FS) (afero.Fs, error)
func Get(_ context.Context, conn string, opts Opts, embeds ...embed.FS) (*migrate.Migrate, error)
func MigrationTool(conn string, down bool, opts Opts, embeds ...embed.FS)
func PreHookMigration(params PreHookMigrationParams) func(ctx context.Context)
func PrepareCockroach(conn string) string
type Opts
type PreHookMigrationParams

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FromEmbeds ¶

func FromEmbeds(opts Opts, embeds ...embed.FS) (afero.Fs, error)

func Get ¶

func Get(_ context.Context, conn string, opts Opts, embeds ...embed.FS) (*migrate.Migrate, error)

Get will return the migration prepared for the certain files embedded into the binary

func MigrationTool ¶

func MigrationTool(conn string, down bool, opts Opts, embeds ...embed.FS)

func PreHookMigration ¶ added in v0.5.0

func PreHookMigration(params PreHookMigrationParams) func(ctx context.Context)

func PrepareCockroach ¶ added in v0.4.0

func PrepareCockroach(conn string) string

Types ¶

type Opts ¶

type Opts struct {
	Path string
}

type PreHookMigrationParams ¶ added in v0.5.0

type PreHookMigrationParams struct {
	SkipMigration    string
	ConnectionString string
	PostgresDialect  bool
	Files            []embed.FS
}

Source Files ¶

View all Source files

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