https://github.com/karol7krawczyk/golang-migrate-tool
Language and framework independent database migrations and scripts for MySQL, Postgres and SQLite. Migration is for people who need to run a bash script before executing SQL code or are looking for migrations that execute processes in scripts
https://github.com/karol7krawczyk/golang-migrate-tool
bash docker docker-compose golang migration mysql postgres scripts sqlite
Last synced: 18 days ago
JSON representation
Language and framework independent database migrations and scripts for MySQL, Postgres and SQLite. Migration is for people who need to run a bash script before executing SQL code or are looking for migrations that execute processes in scripts
- Host: GitHub
- URL: https://github.com/karol7krawczyk/golang-migrate-tool
- Owner: karol7krawczyk
- License: mit
- Created: 2024-06-25T12:40:19.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2026-02-19T19:35:42.000Z (4 months ago)
- Last Synced: 2026-06-08T03:03:08.162Z (20 days ago)
- Topics: bash, docker, docker-compose, golang, migration, mysql, postgres, scripts, sqlite
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Golang Migrate Tool
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Command-Line Flags](#command-line-flags)
- [Testing](#testing)
- [License](#license)
## Overview
The `golang-migrate` project is designed to provide an efficient and easy-to-use solution for database migrations, regardless of programming language or framework. It supports multiple databases and includes features such as version control, rollbacks, and detailed logging. The project is intended for people who need to run a bash script before executing SQL code or are looking for migrations that execute processes in scripts
## Features
- Supports multiple databases (e.g., MySQL, PostgreSQL, SQLite) and bash script
- Efficiently using either SQL files and bash scripts.
- Version control for migrations
- Rollback functionality
- Detailed logging
- Easy configuration
## Installation
To get started, clone the repository and install the required dependencies.
### Clone the repository
```bash
git clone https://github.com/Karol7Krawczyk/golang-migrate-tool.git
cd golang-migrate-tool
```
### Run in docker
```bash
make build
make up
```
### The binary file is available after building the docker
```bash
./migration -up
```
## Usage
Here's how you can use the migration tool:
- List of all commands: go run main.go -help
- Running Migrations: go run main.go -up
- Rolling Back Migrations: go run main.go -down
- Create Migration files: go run main.go -create
## Configuration
Configuration can be done via environment variables or command-line flags. Here’s an example configuration for your project:
```bash
environment:
DB_NAME: your-database
DB_USER: your-username
DB_PASSWORD: your-password
DB_HOST: localhost
DB_PORT: 3306
DB_TYPE: mysql
DB_TABLE: migrations
MIGRATION_PATH: migrations/data
```
## Command-Line Flags
The migration tool accepts various command-line flags for configuration and commands. You can also use environment variables for configuration.
### Database Configuration
- `-db-user`: Database user (default: `DB_USER` environment variable)
- `-db-password`: Database password (default: `DB_PASSWORD` environment variable)
- `-db-host`: Database host address (default: `DB_HOST` environment variable)
- `-db-port`: Database port (default: `DB_PORT` environment variable)
- `-db-name`: Database name (default: `DB_NAME` environment variable)
- `-db-table`: Migration table (default: `DB_TABLE` environment variable)
- `-path`: Migration directory (default: `MIGRATION_PATH` environment variable)
- `-db-type`: Database type (mysql, sqlite, postgres) (default: `DB_TYPE` environment variable)
### Commands
- `-status`: Check the status of a specific migration
- `-desc`: Create a description of an empty migration
- `-script`: Create bash scripts for an empty migration
- `-create`: Create files for an empty migration
- `-history`: Display migration history
- `-new`: Display upcoming migrations
- `-up`: Apply new migrations
- `-down`: Revert migrations
- `-debug`: Debug migrations
- `-step`: Only one-step migration
- `-steps`: Number of steps for migration
### Example Usage
```bash
go run . -db-user=root -db-password=secret -db-host=localhost -db-port=3306 -db-name=migrations -up
go run . -create -script -desc="Create User table"
go run . -create
go run . -debug -down
go run . -debug -down -step
go run . -debug -up -steps=5
go run . -history
```
### Example Usage inside a docker container
```bash
docker exec migrate-golang sh -c "go run . -up"
docker exec migrate-golang sh -c "go run . -down"
```
## Testing
To run the tests, use the following command after build docker-compose:
```bash
make up
make test
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.