go install github.com/gopackx/go-migration/cmd/migrator@latest

go build -o go-migration github.com/gopackx/go-migration/cmd/migrator

go-migration --help

# Wait up to two minutes for another process to finish migrating
go-migration migrate --lock-timeout=2m

# Single-process setups, or a pool limited to one connection
go-migration migrate --no-lock

go-migration migrate --config=./config/migration.json

go-migration init [--module=MODULE] [--force]

package main

import (
    "github.com/gopackx/go-migration/pkg/cli/app"

    _ "github.com/go-sql-driver/mysql"
    _ "github.com/lib/pq"
    _ "modernc.org/sqlite"

    _ "your-module/database/migrations"
    _ "your-module/database/seeders"
)

func main() {
    app.Run()
}

$ go-migration init

Creating project structure...

  Created directories:
    ✓ database/migrations/
    ✓ database/seeders/
    ✓ database/factories/
    ✓ cmd/migrator/

  Created files:
    ✓ cmd/migrator/main.go
    ✓ migration.json

Project initialized successfully!
Run 'go-migration make:migration create_users_table' to create your first migration.

# Initialize a new project (auto-detects module path from go.mod)
go-migration init

# Initialize with a custom module path
go-migration init --module=github.com/myuser/myproject

# Re-initialize and overwrite existing files
go-migration init --force

go-migration migrate [--dry-run] [--lock-timeout=DURATION] [--no-lock]

# Run all pending migrations
go-migration migrate

# Preview the SQL without applying it
go-migration migrate --dry-run

# Run with a specific config file
go-migration migrate --config=./config/production.json

go-migration migrate:rollback [--step=N] [--dry-run] [--lock-timeout=DURATION] [--no-lock]

# Roll back the last batch
go-migration migrate:rollback

# Roll back the last 3 migrations
go-migration migrate:rollback --step=3

go-migration migrate:reset [--force] [--dry-run] [--lock-timeout=DURATION] [--no-lock]

# Roll back all migrations (will prompt for confirmation)
go-migration migrate:reset

# Roll back all migrations without confirmation
go-migration migrate:reset --force

# Roll back all migrations with a specific config
go-migration migrate:reset --config=./config/staging.json

go-migration migrate:refresh [--dry-run] [--lock-timeout=DURATION] [--no-lock]

# Refresh all migrations
go-migration migrate:refresh

# Preview the SQL without applying it
go-migration migrate:refresh --dry-run

# Refresh with a specific config
go-migration migrate:refresh --config=./config/development.json

go-migration migrate:fresh [--force] [--dry-run] [--lock-timeout=DURATION] [--no-lock]

# Drop all tables and re-migrate (will prompt for confirmation)
go-migration migrate:fresh

# Drop all tables without confirmation
go-migration migrate:fresh --force

# Preview the SQL without applying it
go-migration migrate:fresh --dry-run

# Fresh migration with a specific config
go-migration migrate:fresh --config=./config/test.json

go-migration migrate:status [--check]

Migration                                Status    Batch   Applied At
20240101_000001_create_users_table       Applied   1       2024-01-01 09:30:00
20240115_000001_create_posts_table       Applied   1       2024-01-01 09:30:01
20240201_000001_add_phone_to_users       Applied   2       2024-02-01 14:12:45
20240301_000001_create_comments_table    Pending

# Show migration status
go-migration migrate:status

# Show status using a specific config
go-migration migrate:status --config=./config/production.json

# Fail (exit 1) if any migration is pending, e.g. in CI
go-migration migrate:status --check

# Wait until another process (e.g. a migration Job) has applied everything
until go-migration migrate:status --check; do sleep 5; done

go-migration migrate:install [--lock-timeout=DURATION] [--no-lock]

# Create the migrations table
go-migration migrate:install

# Create with a specific config
go-migration migrate:install --config=./config/migration.json

go-migration make:migration <name> [--create=TABLE] [--table=TABLE]

# Generate a blank migration
go-migration make:migration create_users_table

# Generate a migration to create a new "users" table
go-migration make:migration create_users_table --create=users

# Generate a migration to modify the "users" table
go-migration make:migration add_email_to_users --table=users

package migrations

import (
    "github.com/gopackx/go-migration/pkg/migrator"
    "github.com/gopackx/go-migration/pkg/schema"
)

// CreateUsersTable migration.
type CreateUsersTable struct{}

func init() {
    migrator.AutoRegister("2024_01_01_090000_4821_create_users_table", &CreateUsersTable{})
}

// Up runs the migration.
func (m *CreateUsersTable) Up(s *schema.Builder) error {
    return s.Create("users", func(bp *schema.Blueprint) {
        bp.ID()
        bp.Timestamps()
    })
}

// Down reverses the migration.
func (m *CreateUsersTable) Down(s *schema.Builder) error {
    return s.Drop("users")
}

package migrations

import (
    "github.com/gopackx/go-migration/pkg/migrator"
    "github.com/gopackx/go-migration/pkg/schema"
)

// AddEmailToUsers migration.
type AddEmailToUsers struct{}

func init() {
    migrator.AutoRegister("2024_02_01_141245_0937_add_email_to_users", &AddEmailToUsers{})
}

// Up runs the migration.
func (m *AddEmailToUsers) Up(s *schema.Builder) error {
    return s.Alter("users", func(bp *schema.Blueprint) {
        // TODO: define table alterations
    })
}

// Down reverses the migration.
func (m *AddEmailToUsers) Down(s *schema.Builder) error {
    return s.Alter("users", func(bp *schema.Blueprint) {
        // TODO: reverse table alterations
    })
}

go-migration make:seeder <name>

# Generate a seeder file
go-migration make:seeder user

# Generate a seeder for a specific model
go-migration make:seeder user_profile

package seeders

import (
    "database/sql"

    "github.com/gopackx/go-migration/pkg/seeder"
)

func init() {
    seeder.AutoRegister("User", &User{})
}

// User seeder.
type User struct{}

// Run executes the seeder.
func (s *User) Run(db *sql.DB) error {
    // TODO: implement seeder
    return nil
}

go-migration make:factory <name>

# Generate a factory file
go-migration make:factory users

# Generate a factory for a specific model
go-migration make:factory user_profile

package factories

import (
    "github.com/gopackx/go-migration/pkg/seeder/factory"
)

// Users model.
type Users struct {
    // TODO: define model fields
}

// NewUsersFactory creates a factory for Users.
func NewUsersFactory() *factory.Factory[Users] {
    return factory.NewFactory(func(f factory.Faker) Users {
        return Users{
            // TODO: set fields using faker
        }
    })
}

go-migration db:seed [--class=CLASS] [--tag=TAG] [--lock-timeout=DURATION] [--no-lock]

# Run all seeders
go-migration db:seed

# Run a specific seeder
go-migration db:seed --class=UserSeeder

# Run seeders tagged as "development"
go-migration db:seed --tag=development

# Run with a specific config
go-migration db:seed --config=./config/development.json

go-migration db:seed:rollback --class=CLASS [--lock-timeout=DURATION] [--no-lock]

# Roll back a specific seeder
go-migration db:seed:rollback --class=UserSeeder

# Roll back with a specific config
go-migration db:seed:rollback --class=UserSeeder --config=./config/development.json

go-migration db:seed:truncate --table=TABLE [--lock-timeout=DURATION] [--no-lock]

# Truncate the users table
go-migration db:seed:truncate --table=users

# Truncate with a specific config
go-migration db:seed:truncate --table=posts --config=./config/development.json