https://github.com/gookit/miglite
miglite is a simplified database schema migration tool. Golang 实现的极简的数据库 Schema 迁移工具，无三方DB驱动依赖。
https://github.com/gookit/miglite
migration migration-tool migrations
Last synced: 5 months ago
JSON representation
miglite is a simplified database schema migration tool. Golang 实现的极简的数据库 Schema 迁移工具，无三方DB驱动依赖。
- Host: GitHub
- URL: https://github.com/gookit/miglite
- Owner: gookit
- License: mit
- Created: 2025-11-07T03:44:45.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-01-28T05:16:46.000Z (5 months ago)
- Last Synced: 2026-01-28T18:23:26.910Z (5 months ago)
- Topics: migration, migration-tool, migrations
- Language: Go
- Homepage: https://pkg.go.dev/github.com/gookit/miglite
- Size: 501 KB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# miglite - Lite database schema migration tool by Go
[](https://github.com/gookit/miglite)
[](https://goreportcard.com/report/github.com/gookit/miglite)
[](https://github.com/gookit/miglite/actions)
[](https://pkg.go.dev/github.com/gookit/miglite)
> **👉 [中文说明](README.zh-CN.md)**
`miglite` is a minimalist database schema migration tool implemented in Golang.
- Easy to use with minimal dependencies
- Developed based on `database/sql` without adding any driver dependencies by default
- Migration SQL is executed within transactions to ensure data consistency
- Uses raw SQL files as migration files
- SQL filename format: `YYYYMMDD-HHMMSS-{migration-name}.sql`
- By default, all SQL files (including subdirectories) in the migration directory are recursively searched
- Directories starting with `_` (eg. `_backup/xx.sql`) are ignored when looking for SQL files
- Migration directories support the use of environment variables (eg `.migrations/${MODULE_NAME}`)})
- Migration directories support adding multiple paths using comma `,` splitting
- Can run migrations with zero configuration via environment variables (e.g., `DATABASE_URL`, `MIGRATIONS_PATH`)
- Automatically attempts to load `.env` file in the directory(Optional)
- Automatically loads default configuration file `./miglite.yaml`(Optional)
- Supports `mysql`, `sqlite`, `postgres` databases
- When used as a library, you need to add your own DB driver dependencies
- When using the `miglite` command-line tool directly, driver dependencies are already included
## Installation
Using the `miglite` command-line tool:
```bash
# install it by go
go install github.com/gookit/miglite/cmd/miglite@latest
```
Using as a Go dependency library:
```bash
go get github.com/gookit/miglite
# import "github.com/gookit/miglite"
```
## Direct CLI Usage
Using the `miglite` command-line tool directly.
### Configuration
`miglite` supports configuration via `miglite.yaml` file or environment variables.
- Can work without a configuration file, using the environment variable `DATABASE_URL` directly
- Configuration file defaults to `./miglite.yaml`, but can be specified via the `--config` parameter
#### miglite.yaml Example
```yaml
database:
driver: sqlite # or mysql, postgresql
dsn: ./miglite.db # or connection string for other databases
migrations:
path: ./migrations
```
#### Environment Variables
- `DATABASE_URL`: Database connection URL (e.g., `sqlite://path/to/your.db`, `mysql://user:pass@tcp(host:port)/dbname`)
- `MIGRATIONS_PATH`: Migration files path (default: `./migrations`)
**Examples**:
```ini
MIGRATIONS_PATH = "./migrations"
# sqlite
DATABASE_URL="sqlite://path/to/your.db"
# mysql
DATABASE_URL="mysql://user:passwd@tcp(127.0.0.1:3306)/local_test?charset=utf8mb4&parseTime=True&loc=Local"
# postgresql
DATABASE_URL="postgres://host=localhost port=5432 user=username password=password dbname=dbname sslmode=disable"
```
> **NOTE**: mysql URLs must be tagged with the 'tcp' protocol
### Creating Migrations
```bash
miglite create add-users-table
```
This will create an SQL file named with the current date in the `./migrations/` directory, with the format `YYYYMMDD-HHMMSS-add-users-table.sql`.
```text
./migrations/20251105-102325-create-users-table.sql
```
SQL file content includes a template:
```sql
-- Migrate:UP
-- Add migration SQL here
-- Migrate:DOWN
-- Add rollback SQL here (optional)
```
Example migration file:
```sql
-- Migrate:UP
CREATE TABLE post (
id int NOT NULL,
title text,
body text,
PRIMARY KEY(id)
);
-- Migrate:DOWN
DROP TABLE post;
```
### Running Migrations
```bash
# Initialize the migrations schema table
miglite init
# Apply all pending migrations
miglite up
# Execute immediately without confirmation
miglite up --yes
# Rollback the most recent migration
miglite down
# Rollback multiple migrations
miglite down --number 3
# View migration status
miglite status
```
View migration status:
## Using as a Library
`miglite` **does not depend on** any third-party DB driver libraries by itself, so you can use it as a library with your current database driver library.
- Sqlite drivers:
- `modernc.org/sqlite` **CGO-free driver**
- `github.com/glebarez/go-sqlite` Based on `modernc.org/sqlite`
- `github.com/ncruces/go-sqlite3` **CGO-free** Based on Wasm(wazero)
- `github.com/mattn/go-sqlite3` **NEED cgo**
- MySQL driver:
- `github.com/go-sql-driver/mysql`
- Postgres driver:
- `github.com/lib/pq`
- `github.com/jackc/pgx/v5`
- MSSQL driver:
- `github.com/microsoft/go-mssqldb`
> More drivers see: https://go.dev/wiki/SQLDrivers
```go
package main
import (
"github.com/gookit/miglite"
// add your database driver
_ "github.com/go-sql-driver/mysql"
// _ "github.com/lib/pq"
// _ "modernc.org/sqlite"
)
func main() {
mig, err := miglite.NewAuto(func(cfg *config.Config) {
// update config options
})
goutil.PanicIfErr(err) // handle error
// run up migrations
err = mig.Up(command.UpOption{
Yes: true, // dont confirm
// ... options
})
goutil.PanicIfErr(err) // handle error
// run down migrations ...
}
```
### Building Your Own Command Tool
You can directly use the `miglite` library to quickly build your own migration command tool, allowing you to register only the database drivers you need.
```go
package main
import (
"github.com/gookit/miglite"
"github.com/gookit/miglite/pkg/command"
// add your database driver
_ "github.com/go-sql-driver/mysql"
// _ "github.com/lib/pq"
// _ "modernc.org/sqlite"
)
var Version = "0.1.0"
func main() {
// Optional: Information needs to be specified at build time via ldflags
// command.SetBuildInfo(Version, GoVersion, BuildTime, GitCommit)
// Create the CLI application
app := command.NewApp("miglite", Version, "Lite database schema migration tool by Go")
// Run the application
app.Run()
}
```
> **NOTE**: If you want to further customize the CLI application, you can freely choose other CLI libraries, parse options, and then call the `handleXXX()` methods under `command` to execute the logic.
## Related Projects
- [golang-migrate](https://github.com/golang-migrate/migrate)
- [pressly/goose](https://github.com/pressly/goose)
- [amacneil/dbmate](https://github.com/amacneil/dbmate)