migrate

package

v1.0.0 Latest Latest Go to latest Published: Apr 27, 2026 License: MIT Imports: 18 Imported by: 0

Details

This section is empty.

View Source

var (
	// ErrInvalidName reports an invalid migration name.
	ErrInvalidName = errors.New("invalid migration name")
)

func Create(ctx context.Context, opts CreateOptions) error

Create creates a timestamped Go migration file under db/migrations.

func Down(ctx context.Context, opts Options) error

Down rolls back the latest applied migration.

func Status(ctx context.Context, opts Options) error

Status prints all discovered migrations and their applied/pending state. If no database is configured, all migrations are shown as pending.

func Up(ctx context.Context, opts Options) error

Up applies all pending migrations in chronological order.

type CreateOptions struct {
	RootDir string
	Name    string
	Now     func() time.Time
}

CreateOptions configures migration file creation.

type Options struct {
	RootDir     string
	DatabaseURL string
	Output      io.Writer
}

Options configures migration status and execution commands.