Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

migrate

package module

Go to main page

Versions in this module

v0

v0.3.0

May 23, 2026

Changes in this version

+ const BuiltinMigrationIDBase

+ const NamingFormatPrefixNone

+ const NamingFormatPrefixYYYY_MM_DD_HHMM

+ const NamingFormatPrefixYYYY_MM_DD_NNN

+ func GetBuiltinMigrationID(format NamingFormat) string

+ func GetDefaultTableName() string

+ func ValidateMigrationID(id string, format NamingFormat) error

+ func ValidateTableName(name string) error

+ type MigrationRecord struct

+ Batch string

+ CompletedAt string

+ Description string

+ ID string

+ StartedAt string

+ type MigrationStatus struct

+ Applied bool

+ Description string

+ ID string

type MigratorInterface

+ GetHistory func(ctx context.Context) ([]MigrationRecord, error)

+ GetStatus func(ctx context.Context) ([]MigrationStatus, error)

+ type NamingFormat string

type Options

+ NamingFormatPrefix NamingFormat

v0.2.0

May 7, 2026

v0.1.0

May 7, 2026

Changes in this version

+ const BuiltinMigrationID

+ const ColumnBatch

+ const ColumnCompletedAt

+ const ColumnDescription

+ const ColumnID

+ const ColumnStartedAt

+ const DefaultTableName

+ const DirectionDown

+ const DirectionUp

+ func NewCreateSchemaMigrationsTable(tableName string) *createSchemaMigrationsTable

+ type MigrationInterface interface

+ Description func() string

+ Down func(tx *sql.Tx) error

+ ID func() string

+ Up func(tx *sql.Tx) error

+ func GetBuiltinMigrations(tableName string) []MigrationInterface

+ type MigratorInterface interface

+ AddMigration func(migration MigrationInterface) error

+ AddMigrations func(migrations []MigrationInterface) error

+ Down func() error

+ Status func() error

+ Up func() error

+ func New(db *sql.DB, opts *Options) MigratorInterface

+ type Options struct

+ Logger *slog.Logger

+ MigrationTableName string