migration

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 MigrationToolWithError(conn string, down bool, opts Opts, embeds ...embed.FS) error
• func PreHookMigration(params PreHookMigrationParams) func(ctx context.Context)
• func PrepareCockroach(conn string) string
• type Opts
• type PreHookMigrationParams

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 MigrationToolWithError

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

func PreHookMigration

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

func PrepareCockroach

func PrepareCockroach(conn string) string

Types

type Opts

type Opts struct {
	Path string
}

type PreHookMigrationParams

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