migrate

package
v2.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 2, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package migrate adapts migration execution to contrib database tooling.

Use this package when wiring migration behavior around the contrib migrator and database adapters. Migration safety rules, duplicate version handling, and uncertain commit acknowledgement are documented in contrib/migrator.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New 

func New(opts Options) (ports.Migrator, error)

New builds an Adapter and pings the database using a bounded startup context. Callers that need direct context control should use NewWithContext.

func NewWithContext 

func NewWithContext(ctx context.Context, opts Options) (ports.Migrator, error)

NewWithContext builds an Adapter and pings the database with a context.

Types

type Adapter 

type Adapter struct {
	// contains filtered or unexported fields
}

Adapter implements runtime.Migrator using migrator.Runner.

func (*Adapter) Close 

func (a *Adapter) Close() error

Close releases the underlying database handle.

func (*Adapter) Down 

func (a *Adapter) Down(ctx context.Context, _ string) error

Down rolls back migrations.

func (*Adapter) Status 

func (a *Adapter) Status(ctx context.Context, _ string) (string, error)

Status returns the current migration status.

func (*Adapter) Up 

func (a *Adapter) Up(ctx context.Context, _ string) error

Up applies migrations.

type Options 

type Options struct {
	DSN                string
	Dirs               []string // optional; multiple directories
	Table              string
	LockKey            int64
	AllowDangerousDown bool
	EmbeddedFSs        []fs.FS // optional; multiple embedded FS
	Log                ports.Logger
}

Options configures migrator initialization.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.