migration

package

v1.0.0 Latest Latest Go to latest Published: May 19, 2026 License: MIT Imports: 11 Imported by: 0

Details

Package migrations is deprecated. Use github.com/shauryagautam/Astra/pkg/database/migration instead.

This section is empty.

This section is empty.

func Generate(dir, name string) (string, error)

Generate creates a new migration file in the specified directory.

type Embedder struct {
	FS embed.FS
}

Embedder allows embedding migration SQL files directly into the Go binary.

func (e *Embedder) ReadDir(name string) ([]fs.DirEntry, error)

ReadDir returns the migration files.

func (e *Embedder) ReadFile(name string) ([]byte, error)

ReadFile reads a specific migration file.

type MigrationRecord struct {
	ID       int
	Name     string
	Batch    int
	RunAt    time.Time
	Checksum string
}

MigrationRecord represents a migration that has been applied to the database.

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

Runner handles running and rolling back migration.

func NewRunner(db *sql.DB, dir string, fileSystem fs.FS) *Runner

NewRunner creates a new migration runner.

func (r *Runner) Fresh(ctx context.Context) error

Fresh drops all user tables and re-runs all migration. CAUTION: destructive operation — for development use only.

func (r *Runner) Rollback(ctx context.Context) error

Rollback rolls back the last batch of migration.

func (r *Runner) RollbackN(ctx context.Context, n int) error

RollbackN rolls back the last N individual migration.

func (r *Runner) Run(ctx context.Context) error

Run executes all pending migrations in order.

func (r *Runner) Setup(ctx context.Context) error

Setup ensures the migrations table exists with all required columns.

func (r *Runner) Status(ctx context.Context) (applied []MigrationRecord, pending []string, err error)

Status returns all applied migration records and a list of pending file names.